@itd-api/chat-bot / ChatContext
Class: ChatContext<Client>
Defined in: packages/chat-bot/src/context.ts:28
Контекст события. Для пакета сообщений создаётся отдельный контекст на каждое сообщение.
Type Parameters
Client
Client extends ChatBotClient = ChatBotClient
Constructors
Constructor
new ChatContext<Client>(
itd,
update,
message?,
signal?
): ChatContext<Client>;Defined in: packages/chat-bot/src/context.ts:49
Создаёт контекст для события и выбранного сообщения.
Parameters
itd
Client
update
ChatUpdate
message?
ChatMessage
signal?
AbortSignal
Returns
ChatContext<Client>
Properties
args
args: string | undefined;Defined in: packages/chat-bot/src/context.ts:44
Текст после имени команды.
command
command: string | undefined;Defined in: packages/chat-bot/src/context.ts:42
Имя команды без /.
itd
readonly itd: Client;Defined in: packages/chat-bot/src/context.ts:30
Клиент, которому принадлежит бот.
match
match: string | RegExpMatchArray | undefined;Defined in: packages/chat-bot/src/context.ts:46
Аргументы команды или результат сопоставления hears().
message
readonly message: ChatMessage | undefined;Defined in: packages/chat-bot/src/context.ts:34
Сообщение, выбранное из обновления.
signal
readonly signal: AbortSignal | undefined;Defined in: packages/chat-bot/src/context.ts:36
Сигнал для прямых вызовов SDK, связанных с обработкой сообщения.
update
readonly update: ChatUpdate;Defined in: packages/chat-bot/src/context.ts:32
Обновление, полученное от SDK.
Accessors
chatId
Get Signature
get chatId(): string | undefined;Defined in: packages/chat-bot/src/context.ts:67
Идентификатор чата события.
Returns
string | undefined
chats
Get Signature
get chats(): Client["chats"];Defined in: packages/chat-bot/src/context.ts:62
Ресурс чатов переданного клиенту бота.
Returns
Client["chats"]
senderId
Get Signature
get senderId(): string | undefined;Defined in: packages/chat-bot/src/context.ts:72
Идентификатор автора сообщения. Подходит для itd.users.get().
Returns
string | undefined
stream
Get Signature
get stream(): ChatEvents;Defined in: packages/chat-bot/src/context.ts:57
Канал событий клиента.
Returns
ChatEvents
text
Get Signature
get text(): string | null | undefined;Defined in: packages/chat-bot/src/context.ts:77
Текст сообщения.
Returns
string | null | undefined
Methods
edit()
edit(input, options?): Promise<ChatEditedMessage>;Defined in: packages/chat-bot/src/context.ts:122
Редактирует текущее сообщение.
Parameters
input
ChatMessageContent
options?
RequestOptions
Returns
Promise<ChatEditedMessage>
markRead()
markRead(options?): Promise<ChatReadResult>;Defined in: packages/chat-bot/src/context.ts:132
Отмечает чат прочитанным до текущего сообщения включительно.
Parameters
options?
RequestOptions
Returns
Promise<ChatReadResult>
reply()
reply(
text,
input?,
options?
): Promise<ChatSentMessage>;Defined in: packages/chat-bot/src/context.ts:87
Отправляет текст в текущий чат.
Parameters
text
string
input?
options?
RequestOptions
Returns
Promise<ChatSentMessage>
replyTo()
replyTo(
text,
input?,
options?
): Promise<ChatSentMessage>;Defined in: packages/chat-bot/src/context.ts:96
Цитирует текущее сообщение в ответе.
Parameters
text
string
input?
options?
RequestOptions
Returns
Promise<ChatSentMessage>
send()
send(input, options?): Promise<ChatSentMessage>;Defined in: packages/chat-bot/src/context.ts:82
Отправляет сообщение в текущий чат.
Parameters
input
SendChatMessageInput
options?
RequestOptions
Returns
Promise<ChatSentMessage>
sendWithAttachments()
sendWithAttachments(
input,
files,
options?
): Promise<ChatSentMessage>;Defined in: packages/chat-bot/src/context.ts:105
Загружает файлы и отправляет сообщение в текущий чат после завершения всех загрузок.
Parameters
input
SendChatMessageInput
files
readonly FileInput[]
options?
RequestOptions
Returns
Promise<ChatSentMessage>