Skip to main content

ConversationCommands

ug-js-sdk


ug-js-sdk / ConversationCommands

Class: ConversationCommands

Defined in: conversation-manager/ConversationCommands.ts:5

Contains conversation command strings that can be customized externally. These commands are sent to the conversation system to control conversation flow.

Constructors

Constructor

new ConversationCommands(): ConversationCommands

Returns

ConversationCommands

Properties

DEFAULT_START_COMMAND

readonly static DEFAULT_START_COMMAND: "[start conversation]" = '[start conversation]'

Defined in: conversation-manager/ConversationCommands.ts:7


DEFAULT_PAUSE_RESUME_COMMAND

readonly static DEFAULT_PAUSE_RESUME_COMMAND: "[resume after short pause]" = '[resume after short pause]'

Defined in: conversation-manager/ConversationCommands.ts:8


DEFAULT_LONG_PAUSE_RESUME_COMMAND

readonly static DEFAULT_LONG_PAUSE_RESUME_COMMAND: "[resume after long break]" = '[resume after long break]'

Defined in: conversation-manager/ConversationCommands.ts:9


DEFAULT_ERROR_RESUME_COMMAND

readonly static DEFAULT_ERROR_RESUME_COMMAND: "[resume after error]" = '[resume after error]'

Defined in: conversation-manager/ConversationCommands.ts:10


startCommand

startCommand: string = ConversationCommands.DEFAULT_START_COMMAND

Defined in: conversation-manager/ConversationCommands.ts:12


pauseResumeCommand

pauseResumeCommand: string = ConversationCommands.DEFAULT_PAUSE_RESUME_COMMAND

Defined in: conversation-manager/ConversationCommands.ts:13


longPauseResumeCommand

longPauseResumeCommand: string = ConversationCommands.DEFAULT_LONG_PAUSE_RESUME_COMMAND

Defined in: conversation-manager/ConversationCommands.ts:14


errorResumeCommand

errorResumeCommand: string = ConversationCommands.DEFAULT_ERROR_RESUME_COMMAND

Defined in: conversation-manager/ConversationCommands.ts:15

Methods

set()

set(startCommand?, pauseResumeCommand?, longPauseResumeCommand?, errorResumeCommand?): void

Defined in: conversation-manager/ConversationCommands.ts:24

Sets all command values at once

Parameters

startCommand?

string

Command to start conversation

pauseResumeCommand?

string

Command to resume conversation after a short pause

longPauseResumeCommand?

string

Command to resume after a long break

errorResumeCommand?

string

Command to resume after error

Returns

void


setDefault()

setDefault(): void

Defined in: conversation-manager/ConversationCommands.ts:40

Resets all command values to their defaults

Returns

void