ChatAdapterThreadManagement interface

Paquete:

@azure/communication-react

Funcionalidad para administrar el subproceso de chat actual.

Métodos

deleteMessage(string)	Elimine un mensaje en el subproceso.
downloadResourceToCache(ResourceDetails)	Descarga un recurso en la memoria caché para el mensaje dado.
fetchInitialData()	Capturar el estado inicial del adaptador de chat. Realiza la captura mínima necesaria para los métodos chatComposite y API.
loadPreviousChatMessages(number)	Cargue más mensajes anteriores en el historial de subprocesos de chat.
removeParticipant(string)	Quite un participante en el subproceso.
removeResourceFromCache(ResourceDetails)	Quita un recurso de la caché para el mensaje dado.
sendMessage(string, SendMessageOptions)	Envíe un mensaje en el subproceso. Tenga en cuenta que SendMessageOptions está en desuso, use MessageOptions en su lugar.
sendReadReceipt(string)	Enviar una confirmación de lectura para un mensaje.
sendTypingIndicator()	Enviar indicador de escritura en el subproceso.
setTopic(string)	Establezca el tema del subproceso.
updateMessage(string, string, Record<string, string>)	Actualice un contenido de mensaje. Tenga en cuenta que los metadatos están en desuso, use MessageOptions.metadata en su lugar.

Detalles del método

deleteMessage(string)

Elimine un mensaje en el subproceso.

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

Parámetros

messageId

string

Devoluciones

Promise<void>

downloadResourceToCache(ResourceDetails)

Descarga un recurso en la memoria caché para el mensaje dado.

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

Parámetros

resourceDetails

ResourceDetails

Devoluciones

Promise<void>

fetchInitialData()

Capturar el estado inicial del adaptador de chat.

Realiza la captura mínima necesaria para los métodos chatComposite y API.

function fetchInitialData(): Promise<void>

Devoluciones

Promise<void>

loadPreviousChatMessages(number)

Cargue más mensajes anteriores en el historial de subprocesos de chat.

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

Parámetros

messagesToLoad

number

Devoluciones

Promise<boolean>

Comentarios

Este método se usa normalmente para controlar la captura incremental o el desplazamiento infinito

removeParticipant(string)

Quite un participante en el subproceso.

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

Parámetros

userId

string

Devoluciones

Promise<void>

removeResourceFromCache(ResourceDetails)

Quita un recurso de la caché para el mensaje dado.

function removeResourceFromCache(resourceDetails: ResourceDetails)

Parámetros

resourceDetails

ResourceDetails

sendMessage(string, SendMessageOptions)

Envíe un mensaje en el subproceso. Tenga en cuenta que SendMessageOptions está en desuso, use MessageOptions en su lugar.

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

Parámetros

content

string

options

SendMessageOptions

Devoluciones

Promise<void>

sendReadReceipt(string)

Enviar una confirmación de lectura para un mensaje.

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

Parámetros

chatMessageId

string

Devoluciones

Promise<void>

sendTypingIndicator()

Enviar indicador de escritura en el subproceso.

function sendTypingIndicator(): Promise<void>

Devoluciones

Promise<void>

setTopic(string)

Establezca el tema del subproceso.

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

Parámetros

topicName

string

Devoluciones

Promise<void>

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

Actualice un contenido de mensaje. Tenga en cuenta que los metadatos están en desuso, use MessageOptions.metadata en su lugar.

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

Parámetros

messageId

string

content

string

options

Record<string, string>

Devoluciones

Promise<void>