ChatThreadClient class

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

參數

ChatThreadClient 的執行緒識別碼

threadId: string

屬性值

新增屬於 threadId 所識別之執行緒的聊天參與者詳細資料。

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

參數

傳回

刪除 threadId 和 messageId 所識別的訊息

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

參數

傳回

取得 messageId 所識別的聊天訊息。 傳回特定訊息。

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

參數

傳回

取得聊天對話。 傳回聊天對話。

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

參數

傳回

從 threadId 所識別的執行緒取得訊息清單。 傳回訊息的清單。

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

參數

傳回

取得 threadId 所識別執行緒的參與者。 傳回參與者的清單。

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

參數

傳回

從 threadId 所識別的執行緒取得讀取收據清單。 傳回訊息的清單。

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

參數

傳回

從 threadId 所識別的執行緒中移除參與者。

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

參數

傳回

將聊天訊息傳送至 threadId 所識別的執行緒。 傳回所建立訊息的識別碼。

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

參數

傳回

將讀取收據傳送至 threadId 所識別的執行緒。

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

參數

傳回

將輸入通知傳送至執行緒。 如果上次通知以來的時間小於最小輸入間隔，則不會嘗試傳送

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

參數

傳回

如果可以傳送輸入訊息通知，則為 True，否則為 false。

更新 threadId 和 messageId 所識別的訊息

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

參數

傳回

更新執行緒的主題。

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

參數

傳回