Class ChatController

Class representing a Chat Controller.

Index

Constructors

Methods

addMessage addOnActionChanged addOnMessagesChanged cancelActionRequest clearMessages getActionRequest getActionResponses getMessages getOption removeMessage removeOnActionChanged removeOnMessagesChanged setActionRequest setActionResponse setMessages updateMessage

Constructors

constructor

new ChatController(option?: ChatOption): ChatController
Constructs an instance of ChatController.
Parameters
- Optionaloption: ChatOption
  The chat options.
Returns ChatController
- Defined in types.d.ts:27488

Methods

addMessage

addMessage(message: Message<any>): Promise<number>
Adds a message to the chat.
Parameters
- message: Message<any>
  The message to add.
Returns Promise<number>
A Promise resolving to the index of the added message.
- Defined in types.d.ts:27494

addOnActionChanged

addOnActionChanged(callback: OnActionChanged): void
Adds an event handler for action changed.
Parameters
- callback: OnActionChanged
  The event handler to add.
Returns void
- Defined in types.d.ts:27568

addOnMessagesChanged

addOnMessagesChanged(callback: OnMessagesChanged): void
Adds an event handler for messages changed.
Parameters
- callback: OnMessagesChanged
  The event handler to add.
Returns void
- Defined in types.d.ts:27524

cancelActionRequest

cancelActionRequest(): void
Cancels the current action request.

Returns void
- Defined in types.d.ts:27543

clearMessages

clearMessages(): void
Clears all messages from the chat.

Returns void
- Defined in types.d.ts:27519

getActionRequest

getActionRequest(): undefined | ActionRequest
Gets the current action request.

Returns undefined | ActionRequest
The current action request.
- Defined in types.d.ts:27548

getActionResponses

getActionResponses(): ActionResponse[]
Gets all action responses.

Returns ActionResponse[]
An array of action responses.
- Defined in types.d.ts:27563

getMessages

getMessages(): Message<any>[]
Gets all messages in the chat.

Returns Message<any>[]
An array of messages.
- Defined in types.d.ts:27510

getOption

getOption(): ChatOption
Gets the chat options.

Returns ChatOption
The chat options.
- Defined in types.d.ts:27578

removeMessage

removeMessage(index: number): void
Removes a message from the chat.
Parameters
- index: number
  The index of the message to remove.
Returns void
- Defined in types.d.ts:27505

removeOnActionChanged

removeOnActionChanged(callback: OnActionChanged): void
Removes an event handler for action changed.
Parameters
- callback: OnActionChanged
  The event handler to remove.
Returns void
- Defined in types.d.ts:27573

removeOnMessagesChanged

removeOnMessagesChanged(callback: OnMessagesChanged): void
Removes an event handler for messages changed.
Parameters
- callback: OnMessagesChanged
  The event handler to remove.
Returns void
- Defined in types.d.ts:27529

setActionRequest

setActionRequest<T extends ActionRequest>(
request: T,
onResponse?: OnActionResponsed,
): Promise<ActionResponse>
Sets the action request and its response handlers.
Type Parameters
- T extends ActionRequest
Parameters
- request: T
  The action request.
- OptionalonResponse: OnActionResponsed
  The response handler.
Returns Promise<ActionResponse>
A Promise resolving to the action response.
- Defined in types.d.ts:27536

setActionResponse

setActionResponse(
request: ActionRequest,
response: ActionResponse,
): Promise<void>
Sets the action response and triggers related actions.
Parameters
- request: ActionRequest
  The action request.
- response: ActionResponse
  The action response.
Returns Promise<void>
A Promise resolving when the action response is processed.
- Defined in types.d.ts:27555

setMessages

setMessages(messages: Message<any>[]): void
Sets the messages in the chat.
Parameters
- messages: Message<any>[]
  The messages to set.
Returns void
- Defined in types.d.ts:27515

updateMessage

updateMessage(index: number, message: Message<any>): void
Updates a message in the chat.
Parameters
- index: number
  The index of the message to update.
- message: Message<any>
  The updated message.
Returns void
- Defined in types.d.ts:27500