ChatThreadClient class
チャット操作を実行するクライアント
コンストラクター
| Chat |
プロパティ
| 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(RestListMessagesOptions)
threadId によって識別されるスレッドからメッセージの一覧を取得します。 メッセージの一覧を返します。
function listMessages(options?: RestListMessagesOptions): PagedAsyncIterableIterator<ChatMessage, ChatMessage[], PageSettings>パラメーター
- options
- RestListMessagesOptions
メッセージ オプションを取得します。
戻り値
listParticipants(RestListParticipantsOptions)
threadId によって識別されるスレッドの参加者を取得します。 参加者のリストを返します。
function listParticipants(options?: RestListParticipantsOptions): PagedAsyncIterableIterator<ChatParticipant, ChatParticipant[], PageSettings>パラメーター
- options
- RestListParticipantsOptions
操作オプション。
戻り値
listReadReceipts(RestListReadReceiptsOptions)
threadId によって識別されるスレッドから開封確認の一覧を取得します。 メッセージの一覧を返します。
function listReadReceipts(options?: RestListReadReceiptsOptions): 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>
updateTopic(string, UpdateTopicOptions)
スレッドのトピックを更新します。
function updateTopic(topic: string, options?: UpdateTopicOptions): Promise<void>パラメーター
- topic
-
string
トピックを に更新する必要があります。
- options
- UpdateTopicOptions
操作オプション。
戻り値
Promise<void>