你当前正在访问 Microsoft Azure Global Edition 技术文档网站。 如果需要访问由世纪互联运营的 Microsoft Azure 中国技术文档网站，请访问 https://docs.azure.cn。
ChatClient class
要执行聊天作的客户端
构造函数
| Chat |
为给定资源和用户创建 ChatClient 实例。 |
方法
构造函数详细信息
ChatClient(string, CommunicationTokenCredential, ChatClientOptions)
为给定资源和用户创建 ChatClient 实例。
new ChatClient(endpoint: string, credential: CommunicationTokenCredential, options?: ChatClientOptions)参数
- endpoint
-
string
通信服务资源的 URL。
- credential
- CommunicationTokenCredential
令牌凭据。 使用 @azure/communication-common 中的 AzureCommunicationTokenCredential 创建凭据。
- options
- ChatClientOptions
其他客户端选项。
方法详细信息
createChatThread(CreateChatThreadRequest, CreateChatThreadOptions)
创建聊天线程。 返回具有已创建线程 ID 的线程客户端。
function createChatThread(request: CreateChatThreadRequest, options?: CreateChatThreadOptions): Promise<CreateChatThreadResult>参数
- request
- CreateChatThreadRequest
创建聊天线程的请求。
- options
- CreateChatThreadOptions
作选项。
返回
Promise<CreateChatThreadResult>
deleteChatThread(string, OperationOptions)
删除聊天线程。
function deleteChatThread(threadId: string, options?: OperationOptions): Promise<void>参数
- threadId
-
string
要删除的线程的 ID。
- options
- OperationOptions
作选项。
返回
Promise<void>
getChatThreadClient(string)
返回具有特定线程 ID 的 ChatThreadClient。
function getChatThreadClient(threadId: string): ChatThreadClient参数
- threadId
-
string
ChatThreadClient 的线程 ID
返回
listChatThreads(RestListChatThreadsOptions)
获取用户的聊天线程列表。
function listChatThreads(options?: RestListChatThreadsOptions): PagedAsyncIterableIterator<ChatThreadItem, ChatThreadItem[], PageSettings>参数
- options
- RestListChatThreadsOptions
列出聊天线程选项。
返回
off("chatMessageDeleted", (e: ChatMessageDeletedEvent) => void)
取消订阅 chatMessageDeleted。
function off(event: "chatMessageDeleted", listener: (e: ChatMessageDeletedEvent) => void)参数
- event
-
"chatMessageDeleted"
ChatMessageDeletedEvent。
- listener
-
(e: ChatMessageDeletedEvent) => void
要处理事件的侦听器。
off("chatMessageEdited", (e: ChatMessageEditedEvent) => void)
取消订阅 chatMessageEdited。
function off(event: "chatMessageEdited", listener: (e: ChatMessageEditedEvent) => void)参数
- event
-
"chatMessageEdited"
ChatMessageEditedEvent。
- listener
-
(e: ChatMessageEditedEvent) => void
要处理事件的侦听器。
off("chatMessageReceived", (e: ChatMessageReceivedEvent) => void)
取消订阅 chatMessageReceived。
function off(event: "chatMessageReceived", listener: (e: ChatMessageReceivedEvent) => void)参数
- event
-
"chatMessageReceived"
ChatMessageReceivedEvent。
- listener
-
(e: ChatMessageReceivedEvent) => void
要处理事件的侦听器。
off("chatThreadCreated", (e: ChatThreadCreatedEvent) => void)
取消订阅 chatThreadCreated。
function off(event: "chatThreadCreated", listener: (e: ChatThreadCreatedEvent) => void)参数
- event
-
"chatThreadCreated"
ChatThreadCreatedEvent。
- listener
-
(e: ChatThreadCreatedEvent) => void
要处理事件的侦听器。
off("chatThreadDeleted", (e: ChatThreadDeletedEvent) => void)
取消订阅 chatThreadDeleted。
function off(event: "chatThreadDeleted", listener: (e: ChatThreadDeletedEvent) => void)参数
- event
-
"chatThreadDeleted"
ChatThreadDeletedEvent。
- listener
-
(e: ChatThreadDeletedEvent) => void
要处理事件的侦听器。
off("chatThreadPropertiesUpdated", (e: ChatThreadPropertiesUpdatedEvent) => void)
取消订阅 chatThreadPropertiesUpdated。
function off(event: "chatThreadPropertiesUpdated", listener: (e: ChatThreadPropertiesUpdatedEvent) => void)参数
- event
-
"chatThreadPropertiesUpdated"
ChatThreadPropertiesUpdatedEvent。
- listener
-
(e: ChatThreadPropertiesUpdatedEvent) => void
要处理事件的侦听器。
off("participantsAdded", (e: ParticipantsAddedEvent) => void)
取消订阅参与者Added。
function off(event: "participantsAdded", listener: (e: ParticipantsAddedEvent) => void)参数
- event
-
"participantsAdded"
ParticipantsAddedEvent。
- listener
-
(e: ParticipantsAddedEvent) => void
要处理事件的侦听器。
off("participantsRemoved", (e: ParticipantsRemovedEvent) => void)
取消订阅参与者Removed。
function off(event: "participantsRemoved", listener: (e: ParticipantsRemovedEvent) => void)参数
- event
-
"participantsRemoved"
ParticipantsRemovedEvent。
- listener
-
(e: ParticipantsRemovedEvent) => void
要处理事件的侦听器。
off("readReceiptReceived", (e: ReadReceiptReceivedEvent) => void)
取消订阅 readReceiptReceived。
function off(event: "readReceiptReceived", listener: (e: ReadReceiptReceivedEvent) => void)参数
- event
-
"readReceiptReceived"
ReadReceiptReceivedEvent。
- listener
-
(e: ReadReceiptReceivedEvent) => void
要处理事件的侦听器。
off("typingIndicatorReceived", (e: TypingIndicatorReceivedEvent) => void)
取消订阅 typeIndicatorReceived。
function off(event: "typingIndicatorReceived", listener: (e: TypingIndicatorReceivedEvent) => void)参数
- event
-
"typingIndicatorReceived"
TypeIndicatorReceivedEvent。
- listener
-
(e: TypingIndicatorReceivedEvent) => void
要处理事件的侦听器。
on("chatMessageDeleted", (e: ChatMessageDeletedEvent) => void)
订阅 chatMessageDeleted 的函数。 初始发送方也将接收此事件。
function on(event: "chatMessageDeleted", listener: (e: ChatMessageDeletedEvent) => void)参数
- event
-
"chatMessageDeleted"
ChatMessageDeletedEvent。
- listener
-
(e: ChatMessageDeletedEvent) => void
要处理事件的侦听器。
on("chatMessageEdited", (e: ChatMessageEditedEvent) => void)
chatMessageEdited 的订阅函数。 初始发送方也将接收此事件。
function on(event: "chatMessageEdited", listener: (e: ChatMessageEditedEvent) => void)参数
- event
-
"chatMessageEdited"
ChatMessageEditedEvent。
- listener
-
(e: ChatMessageEditedEvent) => void
要处理事件的侦听器。
on("chatMessageReceived", (e: ChatMessageReceivedEvent) => void)
chatMessageReceived 的 Subscribe 函数。 初始发送方也将接收此事件。 在订阅任何事件之前，需要调用 startRealtimeNotifications。
function on(event: "chatMessageReceived", listener: (e: ChatMessageReceivedEvent) => void)参数
- event
-
"chatMessageReceived"
ChatMessageReceivedEvent。
- listener
-
(e: ChatMessageReceivedEvent) => void
要处理事件的侦听器。
on("chatThreadCreated", (e: ChatThreadCreatedEvent) => void)
订阅 chatThreadCreated 的函数。
function on(event: "chatThreadCreated", listener: (e: ChatThreadCreatedEvent) => void)参数
- event
-
"chatThreadCreated"
ChatThreadCreatedEvent。
- listener
-
(e: ChatThreadCreatedEvent) => void
要处理事件的侦听器。
on("chatThreadDeleted", (e: ChatThreadDeletedEvent) => void)
订阅 chatThreadDeleted 的函数。
function on(event: "chatThreadDeleted", listener: (e: ChatThreadDeletedEvent) => void)参数
- event
-
"chatThreadDeleted"
ChatThreadDeletedEvent。
- listener
-
(e: ChatThreadDeletedEvent) => void
要处理事件的侦听器。
on("chatThreadPropertiesUpdated", (e: ChatThreadPropertiesUpdatedEvent) => void)
订阅 chatThreadPropertiesUpdated 的函数。
function on(event: "chatThreadPropertiesUpdated", listener: (e: ChatThreadPropertiesUpdatedEvent) => void)参数
- event
-
"chatThreadPropertiesUpdated"
ChatThreadPropertiesUpdatedEvent。
- listener
-
(e: ChatThreadPropertiesUpdatedEvent) => void
要处理事件的侦听器。
on("participantsAdded", (e: ParticipantsAddedEvent) => void)
为 participantsAdded 订阅函数。
function on(event: "participantsAdded", listener: (e: ParticipantsAddedEvent) => void)参数
- event
-
"participantsAdded"
ParticipantsAddedEvent。
- listener
-
(e: ParticipantsAddedEvent) => void
要处理事件的侦听器。
on("participantsRemoved", (e: ParticipantsRemovedEvent) => void)
为 participantsRemoved 订阅函数。
function on(event: "participantsRemoved", listener: (e: ParticipantsRemovedEvent) => void)参数
- event
-
"participantsRemoved"
ParticipantsRemovedEvent。
- listener
-
(e: ParticipantsRemovedEvent) => void
要处理事件的侦听器。
on("readReceiptReceived", (e: ReadReceiptReceivedEvent) => void)
Subscribe 函数用于 readReceiptReceived。
function on(event: "readReceiptReceived", listener: (e: ReadReceiptReceivedEvent) => void)参数
- event
-
"readReceiptReceived"
ReadReceiptReceivedEvent。
- listener
-
(e: ReadReceiptReceivedEvent) => void
要处理事件的侦听器。
on("realTimeNotificationConnected", () => void)
realTimeNotificationConnected 的 Subscribe 函数。
function on(event: "realTimeNotificationConnected", listener: () => void)参数
- event
-
"realTimeNotificationConnected"
realTimeNotificationConnected 事件
- listener
-
() => void
要处理事件的侦听器。
on("realTimeNotificationDisconnected", () => void)
realTimeNotificationDisconnected 的 Subscribe 函数。
function on(event: "realTimeNotificationDisconnected", listener: () => void)参数
- event
-
"realTimeNotificationDisconnected"
realTimeNotificationDisconnected 事件
- listener
-
() => void
要处理事件的侦听器。
on("typingIndicatorReceived", (e: TypingIndicatorReceivedEvent) => void)
subscribe 函数，用于 typeIndicatorReceived。 初始发送方也将接收此事件。
function on(event: "typingIndicatorReceived", listener: (e: TypingIndicatorReceivedEvent) => void)参数
- event
-
"typingIndicatorReceived"
TypeIndicatorReceivedEvent。
- listener
-
(e: TypingIndicatorReceivedEvent) => void
要处理事件的侦听器。
startRealtimeNotifications()
开始接收实时通知。 在订阅任何事件之前调用此函数。
function startRealtimeNotifications(): Promise<void>返回
Promise<void>
stopRealtimeNotifications()
停止接收实时通知。 此函数将取消订阅所有事件。
function stopRealtimeNotifications(): Promise<void>返回
Promise<void>