ChatThreadClient class

Pacote:

@azure/communication-chat

O cliente para fazer operações de chat

Construtores

ChatThreadClient(string, string, CommunicationTokenCredential, ChatThreadClientOptions)

Propriedades

threadId

ID do thread do ChatThreadClient

Métodos

addParticipants(AddParticipantsRequest, OperationOptions)	Adiciona os detalhes dos participantes do bate-papo pertencentes ao thread identificado pelo threadId.
deleteMessage(string, OperationOptions)	Exclui uma mensagem identificada por threadId e messageId
getMessage(string, OperationOptions)	Obtém uma mensagem de bate-papo identificada por messageId. Retorna a mensagem específica.
getProperties(OperationOptions)	Obtém um tópico de bate-papo. Retorna o tópico de bate-papo.
listMessages(ChatThreadListChatMessagesOptionalParams)	Obtém uma lista de mensagens de um thread identificado por threadId. Retorna a lista das mensagens.
listParticipants(ChatThreadListChatParticipantsOptionalParams)	Obtém os participantes do thread identificados por threadId. Devolve as listas dos participantes.
listReadReceipts(ChatThreadListChatReadReceiptsOptionalParams)	Obtém uma lista de confirmação de leitura de um thread identificado por threadId. Retorna a lista das mensagens.
removeParticipant(CommunicationIdentifier, OperationOptions)	Remove o participante do thread identificado por threadId.
sendMessage(SendMessageRequest, SendMessageOptions)	Envia uma mensagem de chat para um thread identificado por threadId. Retorna a id da mensagem criada.
sendReadReceipt(SendReadReceiptRequest, OperationOptions)	Envia uma confirmação de leitura para o thread identificado por threadId.
sendTypingNotification(SendTypingNotificationOptions)	Envia uma notificação de digitação para o thread. Não tenta enviar se o tempo desde a última notificação for menor do que o intervalo mínimo de digitação
updateMessage(string, UpdateMessageOptions)	Atualiza uma mensagem identificada por threadId e messageId
updateProperties(UpdateChatThreadPropertiesOptions)	Atualiza as propriedades de um thread.
updateTopic(string, UpdateTopicOptions)	Atualiza o tópico de um tópico.

Detalhes do Construtor

ChatThreadClient(string, string, CommunicationTokenCredential, ChatThreadClientOptions)

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

Parâmetros

endpoint

string

threadId

string

credential

CommunicationTokenCredential

options

ChatThreadClientOptions

Detalhes de Propriedade

threadId

ID do thread do ChatThreadClient

threadId: string

Valor de Propriedade

string

Detalhes de Método

addParticipants(AddParticipantsRequest, OperationOptions)

Adiciona os detalhes dos participantes do bate-papo pertencentes ao thread identificado pelo threadId.

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

Parâmetros

request

AddParticipantsRequest

Detalhes dos participantes do thread para adicionar à lista de threads

options

OperationOptions

Opções de operação.

Devoluções

Promise<AddChatParticipantsResult>

deleteMessage(string, OperationOptions)

Exclui uma mensagem identificada por threadId e messageId

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

Parâmetros

messageId

string

O ID da mensagem.

options

OperationOptions

Opções de operação.

Devoluções

Promise<void>

getMessage(string, OperationOptions)

Obtém uma mensagem de bate-papo identificada por messageId. Retorna a mensagem específica.

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

Parâmetros

messageId

string

O ID da mensagem.

options

OperationOptions

Opções de operação.

Devoluções

Promise<ChatMessage>

getProperties(OperationOptions)

Obtém um tópico de bate-papo. Retorna o tópico de bate-papo.

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

Parâmetros

options

OperationOptions

Opções de operação.

Devoluções

Promise<ChatThreadProperties>

listMessages(ChatThreadListChatMessagesOptionalParams)

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

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

Parâmetros

options

RestListMessagesOptions

Obter opções de mensagens.

Devoluções

PagedAsyncIterableIterator<ChatMessage, ChatMessage[], PageSettings>

listParticipants(ChatThreadListChatParticipantsOptionalParams)

Obtém os participantes do thread identificados por threadId. Devolve as listas dos participantes.

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

Parâmetros

options

RestListParticipantsOptions

Opções de operação.

Devoluções

PagedAsyncIterableIterator<ChatParticipant, ChatParticipant[], PageSettings>

listReadReceipts(ChatThreadListChatReadReceiptsOptionalParams)

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

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

Parâmetros

options

RestListReadReceiptsOptions

Obter opções de mensagens.

Devoluções

PagedAsyncIterableIterator<ChatMessageReadReceipt, ChatMessageReadReceipt[], PageSettings>

removeParticipant(CommunicationIdentifier, OperationOptions)

Remove o participante do thread identificado por threadId.

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

Parâmetros

participant

CommunicationIdentifier

Participante do thread a ser removido da lista de threads

options

OperationOptions

Opções de operação.

Devoluções

Promise<void>

sendMessage(SendMessageRequest, SendMessageOptions)

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

request

SendMessageRequest

Pedido de envio de uma mensagem.

options

SendMessageOptions

Opções de operação.

Devoluções

Promise<SendChatMessageResult>

sendReadReceipt(SendReadReceiptRequest, OperationOptions)

Envia uma confirmação de leitura para o thread identificado por threadId.

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

Parâmetros

request

SendReadReceiptRequest

Pedido de envio de um recibo de leitura

options

OperationOptions

Opções de operação.

Devoluções

Promise<void>

sendTypingNotification(SendTypingNotificationOptions)

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

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

Parâmetros

options

SendTypingNotificationOptions

Opções de operação

Devoluções

Promise<boolean>

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

updateMessage(string, UpdateMessageOptions)

Atualiza uma mensagem identificada por threadId e messageId

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

Parâmetros

messageId

string

O ID da mensagem.

options

UpdateMessageOptions

Opções de operação.

Devoluções

Promise<void>

updateProperties(UpdateChatThreadPropertiesOptions)

Atualiza as propriedades de um thread.

function updateProperties(options?: UpdateChatThreadPropertiesOptions): Promise<void>

Parâmetros

options

UpdateChatThreadPropertiesOptions

Opções de operação.

Devoluções

Promise<void>

updateTopic(string, UpdateTopicOptions)

Atualiza o tópico de um tópico.

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

Parâmetros

topic

string

O tópico precisa ser atualizado.

options

UpdateTopicOptions

Opções de operação.

Devoluções

Promise<void>