StatefulChatClient interface

保留我們可以從 ChatClient {@Link 為 ChatClientState {@Link @azure/communication-chat#ChatClient} ChatClientState} 進行 Proxy 的所有狀態。

function getState(): ChatClientState

傳回

允許取消註冊 'stateChanged' 事件。

function offStateChange(handler: (state: ChatClientState) => void)

參數

允許為 'stateChanged' 事件註冊處理常式。

function onStateChange(handler: (state: ChatClientState) => void)

參數

建立聊天對話。 傳回具有所建立執行緒識別碼的執行緒用戶端。

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

參數

傳回

繼承自 ChatClient.createChatThread

刪除聊天對話。

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

參數

傳回

繼承自 ChatClient.deleteChatThread

傳回具有特定執行緒識別碼的 ChatThreadClient。

function getChatThreadClient(threadId: string): ChatThreadClient

參數

傳回

繼承自 ChatClient.getChatThreadClient

取得使用者的聊天對話清單。

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

參數

傳回

繼承自 ChatClient.listChatThreads

取消訂閱 chatMessageDeleted。

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

參數

繼承自 ChatClient.off

取消訂閱 chatMessageEdited。

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

參數

繼承自 ChatClient.off

取消訂閱 chatMessageReceived。

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

參數

繼承自 ChatClient.off

取消訂閱 chatThreadCreated。

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

參數

繼承自 ChatClient.off

取消訂閱 chatThreadDeleted。

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

參數

繼承自 ChatClient.off

取消訂閱 chatThreadPropertiesUpdated。

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

參數

繼承自 ChatClient.off

取消訂閱參與者新增。

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

參數

繼承自 ChatClient.off

取消訂閱參與者Removed。

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

參數

繼承自 ChatClient.off

取消訂閱 readReceiptReceived。

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

參數

繼承自 ChatClient.off

取消訂閱輸入IndicatorReceived。

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

參數

繼承自 ChatClient.off

chatMessageDeleted 的訂閱函式。 初始傳送者也會收到此事件。

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

參數

繼承自 ChatClient.on

chatMessageEdited 的訂閱函式。 初始傳送者也會收到此事件。

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

參數

繼承自 ChatClient.on

chatMessageReceived 的訂閱函式。 初始傳送者也會收到此事件。 您必須在訂閱任何事件之前呼叫 startRealtimeNotifications。

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

參數

繼承自 ChatClient.on

chatThreadCreated 的訂閱函式。

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

參數

繼承自 ChatClient.on

chatThreadDeleted 的訂閱函式。

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

參數

繼承自 ChatClient.on

chatThreadPropertiesUpdated 的 Subscribe 函式。

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

參數

繼承自 ChatClient.on

訂閱參與者的函式Added。

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

參數

繼承自 ChatClient.on

針對參與者訂閱函式Removed。

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

參數

繼承自 ChatClient.on

readReceiptReceived 的 Subscribe 函式。

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

參數

繼承自 ChatClient.on

realTimeNotificationConnected 的 Subscribe 函式。

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

參數

繼承自 ChatClient.on

realTimeNotificationDisconnected 的 Subscribe 函式。

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

參數

繼承自 ChatClient.on

Subscribe 函式，用於 typingIndicatorReceived。 初始傳送者也會收到此事件。

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

參數

繼承自 ChatClient.on

開始接收即時通知。 訂閱任何事件之前，請先呼叫此函式。

function startRealtimeNotifications(): Promise<void>

傳回

繼承自 ChatClient.startRealtimeNotifications

停止接收即時通知。 此函式會取消訂閱所有事件。

function stopRealtimeNotifications(): Promise<void>

傳回

繼承自 ChatClient.stopRealtimeNotifications