ChatClient class

Пакет:

@azure/communication-chat

Клиент для выполнения операций чата

Конструкторы

ChatClient(string, CommunicationTokenCredential, ChatClientOptions)

Создает экземпляр ChatClient для заданного ресурса и пользователя.

Методы

createChatThread(CreateChatThreadRequest, CreateChatThreadOptions)	Создает поток чата. Возвращает клиент потока с идентификатором созданного потока.
deleteChatThread(string, OperationOptions)	Удаляет поток чата.
getChatThreadClient(string)	Возвращает ChatThreadClient с определенным идентификатором потока.
listChatThreads(ChatListChatThreadsOptionalParams)	Возвращает список потоков чата пользователя.
off("chatMessageDeleted", (e: ChatMessageDeletedEvent) => void)	Отмена подписки из chatMessageDeleted.
off("chatMessageEdited", (e: ChatMessageEditedEvent) => void)	Отмена подписки из chatMessageEdited.
off("chatMessageReceived", (e: ChatMessageReceivedEvent) => void)	Отмена подписки из chatMessageReceived.
off("chatThreadCreated", (e: ChatThreadCreatedEvent) => void)	Отмена подписки из чатаThreadCreated.
off("chatThreadDeleted", (e: ChatThreadDeletedEvent) => void)	Отмена подписки на chatThreadDeleted.
off("chatThreadPropertiesUpdated", (e: ChatThreadPropertiesUpdatedEvent) => void)	Отмена подписки на chatThreadPropertiesUpdated.
off("participantsAdded", (e: ParticipantsAddedEvent) => void)	Отмена подписки от участниковAdded.
off("participantsRemoved", (e: ParticipantsRemovedEvent) => void)	Отмена подписки от участников Удалена.
off("readReceiptReceived", (e: ReadReceiptReceivedEvent) => void)	Отмена подписки на readReceiptReceived.
off("typingIndicatorReceived", (e: TypingIndicatorReceivedEvent) => void)	Отмена подписки на typeingIndicatorReceived.
on("chatMessageDeleted", (e: ChatMessageDeletedEvent) => void)	Функция подписки для chatMessageDeleted. Исходный отправитель также получит это событие.
on("chatMessageEdited", (e: ChatMessageEditedEvent) => void)	Функция подписки для chatMessageEdited. Исходный отправитель также получит это событие.
on("chatMessageReceived", (e: ChatMessageReceivedEvent) => void)	Функция подписки для chatMessageReceived. Исходный отправитель также получит это событие. Перед подпиской на любое событие необходимо вызвать startRealtimeNotifications.
on("chatThreadCreated", (e: ChatThreadCreatedEvent) => void)	Функция подписки для chatThreadCreated.
on("chatThreadDeleted", (e: ChatThreadDeletedEvent) => void)	Функция подписки для chatThreadDeleted.
on("chatThreadPropertiesUpdated", (e: ChatThreadPropertiesUpdatedEvent) => void)	Функция подписки для chatThreadPropertiesUpdated.
on("participantsAdded", (e: ParticipantsAddedEvent) => void)	Функция подписки для участниковAdded.
on("participantsRemoved", (e: ParticipantsRemovedEvent) => void)	Функция подписки для участников Удалена.
on("readReceiptReceived", (e: ReadReceiptReceivedEvent) => void)	Функция подписки для readReceiptReceived.
on("realTimeNotificationConnected", () => void)	Функция подписки для realTimeNotificationConnected.
on("realTimeNotificationDisconnected", () => void)	Функция подписки для realTimeNotificationDisconnected.
on("typingIndicatorReceived", (e: TypingIndicatorReceivedEvent) => void)	Функция подписки для ввода TypeingIndicatorReceived. Исходный отправитель также получит это событие.
startRealtimeNotifications()	Начните получать уведомления в режиме реального времени. Вызовите эту функцию перед подпиской на любое событие.
stopRealtimeNotifications()	Остановите получение уведомлений в режиме реального времени. Эта функция отменит подписку на все события.

Сведения о конструкторе

ChatClient(string, CommunicationTokenCredential, ChatClientOptions)

Создает экземпляр ChatClient для заданного ресурса и пользователя.

new ChatClient(endpoint: string, credential: CommunicationTokenCredential, options?: ChatClientOptions)

Параметры

endpoint

string

URL-адрес ресурса служб коммуникации.

credential

CommunicationTokenCredential

Учетные данные маркера. Используйте AzureCommunicationTokenCredential из @azure/communication-common для создания учетных данных.

options

ChatClientOptions

Дополнительные параметры клиента.

Сведения о методе

createChatThread(CreateChatThreadRequest, CreateChatThreadOptions)

Создает поток чата. Возвращает клиент потока с идентификатором созданного потока.

function createChatThread(request: CreateChatThreadRequest, options?: CreateChatThreadOptions): Promise<CreateChatThreadResult>

Параметры

request

CreateChatThreadRequest

Запрос на создание потока чата.

options

CreateChatThreadOptions

Параметры операции.

Возвращаемое значение

Promise<CreateChatThreadResult>

deleteChatThread(string, OperationOptions)

Удаляет поток чата.

function deleteChatThread(threadId: string, options?: OperationOptions): Promise<void>

Параметры

threadId

string

Идентификатор удаляемого потока.

options

OperationOptions

Параметры операции.

Возвращаемое значение

Promise<void>

getChatThreadClient(string)

Возвращает ChatThreadClient с определенным идентификатором потока.

function getChatThreadClient(threadId: string): ChatThreadClient

Параметры

threadId

string

Идентификатор потока для ChatThreadClient

Возвращаемое значение

ChatThreadClient

listChatThreads(ChatListChatThreadsOptionalParams)

Возвращает список потоков чата пользователя.

function listChatThreads(options?: ChatListChatThreadsOptionalParams): PagedAsyncIterableIterator<ChatThreadItem, ChatThreadItem[], PageSettings>

Параметры

options

RestListChatThreadsOptions

Список параметров потоков чата.

Возвращаемое значение

PagedAsyncIterableIterator<ChatThreadItem, ChatThreadItem[], PageSettings>

off("chatMessageDeleted", (e: ChatMessageDeletedEvent) => void)

Отмена подписки из chatMessageDeleted.

function off(event: "chatMessageDeleted", listener: (e: ChatMessageDeletedEvent) => void)

Параметры

event

"chatMessageDeleted"

Событие ChatMessageDeletedEvent.

listener

(e: ChatMessageDeletedEvent) => void

Прослушиватель для обработки события.

off("chatMessageEdited", (e: ChatMessageEditedEvent) => void)

Отмена подписки из chatMessageEdited.

function off(event: "chatMessageEdited", listener: (e: ChatMessageEditedEvent) => void)

Параметры

event

"chatMessageEdited"

Событие ChatMessageEditedEvent.

listener

(e: ChatMessageEditedEvent) => void

Прослушиватель для обработки события.

off("chatMessageReceived", (e: ChatMessageReceivedEvent) => void)

Отмена подписки из chatMessageReceived.

function off(event: "chatMessageReceived", listener: (e: ChatMessageReceivedEvent) => void)

Параметры

event

"chatMessageReceived"

Событие ChatMessageReceivedEvent.

listener

(e: ChatMessageReceivedEvent) => void

Прослушиватель для обработки события.

off("chatThreadCreated", (e: ChatThreadCreatedEvent) => void)

Отмена подписки из чатаThreadCreated.

function off(event: "chatThreadCreated", listener: (e: ChatThreadCreatedEvent) => void)

Параметры

event

"chatThreadCreated"

Событие ChatThreadCreatedEvent.

listener

(e: ChatThreadCreatedEvent) => void

Прослушиватель для обработки события.

off("chatThreadDeleted", (e: ChatThreadDeletedEvent) => void)

Отмена подписки на chatThreadDeleted.

function off(event: "chatThreadDeleted", listener: (e: ChatThreadDeletedEvent) => void)

Параметры

event

"chatThreadDeleted"

Событие ChatThreadDeletedEvent.

listener

(e: ChatThreadDeletedEvent) => void

Прослушиватель для обработки события.

off("chatThreadPropertiesUpdated", (e: ChatThreadPropertiesUpdatedEvent) => void)

Отмена подписки на chatThreadPropertiesUpdated.

function off(event: "chatThreadPropertiesUpdated", listener: (e: ChatThreadPropertiesUpdatedEvent) => void)

Параметры

event

"chatThreadPropertiesUpdated"

Событие ChatThreadPropertiesUpdated.

listener

(e: ChatThreadPropertiesUpdatedEvent) => void

Прослушиватель для обработки события.

off("participantsAdded", (e: ParticipantsAddedEvent) => void)

Отмена подписки от участниковAdded.

function off(event: "participantsAdded", listener: (e: ParticipantsAddedEvent) => void)

Параметры

event

"participantsAdded"

УчастникиAddedEvent.

listener

(e: ParticipantsAddedEvent) => void

Прослушиватель для обработки события.

off("participantsRemoved", (e: ParticipantsRemovedEvent) => void)

Отмена подписки от участников Удалена.

function off(event: "participantsRemoved", listener: (e: ParticipantsRemovedEvent) => void)

Параметры

event

"participantsRemoved"

УчастникRemovedEvent.

listener

(e: ParticipantsRemovedEvent) => void

Прослушиватель для обработки события.

off("readReceiptReceived", (e: ReadReceiptReceivedEvent) => void)

Отмена подписки на readReceiptReceived.

function off(event: "readReceiptReceived", listener: (e: ReadReceiptReceivedEvent) => void)

Параметры

event

"readReceiptReceived"

Событие ReadReceiptReceivedEvent.

listener

(e: ReadReceiptReceivedEvent) => void

Прослушиватель для обработки события.

off("typingIndicatorReceived", (e: TypingIndicatorReceivedEvent) => void)

Отмена подписки на typeingIndicatorReceived.

function off(event: "typingIndicatorReceived", listener: (e: TypingIndicatorReceivedEvent) => void)

Параметры

event

"typingIndicatorReceived"

TypeingIndicatorReceivedEvent.

listener

(e: TypingIndicatorReceivedEvent) => void

Прослушиватель для обработки события.

on("chatMessageDeleted", (e: ChatMessageDeletedEvent) => void)

Функция подписки для chatMessageDeleted. Исходный отправитель также получит это событие.

function on(event: "chatMessageDeleted", listener: (e: ChatMessageDeletedEvent) => void)

Параметры

event

"chatMessageDeleted"

Событие ChatMessageDeletedEvent.

listener

(e: ChatMessageDeletedEvent) => void

Прослушиватель для обработки события.

on("chatMessageEdited", (e: ChatMessageEditedEvent) => void)

Функция подписки для chatMessageEdited. Исходный отправитель также получит это событие.

function on(event: "chatMessageEdited", listener: (e: ChatMessageEditedEvent) => void)

Параметры

event

"chatMessageEdited"

Событие ChatMessageEditedEvent.

listener

(e: ChatMessageEditedEvent) => void

Прослушиватель для обработки события.

on("chatMessageReceived", (e: ChatMessageReceivedEvent) => void)

Функция подписки для chatMessageReceived. Исходный отправитель также получит это событие. Перед подпиской на любое событие необходимо вызвать startRealtimeNotifications.

function on(event: "chatMessageReceived", listener: (e: ChatMessageReceivedEvent) => void)

Параметры

event

"chatMessageReceived"

Событие ChatMessageReceivedEvent.

listener

(e: ChatMessageReceivedEvent) => void

Прослушиватель для обработки события.

on("chatThreadCreated", (e: ChatThreadCreatedEvent) => void)

Функция подписки для chatThreadCreated.

function on(event: "chatThreadCreated", listener: (e: ChatThreadCreatedEvent) => void)

Параметры

event

"chatThreadCreated"

Событие ChatThreadCreatedEvent.

listener

(e: ChatThreadCreatedEvent) => void

Прослушиватель для обработки события.

on("chatThreadDeleted", (e: ChatThreadDeletedEvent) => void)

Функция подписки для chatThreadDeleted.

function on(event: "chatThreadDeleted", listener: (e: ChatThreadDeletedEvent) => void)

Параметры

event

"chatThreadDeleted"

Событие ChatThreadDeletedEvent.

listener

(e: ChatThreadDeletedEvent) => void

Прослушиватель для обработки события.

on("chatThreadPropertiesUpdated", (e: ChatThreadPropertiesUpdatedEvent) => void)

Функция подписки для chatThreadPropertiesUpdated.

function on(event: "chatThreadPropertiesUpdated", listener: (e: ChatThreadPropertiesUpdatedEvent) => void)

Параметры

event

"chatThreadPropertiesUpdated"

Событие ChatThreadPropertiesUpdated.

listener

(e: ChatThreadPropertiesUpdatedEvent) => void

Прослушиватель для обработки события.

on("participantsAdded", (e: ParticipantsAddedEvent) => void)

Функция подписки для участниковAdded.

function on(event: "participantsAdded", listener: (e: ParticipantsAddedEvent) => void)

Параметры

event

"participantsAdded"

УчастникиAddedEvent.

listener

(e: ParticipantsAddedEvent) => void

Прослушиватель для обработки события.

on("participantsRemoved", (e: ParticipantsRemovedEvent) => void)

Функция подписки для участников Удалена.

function on(event: "participantsRemoved", listener: (e: ParticipantsRemovedEvent) => void)

Параметры

event

"participantsRemoved"

УчастникRemovedEvent.

listener

(e: ParticipantsRemovedEvent) => void

Прослушиватель для обработки события.

on("readReceiptReceived", (e: ReadReceiptReceivedEvent) => void)

Функция подписки для readReceiptReceived.

function on(event: "readReceiptReceived", listener: (e: ReadReceiptReceivedEvent) => void)

Параметры

event

"readReceiptReceived"

Событие ReadReceiptReceivedEvent.

listener

(e: ReadReceiptReceivedEvent) => void

Прослушиватель для обработки события.

on("realTimeNotificationConnected", () => void)

Функция подписки для realTimeNotificationConnected.

function on(event: "realTimeNotificationConnected", listener: () => void)

Параметры

event

"realTimeNotificationConnected"

Событие realTimeNotificationConnected

listener

() => void

Прослушиватель для обработки события.

on("realTimeNotificationDisconnected", () => void)

Функция подписки для realTimeNotificationDisconnected.

function on(event: "realTimeNotificationDisconnected", listener: () => void)

Параметры

event

"realTimeNotificationDisconnected"

Событие realTimeNotificationDisconnected

listener

() => void

Прослушиватель для обработки события.

on("typingIndicatorReceived", (e: TypingIndicatorReceivedEvent) => void)

Функция подписки для ввода TypeingIndicatorReceived. Исходный отправитель также получит это событие.

function on(event: "typingIndicatorReceived", listener: (e: TypingIndicatorReceivedEvent) => void)

Параметры

event

"typingIndicatorReceived"

TypeingIndicatorReceivedEvent.

listener

(e: TypingIndicatorReceivedEvent) => void

Прослушиватель для обработки события.

startRealtimeNotifications()

Начните получать уведомления в режиме реального времени. Вызовите эту функцию перед подпиской на любое событие.

function startRealtimeNotifications(): Promise<void>

Возвращаемое значение

Promise<void>

stopRealtimeNotifications()

Остановите получение уведомлений в режиме реального времени. Эта функция отменит подписку на все события.

function stopRealtimeNotifications(): Promise<void>

Возвращаемое значение

Promise<void>