ChatClient class

Paquete:

@azure/communication-chat

El cliente para realizar operaciones de chat

Constructores

ChatClient(string, CommunicationTokenCredential, ChatClientOptions)

Crea una instancia de ChatClient para un recurso y usuario determinado.

Métodos

createChatThread(CreateChatThreadRequest, CreateChatThreadOptions)	Crea un subproceso de chat. Devuelve el cliente de subprocesos con el identificador del subproceso creado.
deleteChatThread(string, OperationOptions)	Elimina un subproceso de chat.
getChatThreadClient(string)	Devuelve ChatThreadClient con el identificador de subproceso específico.
listChatThreads(ChatListChatThreadsOptionalParams)	Obtiene la lista de subprocesos de chat de un usuario.
off("chatMessageDeleted", (e: ChatMessageDeletedEvent) => void)	Cancelar la suscripción de chatMessageDeleted.
off("chatMessageEdited", (e: ChatMessageEditedEvent) => void)	Cancelar la suscripción de chatMessageEdited.
off("chatMessageReceived", (e: ChatMessageReceivedEvent) => void)	Cancelar la suscripción de chatMessageReceived.
off("chatThreadCreated", (e: ChatThreadCreatedEvent) => void)	Cancelar la suscripción de chatThreadCreated.
off("chatThreadDeleted", (e: ChatThreadDeletedEvent) => void)	Cancelar la suscripción de chatThreadDeleted.
off("chatThreadPropertiesUpdated", (e: ChatThreadPropertiesUpdatedEvent) => void)	Cancelar la suscripción de chatThreadPropertiesUpdated.
off("participantsAdded", (e: ParticipantsAddedEvent) => void)	Cancelar la suscripción de los participantesAdded.
off("participantsRemoved", (e: ParticipantsRemovedEvent) => void)	Cancelar la suscripción a los participantesRemoved.
off("readReceiptReceived", (e: ReadReceiptReceivedEvent) => void)	Cancelar la suscripción a readReceiptReceived.
off("typingIndicatorReceived", (e: TypingIndicatorReceivedEvent) => void)	Cancelar la suscripción de typingIndicatorReceived.
on("chatMessageDeleted", (e: ChatMessageDeletedEvent) => void)	Función Subscribe para chatMessageDeleted. El remitente inicial también recibirá este evento.
on("chatMessageEdited", (e: ChatMessageEditedEvent) => void)	Función Subscribe para chatMessageEdited. El remitente inicial también recibirá este evento.
on("chatMessageReceived", (e: ChatMessageReceivedEvent) => void)	Función Subscribe para chatMessageReceived. El remitente inicial también recibirá este evento. Debe llamar a startRealtimeNotifications antes de suscribirse a cualquier evento.
on("chatThreadCreated", (e: ChatThreadCreatedEvent) => void)	Función Subscribe para chatThreadCreated.
on("chatThreadDeleted", (e: ChatThreadDeletedEvent) => void)	Función Subscribe para chatThreadDeleted.
on("chatThreadPropertiesUpdated", (e: ChatThreadPropertiesUpdatedEvent) => void)	Función Subscribe para chatThreadPropertiesUpdated.
on("participantsAdded", (e: ParticipantsAddedEvent) => void)	Función Subscribe para participantesAdded.
on("participantsRemoved", (e: ParticipantsRemovedEvent) => void)	Función Subscribe para participantesRemoved.
on("readReceiptReceived", (e: ReadReceiptReceivedEvent) => void)	Función Subscribe para readReceiptReceived.
on("realTimeNotificationConnected", () => void)	Función Subscribe para realTimeNotificationConnected.
on("realTimeNotificationDisconnected", () => void)	Función Subscribe para realTimeNotificationDisconnected.
on("typingIndicatorReceived", (e: TypingIndicatorReceivedEvent) => void)	Función Subscribe para typingIndicatorReceived. El remitente inicial también recibirá este evento.
startRealtimeNotifications()	Empiece a recibir notificaciones en tiempo real. Llame a esta función antes de suscribirse a cualquier evento.
stopRealtimeNotifications()	Deje de recibir notificaciones en tiempo real. Esta función cancelaría la suscripción a todos los eventos.

Detalles del constructor

ChatClient(string, CommunicationTokenCredential, ChatClientOptions)

Crea una instancia de ChatClient para un recurso y usuario determinado.

new ChatClient(endpoint: string, credential: CommunicationTokenCredential, options?: ChatClientOptions)

Parámetros

endpoint

string

Dirección URL del recurso de Communication Services.

credential

CommunicationTokenCredential

Credencial del token. Use AzureCommunicationTokenCredential desde @azure/communication-common para crear una credencial.

options

ChatClientOptions

Opciones de cliente adicionales.

Detalles del método

createChatThread(CreateChatThreadRequest, CreateChatThreadOptions)

Crea un subproceso de chat. Devuelve el cliente de subprocesos con el identificador del subproceso creado.

function createChatThread(request: CreateChatThreadRequest, options?: CreateChatThreadOptions): Promise<CreateChatThreadResult>

Parámetros

request

CreateChatThreadRequest

Solicitud para crear un subproceso de chat.

options

CreateChatThreadOptions

Opciones de operación.

Devoluciones

Promise<CreateChatThreadResult>

deleteChatThread(string, OperationOptions)

Elimina un subproceso de chat.

function deleteChatThread(threadId: string, options?: OperationOptions): Promise<void>

Parámetros

threadId

string

Identificador del subproceso que se va a eliminar.

options

OperationOptions

Opciones de operación.

Devoluciones

Promise<void>

getChatThreadClient(string)

Devuelve ChatThreadClient con el identificador de subproceso específico.

function getChatThreadClient(threadId: string): ChatThreadClient

Parámetros

threadId

string

Identificador de subproceso para ChatThreadClient

Devoluciones

ChatThreadClient

listChatThreads(ChatListChatThreadsOptionalParams)

Obtiene la lista de subprocesos de chat de un usuario.

function listChatThreads(options?: ChatListChatThreadsOptionalParams): PagedAsyncIterableIterator<ChatThreadItem, ChatThreadItem[], PageSettings>

Parámetros

options

RestListChatThreadsOptions

Enumerar las opciones de subprocesos de chat.

Devoluciones

PagedAsyncIterableIterator<ChatThreadItem, ChatThreadItem[], PageSettings>

off("chatMessageDeleted", (e: ChatMessageDeletedEvent) => void)

Cancelar la suscripción de chatMessageDeleted.

function off(event: "chatMessageDeleted", listener: (e: ChatMessageDeletedEvent) => void)

Parámetros

event

"chatMessageDeleted"

El ChatMessageDeletedEvent.

listener

(e: ChatMessageDeletedEvent) => void

Agente de escucha para controlar el evento.

off("chatMessageEdited", (e: ChatMessageEditedEvent) => void)

Cancelar la suscripción de chatMessageEdited.

function off(event: "chatMessageEdited", listener: (e: ChatMessageEditedEvent) => void)

Parámetros

event

"chatMessageEdited"

El ChatMessageEditedEvent.

listener

(e: ChatMessageEditedEvent) => void

Agente de escucha para controlar el evento.

off("chatMessageReceived", (e: ChatMessageReceivedEvent) => void)

Cancelar la suscripción de chatMessageReceived.

function off(event: "chatMessageReceived", listener: (e: ChatMessageReceivedEvent) => void)

Parámetros

event

"chatMessageReceived"

El ChatMessageReceivedEvent.

listener

(e: ChatMessageReceivedEvent) => void

Agente de escucha para controlar el evento.

off("chatThreadCreated", (e: ChatThreadCreatedEvent) => void)

Cancelar la suscripción de chatThreadCreated.

function off(event: "chatThreadCreated", listener: (e: ChatThreadCreatedEvent) => void)

Parámetros

event

"chatThreadCreated"

El evento ChatThreadCreated.

listener

(e: ChatThreadCreatedEvent) => void

Agente de escucha para controlar el evento.

off("chatThreadDeleted", (e: ChatThreadDeletedEvent) => void)

Cancelar la suscripción de chatThreadDeleted.

function off(event: "chatThreadDeleted", listener: (e: ChatThreadDeletedEvent) => void)

Parámetros

event

"chatThreadDeleted"

El ChatThreadDeletedEvent.

listener

(e: ChatThreadDeletedEvent) => void

Agente de escucha para controlar el evento.

off("chatThreadPropertiesUpdated", (e: ChatThreadPropertiesUpdatedEvent) => void)

Cancelar la suscripción de chatThreadPropertiesUpdated.

function off(event: "chatThreadPropertiesUpdated", listener: (e: ChatThreadPropertiesUpdatedEvent) => void)

Parámetros

event

"chatThreadPropertiesUpdated"

El evento ChatThreadPropertiesUpdatedEvent.

listener

(e: ChatThreadPropertiesUpdatedEvent) => void

Agente de escucha para controlar el evento.

off("participantsAdded", (e: ParticipantsAddedEvent) => void)

Cancelar la suscripción de los participantesAdded.

function off(event: "participantsAdded", listener: (e: ParticipantsAddedEvent) => void)

Parámetros

event

"participantsAdded"

El ParticipantsAddedEvent.

listener

(e: ParticipantsAddedEvent) => void

Agente de escucha para controlar el evento.

off("participantsRemoved", (e: ParticipantsRemovedEvent) => void)

Cancelar la suscripción a los participantesRemoved.

function off(event: "participantsRemoved", listener: (e: ParticipantsRemovedEvent) => void)

Parámetros

event

"participantsRemoved"

El ParticipantsRemovedEvent.

listener

(e: ParticipantsRemovedEvent) => void

Agente de escucha para controlar el evento.

off("readReceiptReceived", (e: ReadReceiptReceivedEvent) => void)

Cancelar la suscripción a readReceiptReceived.

function off(event: "readReceiptReceived", listener: (e: ReadReceiptReceivedEvent) => void)

Parámetros

event

"readReceiptReceived"

El ReadReceiptReceivedEvent.

listener

(e: ReadReceiptReceivedEvent) => void

Agente de escucha para controlar el evento.

off("typingIndicatorReceived", (e: TypingIndicatorReceivedEvent) => void)

Cancelar la suscripción de typingIndicatorReceived.

function off(event: "typingIndicatorReceived", listener: (e: TypingIndicatorReceivedEvent) => void)

Parámetros

event

"typingIndicatorReceived"

El TypingIndicatorReceivedEvent.

listener

(e: TypingIndicatorReceivedEvent) => void

Agente de escucha para controlar el evento.

on("chatMessageDeleted", (e: ChatMessageDeletedEvent) => void)

Función Subscribe para chatMessageDeleted. El remitente inicial también recibirá este evento.

function on(event: "chatMessageDeleted", listener: (e: ChatMessageDeletedEvent) => void)

Parámetros

event

"chatMessageDeleted"

El ChatMessageDeletedEvent.

listener

(e: ChatMessageDeletedEvent) => void

Agente de escucha para controlar el evento.

on("chatMessageEdited", (e: ChatMessageEditedEvent) => void)

Función Subscribe para chatMessageEdited. El remitente inicial también recibirá este evento.

function on(event: "chatMessageEdited", listener: (e: ChatMessageEditedEvent) => void)

Parámetros

event

"chatMessageEdited"

El ChatMessageEditedEvent.

listener

(e: ChatMessageEditedEvent) => void

Agente de escucha para controlar el evento.

on("chatMessageReceived", (e: ChatMessageReceivedEvent) => void)

Función Subscribe para chatMessageReceived. El remitente inicial también recibirá este evento. Debe llamar a startRealtimeNotifications antes de suscribirse a cualquier evento.

function on(event: "chatMessageReceived", listener: (e: ChatMessageReceivedEvent) => void)

Parámetros

event

"chatMessageReceived"

El ChatMessageReceivedEvent.

listener

(e: ChatMessageReceivedEvent) => void

Agente de escucha para controlar el evento.

on("chatThreadCreated", (e: ChatThreadCreatedEvent) => void)

Función Subscribe para chatThreadCreated.

function on(event: "chatThreadCreated", listener: (e: ChatThreadCreatedEvent) => void)

Parámetros

event

"chatThreadCreated"

El evento ChatThreadCreated.

listener

(e: ChatThreadCreatedEvent) => void

Agente de escucha para controlar el evento.

on("chatThreadDeleted", (e: ChatThreadDeletedEvent) => void)

Función Subscribe para chatThreadDeleted.

function on(event: "chatThreadDeleted", listener: (e: ChatThreadDeletedEvent) => void)

Parámetros

event

"chatThreadDeleted"

El ChatThreadDeletedEvent.

listener

(e: ChatThreadDeletedEvent) => void

Agente de escucha para controlar el evento.

on("chatThreadPropertiesUpdated", (e: ChatThreadPropertiesUpdatedEvent) => void)

Función Subscribe para chatThreadPropertiesUpdated.

function on(event: "chatThreadPropertiesUpdated", listener: (e: ChatThreadPropertiesUpdatedEvent) => void)

Parámetros

event

"chatThreadPropertiesUpdated"

El evento ChatThreadPropertiesUpdatedEvent.

listener

(e: ChatThreadPropertiesUpdatedEvent) => void

Agente de escucha para controlar el evento.

on("participantsAdded", (e: ParticipantsAddedEvent) => void)

Función Subscribe para participantesAdded.

function on(event: "participantsAdded", listener: (e: ParticipantsAddedEvent) => void)

Parámetros

event

"participantsAdded"

El ParticipantsAddedEvent.

listener

(e: ParticipantsAddedEvent) => void

Agente de escucha para controlar el evento.

on("participantsRemoved", (e: ParticipantsRemovedEvent) => void)

Función Subscribe para participantesRemoved.

function on(event: "participantsRemoved", listener: (e: ParticipantsRemovedEvent) => void)

Parámetros

event

"participantsRemoved"

El ParticipantsRemovedEvent.

listener

(e: ParticipantsRemovedEvent) => void

Agente de escucha para controlar el evento.

on("readReceiptReceived", (e: ReadReceiptReceivedEvent) => void)

Función Subscribe para readReceiptReceived.

function on(event: "readReceiptReceived", listener: (e: ReadReceiptReceivedEvent) => void)

Parámetros

event

"readReceiptReceived"

El ReadReceiptReceivedEvent.

listener

(e: ReadReceiptReceivedEvent) => void

Agente de escucha para controlar el evento.

on("realTimeNotificationConnected", () => void)

Función Subscribe para realTimeNotificationConnected.

function on(event: "realTimeNotificationConnected", listener: () => void)

Parámetros

event

"realTimeNotificationConnected"

El evento realTimeNotificationConnected

listener

() => void

Agente de escucha para controlar el evento.

on("realTimeNotificationDisconnected", () => void)

Función Subscribe para realTimeNotificationDisconnected.

function on(event: "realTimeNotificationDisconnected", listener: () => void)

Parámetros

event

"realTimeNotificationDisconnected"

El evento realTimeNotificationDisconnected

listener

() => void

Agente de escucha para controlar el evento.

on("typingIndicatorReceived", (e: TypingIndicatorReceivedEvent) => void)

Función Subscribe para typingIndicatorReceived. El remitente inicial también recibirá este evento.

function on(event: "typingIndicatorReceived", listener: (e: TypingIndicatorReceivedEvent) => void)

Parámetros

event

"typingIndicatorReceived"

El TypingIndicatorReceivedEvent.

listener

(e: TypingIndicatorReceivedEvent) => void

Agente de escucha para controlar el evento.

startRealtimeNotifications()

Empiece a recibir notificaciones en tiempo real. Llame a esta función antes de suscribirse a cualquier evento.

function startRealtimeNotifications(): Promise<void>

Devoluciones

Promise<void>

stopRealtimeNotifications()

Deje de recibir notificaciones en tiempo real. Esta función cancelaría la suscripción a todos los eventos.

function stopRealtimeNotifications(): Promise<void>

Devoluciones

Promise<void>