ConversationConfig

^{ref / conversations / ConversationConfig}

Configuration options that can be passed when using createConversation to turn a conversation builder function into middleware.

^Source

Properties

id

id?: string;

Identifier of the conversation which can be used to enter it. Defaults to the name of the function.

^Source

maxMillisecondsToWait

maxMillisecondsToWait?: number;

Maximum number of milliseconds to wait. If an update is received after this time has elapsed, the conversation will be left automatically instead of resuming, and the update will be handled as if the conversation had not been active.

This is the default value that each conversation with this identifier starts with. Note that you can override this value for a specific run of the conversation when calling ctx.conversation.enter. In addition, you can adjust this value from within a conversation between wait calls by assigning a new value to conversation.millisecondsToWait.

^Source