ChatThreadClient class

new ChatThreadClient(endpoint: string, threadId: string, credential: CommunicationTokenCredential, options?: ChatThreadClientOptions)

Parâmetros

ID de thread do ChatThreadClient

threadId: string

Valor da propriedade

Adiciona os detalhes dos participantes do chat que pertencem ao thread identificado por threadId.

function addParticipants(request: AddParticipantsRequest, options?: OperationOptions): Promise<AddChatParticipantsResult>

Parâmetros

Retornos

Exclui uma mensagem identificada por threadId e messageId

function deleteMessage(messageId: string, options?: OperationOptions): Promise<void>

Parâmetros

Retornos

Obtém uma mensagem de chat identificada por messageId. Retorna a mensagem específica.

function getMessage(messageId: string, options?: OperationOptions): Promise<ChatMessage>

Parâmetros

Retornos

Obtém um thread de chat. Retorna a conversa de chat.

function getProperties(options?: OperationOptions): Promise<ChatThreadProperties>

Parâmetros

Retornos

Obtém uma lista de mensagens de um thread identificado por threadId. Retorna a lista das mensagens.

function listMessages(options?: RestListMessagesOptions): PagedAsyncIterableIterator<ChatMessage, ChatMessage[], PageSettings>

Parâmetros

Retornos

Obtém os participantes do thread identificado por threadId. Retorna as listas dos participantes.

function listParticipants(options?: RestListParticipantsOptions): PagedAsyncIterableIterator<ChatParticipant, ChatParticipant[], PageSettings>

Parâmetros

Retornos

Obtém uma lista de confirmação de leitura de um thread identificado por threadId. Retorna a lista das mensagens.

function listReadReceipts(options?: RestListReadReceiptsOptions): PagedAsyncIterableIterator<ChatMessageReadReceipt, ChatMessageReadReceipt[], PageSettings>

Parâmetros

Retornos

Remove o participante do thread identificado por threadId.

function removeParticipant(participant: CommunicationIdentifier, options?: OperationOptions): Promise<void>

Parâmetros

Retornos

Envia uma mensagem de chat para um thread identificado por threadId. Retorna a ID da mensagem criada.

function sendMessage(request: SendMessageRequest, options?: SendMessageOptions): Promise<SendChatMessageResult>

Parâmetros

Retornos

Envia um recibo de leitura para o thread identificado por threadId.

function sendReadReceipt(request: SendReadReceiptRequest, options?: OperationOptions): Promise<void>

Parâmetros

Retornos

Envia uma notificação de digitação para o thread. Não tenta enviar se o tempo desde a última notificação for menor que o intervalo mínimo de digitação

function sendTypingNotification(options?: SendTypingNotificationOptions): Promise<boolean>

Parâmetros

Retornos

True se a notificação de mensagem de digitação puder ser enviada; caso contrário, false.

Atualizações uma mensagem identificada por threadId e messageId

function updateMessage(messageId: string, options?: UpdateMessageOptions): Promise<void>

Parâmetros

Retornos

Atualizações tópico de um thread.

function updateTopic(topic: string, options?: UpdateTopicOptions): Promise<void>

Parâmetros

Retornos