Skip to main content

ChatApi

@gravity-rail/sdk


@gravity-rail/sdk / ChatApi

Class: ChatApi

Chat commands and observation bound to one workspace base.

Constructors​

Constructor​

new ChatApi(scope, request): ChatApi

Parameters​

scope​

ChatScope

request​

ChatTransport

Returns​

ChatApi

Methods​

create()​

create(body): Promise<ChatCommandReceipt>

Parameters​

body​

CreateChatCommand

Returns​

Promise<ChatCommandReceipt>


respond()​

respond(chat, body): Promise<ChatCommandReceipt>

Parameters​

chat​

string | number

body​

RespondChatInputRequest

Returns​

Promise<ChatCommandReceipt>


send()​

send(chat, body): Promise<ChatCommandReceipt>

Parameters​

chat​

string | number

body​

SendChatInputRequest

Returns​

Promise<ChatCommandReceipt>


snapshot()​

snapshot(chat, options?): Promise<ChatSnapshot>

Parameters​

chat​

string | number

options?​
before?​

number

cursor?​

string

signal?​

AbortSignal

Returns​

Promise<ChatSnapshot>


stop()​

stop(chat, body): Promise<ChatCommandReceipt>

Parameters​

chat​

string | number

body​

StopChatRunRequest

Returns​

Promise<ChatCommandReceipt>