ChatAdapterThreadManagement interface

Pacote:

@azure/communication-react

Funcionalidade para gerenciar o thread de bate-papo atual.

Métodos

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

Detalhes de Método

deleteMessage(string)

Exclua uma mensagem no thread.

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

Parâmetros

messageId

string

Devoluções

Promise<void>

downloadResourceToCache(ResourceDetails)

Baixa um recurso no cache da mensagem fornecida.

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

Parâmetros

resourceDetails

ResourceDetails

Devoluções

Promise<void>

fetchInitialData()

Buscar o estado inicial para o adaptador de bate-papo.

Executa a busca 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 conversas de chat.

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

Parâmetros

messagesToLoad

number

Devoluções

Promise<boolean>

Observações

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

removeParticipant(string)

Remova um participante no tópico.

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

Parâmetros

userId

string

Devoluções

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 tópico. 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

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 digitação 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. 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>

Devoluções

Promise<void>