ChatAdapterThreadManagement interface

Pacote:

@azure/communication-react

Funcionalidade para gerenciar o thread de chat atual.

Métodos

deleteMessage(string)	Exclua uma mensagem no thread.
downloadResourceToCache(ResourceDetails)	Baixa um recurso no cache para a mensagem fornecida.
fetchInitialData()	Buscar o estado inicial para o adaptador de Chat. Executa a busca mínima necessária para métodos de ChatComposite e API.
loadPreviousChatMessages(number)	Carregue mais mensagens anteriores no histórico de threads de chat.
removeParticipant(string)	Remova um participante no thread.
removeResourceFromCache(ResourceDetails)	Remove um recurso do cache para a mensagem fornecida.
sendMessage(string, SendMessageOptions)	Envie uma mensagem no thread. Observe que SendMessageOptions está sendo preterido, use MessageOptions em vez disso.
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>)	Atualize um conteúdo de mensagem. Observe que os metadados estão sendo preteridos, use MessageOptions.metadata em vez disso.

Detalhes do método

deleteMessage(string)

Exclua uma mensagem no thread.

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

Parâmetros

messageId

string

Retornos

Promise<void>

downloadResourceToCache(ResourceDetails)

Baixa um recurso no cache para a mensagem fornecida.

function downloadResourceToCache(resourceDetails: ResourceDetails): Promise<void>

Parâmetros

resourceDetails

ResourceDetails

Retornos

Promise<void>

fetchInitialData()

Buscar o estado inicial para o adaptador de Chat.

Executa a busca mínima necessária para métodos de 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 no thread.

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

Parâmetros

userId

string

Retornos

Promise<void>

removeResourceFromCache(ResourceDetails)

Remove um recurso do cache para a mensagem fornecida.

function removeResourceFromCache(resourceDetails: ResourceDetails)

Parâmetros

resourceDetails

ResourceDetails

sendMessage(string, SendMessageOptions)

Envie uma mensagem no thread. Observe que SendMessageOptions está sendo preterido, use MessageOptions em vez disso.

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>)

Atualize um conteúdo de mensagem. Observe que os metadados estão sendo preteridos, use MessageOptions.metadata em vez disso.

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

Parâmetros

messageId

string

content

string

options

Record<string, string>

Retornos

Promise<void>