ChatThreadClient class

Paquete:

@azure/communication-chat

El cliente para realizar operaciones de chat

Constructores

ChatThreadClient(string, string, CommunicationTokenCredential, ChatThreadClientOptions)

Propiedades

threadId

Identificador de subproceso de ChatThreadClient

Métodos

addParticipants(AddParticipantsRequest, OperationOptions)	Agrega los detalles de los participantes del chat que pertenecen al subproceso identificado por threadId.
deleteMessage(string, OperationOptions)	Elimina un mensaje identificado por threadId y messageId.
getMessage(string, OperationOptions)	Obtiene un mensaje de chat identificado por messageId. Devuelve el mensaje específico.
getProperties(OperationOptions)	Obtiene una conversación de chat. Devuelve el subproceso de chat.
listMessages(RestListMessagesOptions)	Obtiene una lista de mensajes de un subproceso identificado por threadId. Devuelve la lista de mensajes.
listParticipants(RestListParticipantsOptions)	Obtiene los participantes del subproceso identificado por threadId. Devuelve las listas de los participantes.
listReadReceipts(RestListReadReceiptsOptions)	Obtiene una lista de recibos de lectura de un subproceso identificado por threadId. Devuelve la lista de mensajes.
removeParticipant(CommunicationIdentifier, OperationOptions)	Quita el participante del subproceso identificado por threadId.
sendMessage(SendMessageRequest, SendMessageOptions)	Envía un mensaje de chat a un subproceso identificado por threadId. Devuelve el identificador del mensaje creado.
sendReadReceipt(SendReadReceiptRequest, OperationOptions)	Envía una recepción de lectura al subproceso identificado por threadId.
sendTypingNotification(SendTypingNotificationOptions)	Envía una notificación de escritura al subproceso. No intenta enviar si la hora desde la última notificación es menor que el intervalo de escritura mínimo
updateMessage(string, UpdateMessageOptions)	Novedades un mensaje identificado por threadId y messageId
updateTopic(string, UpdateTopicOptions)	Novedades tema de un subproceso.

Detalles del constructor

ChatThreadClient(string, string, CommunicationTokenCredential, ChatThreadClientOptions)

new ChatThreadClient(endpoint: string, threadId: string, credential: CommunicationTokenCredential, options?: ChatThreadClientOptions)

Parámetros

endpoint

string

threadId

string

credential

CommunicationTokenCredential

options

ChatThreadClientOptions

Detalles de las propiedades

threadId

Identificador de subproceso de ChatThreadClient

threadId: string

Valor de propiedad

string

Detalles del método

addParticipants(AddParticipantsRequest, OperationOptions)

Agrega los detalles de los participantes del chat que pertenecen al subproceso identificado por threadId.

function addParticipants(request: AddParticipantsRequest, options?: OperationOptions): Promise<AddChatParticipantsResult>

Parámetros

request

AddParticipantsRequest

Detalles de los participantes del subproceso para agregar en la lista de subprocesos

options

OperationOptions

Opciones de operación.

Devoluciones

Promise<AddChatParticipantsResult>

deleteMessage(string, OperationOptions)

Elimina un mensaje identificado por threadId y messageId.

function deleteMessage(messageId: string, options?: OperationOptions): Promise<void>

Parámetros

messageId

string

Identificador del mensaje.

options

OperationOptions

Opciones de operación.

Devoluciones

Promise<void>

getMessage(string, OperationOptions)

Obtiene un mensaje de chat identificado por messageId. Devuelve el mensaje específico.

function getMessage(messageId: string, options?: OperationOptions): Promise<ChatMessage>

Parámetros

messageId

string

Identificador del mensaje.

options

OperationOptions

Opciones de operación.

Devoluciones

Promise<ChatMessage>

getProperties(OperationOptions)

Obtiene una conversación de chat. Devuelve el subproceso de chat.

function getProperties(options?: OperationOptions): Promise<ChatThreadProperties>

Parámetros

options

OperationOptions

Opciones de operación.

Devoluciones

Promise<ChatThreadProperties>

listMessages(RestListMessagesOptions)

Obtiene una lista de mensajes de un subproceso identificado por threadId. Devuelve la lista de mensajes.

function listMessages(options?: RestListMessagesOptions): PagedAsyncIterableIterator<ChatMessage, ChatMessage[], PageSettings>

Parámetros

options

RestListMessagesOptions

Obtiene las opciones de mensajes.

Devoluciones

PagedAsyncIterableIterator<ChatMessage, ChatMessage[], PageSettings>

listParticipants(RestListParticipantsOptions)

Obtiene los participantes del subproceso identificado por threadId. Devuelve las listas de los participantes.

function listParticipants(options?: RestListParticipantsOptions): PagedAsyncIterableIterator<ChatParticipant, ChatParticipant[], PageSettings>

Parámetros

options

RestListParticipantsOptions

Opciones de operación.

Devoluciones

PagedAsyncIterableIterator<ChatParticipant, ChatParticipant[], PageSettings>

listReadReceipts(RestListReadReceiptsOptions)

Obtiene una lista de recibos de lectura de un subproceso identificado por threadId. Devuelve la lista de mensajes.

function listReadReceipts(options?: RestListReadReceiptsOptions): PagedAsyncIterableIterator<ChatMessageReadReceipt, ChatMessageReadReceipt[], PageSettings>

Parámetros

options

RestListReadReceiptsOptions

Obtiene las opciones de mensajes.

Devoluciones

PagedAsyncIterableIterator<ChatMessageReadReceipt, ChatMessageReadReceipt[], PageSettings>

removeParticipant(CommunicationIdentifier, OperationOptions)

Quita el participante del subproceso identificado por threadId.

function removeParticipant(participant: CommunicationIdentifier, options?: OperationOptions): Promise<void>

Parámetros

participant

CommunicationIdentifier

Participante del subproceso que se va a quitar de la lista de subprocesos

options

OperationOptions

Opciones de operación.

Devoluciones

Promise<void>

sendMessage(SendMessageRequest, SendMessageOptions)

Envía un mensaje de chat a un subproceso identificado por threadId. Devuelve el identificador del mensaje creado.

function sendMessage(request: SendMessageRequest, options?: SendMessageOptions): Promise<SendChatMessageResult>

Parámetros

request

SendMessageRequest

Solicitud de envío de un mensaje.

options

SendMessageOptions

Opciones de operación.

Devoluciones

Promise<SendChatMessageResult>

sendReadReceipt(SendReadReceiptRequest, OperationOptions)

Envía una recepción de lectura al subproceso identificado por threadId.

function sendReadReceipt(request: SendReadReceiptRequest, options?: OperationOptions): Promise<void>

Parámetros

request

SendReadReceiptRequest

Solicitud de envío de un recibo de lectura

options

OperationOptions

Opciones de operación.

Devoluciones

Promise<void>

sendTypingNotification(SendTypingNotificationOptions)

Envía una notificación de escritura al subproceso. No intenta enviar si la hora desde la última notificación es menor que el intervalo de escritura mínimo

function sendTypingNotification(options?: SendTypingNotificationOptions): Promise<boolean>

Parámetros

options

SendTypingNotificationOptions

Opciones de operación

Devoluciones

Promise<boolean>

True si se puede enviar la notificación de mensaje de escritura; de lo contrario, false.

updateMessage(string, UpdateMessageOptions)

Novedades un mensaje identificado por threadId y messageId

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

Parámetros

messageId

string

Identificador del mensaje.

options

UpdateMessageOptions

Opciones de operación.

Devoluciones

Promise<void>

updateTopic(string, UpdateTopicOptions)

Novedades tema de un subproceso.

function updateTopic(topic: string, options?: UpdateTopicOptions): Promise<void>

Parámetros

topic

string

El tema debe actualizarse.

options

UpdateTopicOptions

Opciones de operación.

Devoluciones

Promise<void>