ChatThreadClient class
要执行聊天作的客户端
属性
| thread |
ChatThreadClient 的线程 ID |
方法
构造函数详细信息
ChatThreadClient(string, string, CommunicationTokenCredential, ChatThreadClientOptions)
new ChatThreadClient(endpoint: string, threadId: string, credential: CommunicationTokenCredential, options?: ChatThreadClientOptions)参数
- endpoint
-
string
- threadId
-
string
- credential
- CommunicationTokenCredential
- options
- ChatThreadClientOptions
属性详细信息
threadId
ChatThreadClient 的线程 ID
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
消息的消息 ID。
- options
- OperationOptions
作选项。
返回
Promise<void>
getMessage(string, OperationOptions)
获取由 messageId 标识的聊天消息。 返回特定消息。
function getMessage(messageId: string, options?: OperationOptions): Promise<ChatMessage>参数
- messageId
-
string
消息的消息 ID。
- 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
获取消息选项。
返回
listParticipants(ChatThreadListChatParticipantsOptionalParams)
获取由 threadId 标识的线程的参与者。 返回参与者的列表。
function listParticipants(options?: ChatThreadListChatParticipantsOptionalParams): PagedAsyncIterableIterator<ChatParticipant, ChatParticipant[], PageSettings>参数
- options
- RestListParticipantsOptions
作选项。
返回
listReadReceipts(ChatThreadListChatReadReceiptsOptionalParams)
从 threadId 标识的线程获取已读回执的列表。 返回消息列表。
function listReadReceipts(options?: ChatThreadListChatReadReceiptsOptionalParams): PagedAsyncIterableIterator<ChatMessageReadReceipt, ChatMessageReadReceipt[], PageSettings>参数
- options
- RestListReadReceiptsOptions
获取消息选项。
返回
removeParticipant(CommunicationIdentifier, OperationOptions)
从 threadId 标识的线程中删除参与者。
function removeParticipant(participant: CommunicationIdentifier, options?: OperationOptions): Promise<void>参数
- participant
- CommunicationIdentifier
要从线程名单中删除的线程参与者
- options
- OperationOptions
作选项。
返回
Promise<void>
sendMessage(SendMessageRequest, SendMessageOptions)
将聊天消息发送到由 threadId 标识的线程。 返回所创建消息的 ID。
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
消息的消息 ID。
- options
- UpdateMessageOptions
作选项。
返回
Promise<void>
updateProperties(UpdateChatThreadPropertiesOptions)
更新线程的属性。
function updateProperties(options?: UpdateChatThreadPropertiesOptions): Promise<void>参数
作选项。
返回
Promise<void>
updateTopic(string, UpdateTopicOptions)
更新线程的主题。
function updateTopic(topic: string, options?: UpdateTopicOptions): Promise<void>参数
- topic
-
string
主题需要更新为。
- options
- UpdateTopicOptions
作选项。
返回
Promise<void>