Partilhar via

ChatAdapterThreadManagement interface

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

Funcionalidade para gerir o tópico de chat atual.

Métodos

deleteMessage(string)

Elimine uma mensagem no tópico.
fetchInitialData()

Obtenha o estado inicial do adaptador chat.

Executa a obtenção mínima necessária para os métodos ChatComposite e API.
loadPreviousChatMessages(number)

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

Remova um participante no tópico.
sendMessage(string, SendMessageOptions)

Enviar uma mensagem no tópico.
sendReadReceipt(string)

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

Enviar indicador de escrita no thread.
setTopic(string)

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

Atualizar o conteúdo de uma mensagem.

Detalhes de Método

deleteMessage(string)

Elimine uma mensagem no tópico.

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

Parâmetros

messageId

string

Devoluções

Promise<void>

fetchInitialData()

Obtenha o estado inicial do adaptador chat.

Executa a obtenção mínima necessária para os métodos ChatComposite e API.

function fetchInitialData(): Promise<void>

Devoluções

Promise<void>

loadPreviousChatMessages(number)

Carregue mais mensagens anteriores no histórico de tópicos de chat.

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

Parâmetros

messagesToLoad

number

Devoluções

Promise<boolean>

Observações

Normalmente, este método é utilizado para controlar a obtenção incremental/deslocamento infinito

removeParticipant(string)

Remova um participante no tópico.

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

Parâmetros

userId

string

Devoluções

Promise<void>

sendMessage(string, SendMessageOptions)

Enviar uma mensagem no tópico.

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

Parâmetros

content

string

options
SendMessageOptions

Devoluções

Promise<void>

sendReadReceipt(string)

Envie um recibo de leitura para uma mensagem.

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

Parâmetros

chatMessageId

string

Devoluções

Promise<void>

sendTypingIndicator()

Enviar indicador de escrita no thread.

function sendTypingIndicator(): Promise<void>

Devoluções

Promise<void>

setTopic(string)

Defina o tópico para o tópico.

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

Parâmetros

topicName

string

Devoluções

Promise<void>

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

Atualizar o conteúdo de uma mensagem.

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

Parâmetros

messageId

string

content

string

metadata

Record<string, string>

Devoluções

Promise<void>