ChatThreadClient class

Пакет:

@azure/communication-chat

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

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

ChatThreadClient(string, string, CommunicationTokenCredential, ChatThreadClientOptions)

Свойства

threadId

Идентификатор потока объекта ChatThreadClient

Методы

addParticipants(AddParticipantsRequest, OperationOptions)	Добавляет сведения об участниках чата, принадлежащих потоку, определяемому threadId.
deleteMessage(string, OperationOptions)	Удаляет сообщение, определенное по threadId и messageId.
getMessage(string, OperationOptions)	Возвращает сообщение чата, идентифицируемое по идентификатору messageId. Возвращает определенное сообщение.
getProperties(OperationOptions)	Получает поток чата. Возвращает поток чата.
listMessages(RestListMessagesOptions)	Возвращает список сообщений из потока, определяемого threadId. Возвращает список сообщений.
listParticipants(RestListParticipantsOptions)	Возвращает участников потока, определенных с помощью threadId. Возвращает списки участников.
listReadReceipts(RestListReadReceiptsOptions)	Возвращает список уведомлений о прочтении из потока, определяемого threadId. Возвращает список сообщений.
removeParticipant(CommunicationIdentifier, OperationOptions)	Удаляет участника из потока, определяемого threadId.
sendMessage(SendMessageRequest, SendMessageOptions)	Отправляет сообщение чата в поток, определенный с помощью threadId. Возвращает идентификатор созданного сообщения.
sendReadReceipt(SendReadReceiptRequest, OperationOptions)	Отправляет уведомление о прочтении в поток, определенный с помощью threadId.
sendTypingNotification(SendTypingNotificationOptions)	Отправляет уведомление о вводе в поток. Не пытается отправить сообщение, если время с момента последнего уведомления меньше минимального интервала ввода
updateMessage(string, UpdateMessageOptions)	Обновления сообщения, определяемого по threadId и messageId
updateTopic(string, UpdateTopicOptions)	Обновления темы потока.

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

ChatThreadClient(string, string, CommunicationTokenCredential, ChatThreadClientOptions)

new ChatThreadClient(endpoint: string, threadId: string, credential: CommunicationTokenCredential, options?: ChatThreadClientOptions)

Параметры

endpoint

string

threadId

string

credential

CommunicationTokenCredential

options

ChatThreadClientOptions

Сведения о свойстве

threadId

Идентификатор потока объекта ChatThreadClient

threadId: string

Значение свойства

string

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

addParticipants(AddParticipantsRequest, OperationOptions)

Добавляет сведения об участниках чата, принадлежащих потоку, определяемому threadId.

function addParticipants(request: AddParticipantsRequest, options?: OperationOptions): Promise<AddChatParticipantsResult>

Параметры

request

AddParticipantsRequest

Сведения об участниках потока для добавления в список потоков

options

OperationOptions

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

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

Promise<AddChatParticipantsResult>

deleteMessage(string, OperationOptions)

Удаляет сообщение, определенное по threadId и messageId.

function deleteMessage(messageId: string, options?: OperationOptions): Promise<void>

Параметры

messageId

string

Идентификатор сообщения.

options

OperationOptions

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

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

Promise<void>

getMessage(string, OperationOptions)

Возвращает сообщение чата, идентифицируемое по идентификатору messageId. Возвращает определенное сообщение.

function getMessage(messageId: string, options?: OperationOptions): Promise<ChatMessage>

Параметры

messageId

string

Идентификатор сообщения.

options

OperationOptions

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

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

Promise<ChatMessage>

getProperties(OperationOptions)

Получает поток чата. Возвращает поток чата.

function getProperties(options?: OperationOptions): Promise<ChatThreadProperties>

Параметры

options

OperationOptions

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

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

Promise<ChatThreadProperties>

listMessages(RestListMessagesOptions)

Возвращает список сообщений из потока, определяемого threadId. Возвращает список сообщений.

function listMessages(options?: RestListMessagesOptions): PagedAsyncIterableIterator<ChatMessage, ChatMessage[], PageSettings>

Параметры

options

RestListMessagesOptions

Параметры получения сообщений.

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

PagedAsyncIterableIterator<ChatMessage, ChatMessage[], PageSettings>

listParticipants(RestListParticipantsOptions)

Возвращает участников потока, определенных с помощью threadId. Возвращает списки участников.

function listParticipants(options?: RestListParticipantsOptions): PagedAsyncIterableIterator<ChatParticipant, ChatParticipant[], PageSettings>

Параметры

options

RestListParticipantsOptions

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

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

PagedAsyncIterableIterator<ChatParticipant, ChatParticipant[], PageSettings>

listReadReceipts(RestListReadReceiptsOptions)

Возвращает список уведомлений о прочтении из потока, определяемого threadId. Возвращает список сообщений.

function listReadReceipts(options?: RestListReadReceiptsOptions): PagedAsyncIterableIterator<ChatMessageReadReceipt, ChatMessageReadReceipt[], PageSettings>

Параметры

options

RestListReadReceiptsOptions

Параметры получения сообщений.

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

PagedAsyncIterableIterator<ChatMessageReadReceipt, ChatMessageReadReceipt[], PageSettings>

removeParticipant(CommunicationIdentifier, OperationOptions)

Удаляет участника из потока, определяемого threadId.

function removeParticipant(participant: CommunicationIdentifier, options?: OperationOptions): Promise<void>

Параметры

participant

CommunicationIdentifier

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

options

OperationOptions

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

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

Promise<void>

sendMessage(SendMessageRequest, SendMessageOptions)

Отправляет сообщение чата в поток, определенный с помощью threadId. Возвращает идентификатор созданного сообщения.

function sendMessage(request: SendMessageRequest, options?: SendMessageOptions): Promise<SendChatMessageResult>

Параметры

request

SendMessageRequest

Запрос на отправку сообщения.

options

SendMessageOptions

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

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

Promise<SendChatMessageResult>

sendReadReceipt(SendReadReceiptRequest, OperationOptions)

Отправляет уведомление о прочтении в поток, определенный с помощью threadId.

function sendReadReceipt(request: SendReadReceiptRequest, options?: OperationOptions): Promise<void>

Параметры

request

SendReadReceiptRequest

Запрос на отправку уведомления о прочтении

options

OperationOptions

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

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

Promise<void>

sendTypingNotification(SendTypingNotificationOptions)

Отправляет уведомление о вводе в поток. Не пытается отправить сообщение, если время с момента последнего уведомления меньше минимального интервала ввода

function sendTypingNotification(options?: SendTypingNotificationOptions): Promise<boolean>

Параметры

options

SendTypingNotificationOptions

Варианты операций

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

Promise<boolean>

Значение true, если может быть отправлено уведомление о вводе сообщения; в противном случае — false.

updateMessage(string, UpdateMessageOptions)

Обновления сообщения, определяемого по threadId и messageId

function updateMessage(messageId: string, options?: UpdateMessageOptions): Promise<void>

Параметры

messageId

string

Идентификатор сообщения.

options

UpdateMessageOptions

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

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

Promise<void>

updateTopic(string, UpdateTopicOptions)

Обновления темы потока.

function updateTopic(topic: string, options?: UpdateTopicOptions): Promise<void>

Параметры

topic

string

Раздел необходимо обновить до .

options

UpdateTopicOptions

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

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

Promise<void>