Compartilhar via

ChatAdapterThreadManagement interface

  • Referência
Pacote:
@azure/communication-react

Funcionalidade para gerenciar o thread de chat atual.

Métodos

deleteMessage(string)

Exclua uma mensagem no thread.
fetchInitialData()

Buscar o estado inicial do adaptador de chat.

Executa a busca mínima necessária para métodos chatComposite e API.
loadPreviousChatMessages(number)

Carregue mais mensagens anteriores no histórico de threads de chat.
removeParticipant(string)

Remova um participante do thread.
sendMessage(string, SendMessageOptions)

Envie uma mensagem no thread.
sendReadReceipt(string)

Envie um recibo de leitura para uma mensagem.
sendTypingIndicator()

Enviar indicador de digitação no thread.
setTopic(string)

Defina o tópico para o thread.
updateMessage(string, string, Record<string, string>)

Atualizar um conteúdo de mensagem.

Detalhes do método

deleteMessage(string)

Exclua uma mensagem no thread.

function deleteMessage(messageId: string): Promise<void>

Parâmetros

messageId

string

Retornos

Promise<void>

fetchInitialData()

Buscar o estado inicial do adaptador de chat.

Executa a busca mínima necessária para métodos chatComposite e API.

function fetchInitialData(): Promise<void>

Retornos

Promise<void>

loadPreviousChatMessages(number)

Carregue mais mensagens anteriores no histórico de threads de chat.

function loadPreviousChatMessages(messagesToLoad: number): Promise<boolean>

Parâmetros

messagesToLoad

number

Retornos

Promise<boolean>

Comentários

Esse método geralmente é usado para controlar a busca incremental/rolagem infinita

removeParticipant(string)

Remova um participante do thread.

function removeParticipant(userId: string): Promise<void>

Parâmetros

userId

string

Retornos

Promise<void>

sendMessage(string, SendMessageOptions)

Envie uma mensagem no thread.

function sendMessage(content: string, options?: SendMessageOptions): Promise<void>

Parâmetros

content

string

options
SendMessageOptions

Retornos

Promise<void>

sendReadReceipt(string)

Envie um recibo de leitura para uma mensagem.

function sendReadReceipt(chatMessageId: string): Promise<void>

Parâmetros

chatMessageId

string

Retornos

Promise<void>

sendTypingIndicator()

Enviar indicador de digitação no thread.

function sendTypingIndicator(): Promise<void>

Retornos

Promise<void>

setTopic(string)

Defina o tópico para o thread.

function setTopic(topicName: string): Promise<void>

Parâmetros

topicName

string

Retornos

Promise<void>

updateMessage(string, string, Record<string, string>)

Atualizar um conteúdo de mensagem.

function updateMessage(messageId: string, content: string, metadata?: Record<string, string>): Promise<void>

Parâmetros

messageId

string

content

string

metadata

Record<string, string>

Retornos

Promise<void>