StatefulChatClient interface

包:

@azure/communication-react

定义允许 {@Link @azure/communication-chat#ChatClient} 与集中式生成状态一起使用的方法。

该接口提供对代理状态的访问，并允许注册状态更改事件的处理程序。

扩展

ChatClient

方法

dispose()	从聊天线程客户端清理资源缓存。
downloadResourceToCache(string, string, string)	下载特定消息的资源并对其进行缓存。
getState()	保留可从 ChatClient {@Link @azure/communication-chat#ChatClient} 代理为 ChatClientState {@Link ChatClientState} 的所有状态。
offStateChange((state: ChatClientState) => void)	允许取消注册“stateChanged”事件。
onStateChange((state: ChatClientState) => void)	允许为“stateChanged”事件注册处理程序。
removeResourceFromCache(string, string, string)	从特定消息的缓存中删除资源。

继承的方法

createChatThread(CreateChatThreadRequest, CreateChatThreadOptions)	创建聊天线程。 返回具有已创建线程 ID 的线程客户端。
deleteChatThread(string, OperationOptions)	删除聊天线程。
getChatThreadClient(string)	返回具有特定线程 ID 的 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)	取消订阅 chatThreadCreated。
off("chatThreadDeleted", (e: ChatThreadDeletedEvent) => void)	取消订阅 chatThreadDeleted。
off("chatThreadPropertiesUpdated", (e: ChatThreadPropertiesUpdatedEvent) => void)	取消订阅 chatThreadPropertiesUpdated。
off("participantsAdded", (e: ParticipantsAddedEvent) => void)	取消订阅参与者Added。
off("participantsRemoved", (e: ParticipantsRemovedEvent) => void)	取消订阅参与者Removed。
off("readReceiptReceived", (e: ReadReceiptReceivedEvent) => void)	取消订阅 readReceiptReceived。
off("typingIndicatorReceived", (e: TypingIndicatorReceivedEvent) => void)	取消订阅 typeIndicatorReceived。
on("chatMessageDeleted", (e: ChatMessageDeletedEvent) => void)	订阅 chatMessageDeleted 的函数。 初始发送方也将接收此事件。
on("chatMessageEdited", (e: ChatMessageEditedEvent) => void)	chatMessageEdited 的订阅函数。 初始发送方也将接收此事件。
on("chatMessageReceived", (e: ChatMessageReceivedEvent) => void)	chatMessageReceived 的 Subscribe 函数。 初始发送方也将接收此事件。 在订阅任何事件之前，需要调用 startRealtimeNotifications。
on("chatThreadCreated", (e: ChatThreadCreatedEvent) => void)	订阅 chatThreadCreated 的函数。
on("chatThreadDeleted", (e: ChatThreadDeletedEvent) => void)	订阅 chatThreadDeleted 的函数。
on("chatThreadPropertiesUpdated", (e: ChatThreadPropertiesUpdatedEvent) => void)	订阅 chatThreadPropertiesUpdated 的函数。
on("participantsAdded", (e: ParticipantsAddedEvent) => void)	为 participantsAdded 订阅函数。
on("participantsRemoved", (e: ParticipantsRemovedEvent) => void)	为 participantsRemoved 订阅函数。
on("readReceiptReceived", (e: ReadReceiptReceivedEvent) => void)	Subscribe 函数用于 readReceiptReceived。
on("realTimeNotificationConnected", () => void)	realTimeNotificationConnected 的 Subscribe 函数。
on("realTimeNotificationDisconnected", () => void)	realTimeNotificationDisconnected 的 Subscribe 函数。
on("typingIndicatorReceived", (e: TypingIndicatorReceivedEvent) => void)	subscribe 函数，用于 typeIndicatorReceived。 初始发送方也将接收此事件。
startRealtimeNotifications()	开始接收实时通知。 在订阅任何事件之前调用此函数。
stopRealtimeNotifications()	停止接收实时通知。 此函数将取消订阅所有事件。

方法详细信息

dispose()

从聊天线程客户端清理资源缓存。

function dispose()

downloadResourceToCache(string, string, string)

下载特定消息的资源并对其进行缓存。

function downloadResourceToCache(threadId: string, messageId: string, resourceUrl: string)

参数

threadId

string

聊天会话的线程 ID。

messageId

string

聊天消息的消息 ID。

resourceUrl

string

要获取和缓存的资源 URL。

getState()

保留可从 ChatClient {@Link @azure/communication-chat#ChatClient} 代理为 ChatClientState {@Link ChatClientState} 的所有状态。

function getState(): ChatClientState

返回

ChatClientState

offStateChange((state: ChatClientState) => void)

允许取消注册“stateChanged”事件。

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

参数

handler

(state: ChatClientState) => void

要取消订阅的原始回调。

onStateChange((state: ChatClientState) => void)

允许为“stateChanged”事件注册处理程序。

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

参数

handler

(state: ChatClientState) => void

用于接收状态的回调。

removeResourceFromCache(string, string, string)

从特定消息的缓存中删除资源。

function removeResourceFromCache(threadId: string, messageId: string, resourceUrl: string)

参数

threadId

string

聊天会话的线程 ID。

messageId

string

聊天消息的消息 ID。

resourceUrl

string

要从缓存中删除的资源 URL。

继承的方法详细信息

createChatThread(CreateChatThreadRequest, CreateChatThreadOptions)

创建聊天线程。 返回具有已创建线程 ID 的线程客户端。

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

参数

request

CreateChatThreadRequest

创建聊天线程的请求。

options

CreateChatThreadOptions

作选项。

返回

Promise<CreateChatThreadResult>

继承自 ChatClient.createChatThread

deleteChatThread(string, OperationOptions)

删除聊天线程。

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

参数

threadId

string

要删除的线程的 ID。

options

OperationOptions

作选项。

返回

Promise<void>

继承自 ChatClient.deleteChatThread

getChatThreadClient(string)

返回具有特定线程 ID 的 ChatThreadClient。

function getChatThreadClient(threadId: string): ChatThreadClient

参数

threadId

string

ChatThreadClient 的线程 ID

返回

ChatThreadClient

继承自 ChatClient.getChatThreadClient

listChatThreads(ChatListChatThreadsOptionalParams)

获取用户的聊天线程列表。

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

参数

options

@azure/communication-chat.ChatListChatThreadsOptionalParams

列出聊天线程选项。

返回

PagedAsyncIterableIterator<ChatThreadItem, ChatThreadItem[], PageSettings>

继承自 ChatClient.listChatThreads

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

取消订阅 chatMessageDeleted。

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

参数

event

"chatMessageDeleted"

ChatMessageDeletedEvent。

listener

(e: ChatMessageDeletedEvent) => void

要处理事件的侦听器。

继承自 ChatClient.off

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

取消订阅 chatMessageEdited。

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

参数

event

"chatMessageEdited"

ChatMessageEditedEvent。

listener

(e: ChatMessageEditedEvent) => void

要处理事件的侦听器。

继承自 ChatClient.off

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

取消订阅 chatMessageReceived。

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

参数

event

"chatMessageReceived"

ChatMessageReceivedEvent。

listener

(e: ChatMessageReceivedEvent) => void

要处理事件的侦听器。

继承自 ChatClient.off

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

取消订阅 chatThreadCreated。

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

参数

event

"chatThreadCreated"

ChatThreadCreatedEvent。

listener

(e: ChatThreadCreatedEvent) => void

要处理事件的侦听器。

继承自 ChatClient.off

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

取消订阅 chatThreadDeleted。

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

参数

event

"chatThreadDeleted"

ChatThreadDeletedEvent。

listener

(e: ChatThreadDeletedEvent) => void

要处理事件的侦听器。

继承自 ChatClient.off

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

取消订阅 chatThreadPropertiesUpdated。

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

参数

event

"chatThreadPropertiesUpdated"

ChatThreadPropertiesUpdatedEvent。

listener

(e: ChatThreadPropertiesUpdatedEvent) => void

要处理事件的侦听器。

继承自 ChatClient.off

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

取消订阅参与者Added。

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

参数

event

"participantsAdded"

ParticipantsAddedEvent。

listener

(e: ParticipantsAddedEvent) => void

要处理事件的侦听器。

继承自 ChatClient.off

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

取消订阅参与者Removed。

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

参数

event

"participantsRemoved"

ParticipantsRemovedEvent。

listener

(e: ParticipantsRemovedEvent) => void

要处理事件的侦听器。

继承自 ChatClient.off

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

取消订阅 readReceiptReceived。

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

参数

event

"readReceiptReceived"

ReadReceiptReceivedEvent。

listener

(e: ReadReceiptReceivedEvent) => void

要处理事件的侦听器。

继承自 ChatClient.off

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

取消订阅 typeIndicatorReceived。

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

参数

event

"typingIndicatorReceived"

TypeIndicatorReceivedEvent。

listener

(e: TypingIndicatorReceivedEvent) => void

要处理事件的侦听器。

继承自 ChatClient.off

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

订阅 chatMessageDeleted 的函数。 初始发送方也将接收此事件。

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

参数

event

"chatMessageDeleted"

ChatMessageDeletedEvent。

listener

(e: ChatMessageDeletedEvent) => void

要处理事件的侦听器。

继承自 ChatClient.on

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

chatMessageEdited 的订阅函数。 初始发送方也将接收此事件。

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

参数

event

"chatMessageEdited"

ChatMessageEditedEvent。

listener

(e: ChatMessageEditedEvent) => void

要处理事件的侦听器。

继承自 ChatClient.on

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

chatMessageReceived 的 Subscribe 函数。 初始发送方也将接收此事件。 在订阅任何事件之前，需要调用 startRealtimeNotifications。

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

参数

event

"chatMessageReceived"

ChatMessageReceivedEvent。

listener

(e: ChatMessageReceivedEvent) => void

要处理事件的侦听器。

继承自 ChatClient.on

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

订阅 chatThreadCreated 的函数。

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

参数

event

"chatThreadCreated"

ChatThreadCreatedEvent。

listener

(e: ChatThreadCreatedEvent) => void

要处理事件的侦听器。

继承自 ChatClient.on

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

订阅 chatThreadDeleted 的函数。

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

参数

event

"chatThreadDeleted"

ChatThreadDeletedEvent。

listener

(e: ChatThreadDeletedEvent) => void

要处理事件的侦听器。

继承自 ChatClient.on

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

订阅 chatThreadPropertiesUpdated 的函数。

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

参数

event

"chatThreadPropertiesUpdated"

ChatThreadPropertiesUpdatedEvent。

listener

(e: ChatThreadPropertiesUpdatedEvent) => void

要处理事件的侦听器。

继承自 ChatClient.on

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

为 participantsAdded 订阅函数。

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

参数

event

"participantsAdded"

ParticipantsAddedEvent。

listener

(e: ParticipantsAddedEvent) => void

要处理事件的侦听器。

继承自 ChatClient.on

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

为 participantsRemoved 订阅函数。

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

参数

event

"participantsRemoved"

ParticipantsRemovedEvent。

listener

(e: ParticipantsRemovedEvent) => void

要处理事件的侦听器。

继承自 ChatClient.on

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

Subscribe 函数用于 readReceiptReceived。

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

参数

event

"readReceiptReceived"

ReadReceiptReceivedEvent。

listener

(e: ReadReceiptReceivedEvent) => void

要处理事件的侦听器。

继承自 ChatClient.on

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

realTimeNotificationConnected 的 Subscribe 函数。

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

参数

event

"realTimeNotificationConnected"

realTimeNotificationConnected 事件

listener

() => void

要处理事件的侦听器。

继承自 ChatClient.on

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

realTimeNotificationDisconnected 的 Subscribe 函数。

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

参数

event

"realTimeNotificationDisconnected"

realTimeNotificationDisconnected 事件

listener

() => void

要处理事件的侦听器。

继承自 ChatClient.on

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

subscribe 函数，用于 typeIndicatorReceived。 初始发送方也将接收此事件。

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

参数

event

"typingIndicatorReceived"

TypeIndicatorReceivedEvent。

listener

(e: TypingIndicatorReceivedEvent) => void

要处理事件的侦听器。

继承自 ChatClient.on

startRealtimeNotifications()

开始接收实时通知。 在订阅任何事件之前调用此函数。

function startRealtimeNotifications(): Promise<void>

返回

Promise<void>

继承自 ChatClient.startRealtimeNotifications

stopRealtimeNotifications()

停止接收实时通知。 此函数将取消订阅所有事件。

function stopRealtimeNotifications(): Promise<void>

返回

Promise<void>

继承自 ChatClient.stopRealtimeNotifications