ChatThreadClient class

Пакет:

@azure/communication-chat

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

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

ChatThreadClient(string, string, CommunicationTokenCredential, ChatThreadClientOptions)

Свойства

threadId

Идентификатор потока чатаThreadClient

Методы

addParticipants(AddParticipantsRequest, OperationOptions)	Добавляет сведения участников чата, принадлежащих потоку, определяемому threadId.
deleteMessage(string, OperationOptions)	Удаляет сообщение, определяемое threadId и messageId
getMessage(string, OperationOptions)	Возвращает сообщение чата, определяемое идентификатором messageId. Возвращает определенное сообщение.
getProperties(OperationOptions)	Возвращает поток чата. Возвращает поток чата.
listMessages(ChatThreadListChatMessagesOptionalParams)	Возвращает список сообщений из потока, определяемого threadId. Возвращает список сообщений.
listParticipants(ChatThreadListChatParticipantsOptionalParams)	Возвращает участников потока, определяемого threadId. Возвращает списки участников.
listReadReceipts(ChatThreadListChatReadReceiptsOptionalParams)	Возвращает список квитанций о чтении из потока, определяемого threadId. Возвращает список сообщений.
removeParticipant(CommunicationIdentifier, OperationOptions)	Удаляет участника из потока, определяемого threadId.
sendMessage(SendMessageRequest, SendMessageOptions)	Отправляет сообщение чата потоку, определяемому threadId. Возвращает идентификатор созданного сообщения.
sendReadReceipt(SendReadReceiptRequest, OperationOptions)	Отправляет квитанцию о чтении в поток, определяемый threadId.
sendTypingNotification(SendTypingNotificationOptions)	Отправляет уведомление о вводе в поток. Не пытается отправить, если время с момента последнего уведомления меньше минимального интервала ввода
updateMessage(string, UpdateMessageOptions)	Обновляет сообщение, определяемое threadId и messageId
updateProperties(UpdateChatThreadPropertiesOptions)	Обновляет свойства потока.
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

Идентификатор потока чатаThreadClient

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(ChatThreadListChatMessagesOptionalParams)

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

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

Параметры

options

RestListMessagesOptions

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

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

PagedAsyncIterableIterator<ChatMessage, ChatMessage[], PageSettings>

listParticipants(ChatThreadListChatParticipantsOptionalParams)

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

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

Параметры

options

RestListParticipantsOptions

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

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

PagedAsyncIterableIterator<ChatParticipant, ChatParticipant[], PageSettings>

listReadReceipts(ChatThreadListChatReadReceiptsOptionalParams)

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

function listReadReceipts(options?: ChatThreadListChatReadReceiptsOptionalParams): 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>

updateProperties(UpdateChatThreadPropertiesOptions)

Обновляет свойства потока.

function updateProperties(options?: UpdateChatThreadPropertiesOptions): Promise<void>

Параметры

options

UpdateChatThreadPropertiesOptions

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

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

Promise<void>

updateTopic(string, UpdateTopicOptions)

Обновляет раздел потока.

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

Параметры

topic

string

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

options

UpdateTopicOptions

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

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

Promise<void>