ChatClient class

Pacote:

@azure/communication-chat

O cliente para realizar operações de chat

Construtores

ChatClient(string, CommunicationTokenCredential, ChatClientOptions)

Cria uma instância do ChatClient para um determinado recurso e utilizador.

Métodos

createChatThread(CreateChatThreadRequest, CreateChatThreadOptions)	Cria um tópico de chat. Devolve o cliente de thread com o ID do thread criado.
deleteChatThread(string, OperationOptions)	Elimina um tópico de chat.
getChatThreadClient(string)	Devolve ChatThreadClient com o ID de thread específico.
listChatThreads(RestListChatThreadsOptions)	Obtém a lista de tópicos de chat de um utilizador.
off("chatMessageDeleted", (e: ChatMessageDeletedEvent) => void)	Anular a subscrição do chatMessageDeleted.
off("chatMessageEdited", (e: ChatMessageEditedEvent) => void)	Anular a subscrição do chatMessageEdited.
off("chatMessageReceived", (e: ChatMessageReceivedEvent) => void)	Anular a subscrição do chatMessageReceived.
off("chatThreadCreated", (e: ChatThreadCreatedEvent) => void)	Anular a subscrição do chatThreadCreated.
off("chatThreadDeleted", (e: ChatThreadDeletedEvent) => void)	Anule a subscrição do chatThreadDeleted.
off("chatThreadPropertiesUpdated", (e: ChatThreadPropertiesUpdatedEvent) => void)	Anular a subscrição de chatThreadPropertiesUpdated.
off("participantsAdded", (e: ParticipantsAddedEvent) => void)	Anular a subscrição dos participantesAdded.
off("participantsRemoved", (e: ParticipantsRemovedEvent) => void)	Anular a subscrição dos participantesRemoved.
off("readReceiptReceived", (e: ReadReceiptReceivedEvent) => void)	Anule a subscrição de readReceiptReceived.
off("typingIndicatorReceived", (e: TypingIndicatorReceivedEvent) => void)	Anule a subscrição de typingIndicatorReceived.
on("chatMessageDeleted", (e: ChatMessageDeletedEvent) => void)	Subscreva a função para chatMessageDeleted. O remetente inicial também receberá este evento.
on("chatMessageEdited", (e: ChatMessageEditedEvent) => void)	Subscreva a função para chatMessageEdited. O remetente inicial também receberá este evento.
on("chatMessageReceived", (e: ChatMessageReceivedEvent) => void)	Subscreva a função para chatMessageReceived. O remetente inicial também receberá este evento. Tem de chamar startRealtimeNotifications antes de subscrever qualquer evento.
on("chatThreadCreated", (e: ChatThreadCreatedEvent) => void)	Subscreva a função para chatThreadCreated.
on("chatThreadDeleted", (e: ChatThreadDeletedEvent) => void)	Subscreva a função para chatThreadDeleted.
on("chatThreadPropertiesUpdated", (e: ChatThreadPropertiesUpdatedEvent) => void)	Função Subscrever para chatThreadPropertiesUpdated.
on("participantsAdded", (e: ParticipantsAddedEvent) => void)	Subscreva a função para participantesAdded.
on("participantsRemoved", (e: ParticipantsRemovedEvent) => void)	Subscreva a função para participantesRemoved.
on("readReceiptReceived", (e: ReadReceiptReceivedEvent) => void)	Subscrever função para readReceiptReceived.
on("realTimeNotificationConnected", () => void)	Função Subscribe para realTimeNotificationConnected.
on("realTimeNotificationDisconnected", () => void)	Função Subscribe para realTimeNotificationDisconnected.
on("typingIndicatorReceived", (e: TypingIndicatorReceivedEvent) => void)	Subscrever função para escreverIndicatorReceived. O remetente inicial também receberá este evento.
startRealtimeNotifications()	Comece a receber notificações em tempo real. Chame esta função antes de subscrever qualquer evento.
stopRealtimeNotifications()	Pare de receber notificações em tempo real. Esta função anularia a subscrição de todos os eventos.

Detalhes do Construtor

ChatClient(string, CommunicationTokenCredential, ChatClientOptions)

Cria uma instância do ChatClient para um determinado recurso e utilizador.

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

Parâmetros

endpoint

string

O URL do recurso dos Serviços de Comunicação.

credential

CommunicationTokenCredential

A credencial do token. Utilize o AzureCommunicationTokenCredential @azure/communication-common para criar uma credencial.

options

ChatClientOptions

Opções de cliente adicionais.

Detalhes de Método

createChatThread(CreateChatThreadRequest, CreateChatThreadOptions)

Cria um tópico de chat. Devolve o cliente de thread com o ID do thread criado.

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

Parâmetros

request

CreateChatThreadRequest

Pedido para criar um tópico de chat.

options

CreateChatThreadOptions

Opções de operação.

Devoluções

Promise<CreateChatThreadResult>

deleteChatThread(string, OperationOptions)

Elimina um tópico de chat.

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

Parâmetros

threadId

string

O ID do thread a eliminar.

options

OperationOptions

Opções de operação.

Devoluções

Promise<void>

getChatThreadClient(string)

Devolve ChatThreadClient com o ID de thread específico.

function getChatThreadClient(threadId: string): ChatThreadClient

Parâmetros

threadId

string

ID do Thread do ChatThreadClient

Devoluções

ChatThreadClient

listChatThreads(RestListChatThreadsOptions)

Obtém a lista de tópicos de chat de um utilizador.

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

Parâmetros

options

RestListChatThreadsOptions

Listar opções de tópicos de chat.

Devoluções

PagedAsyncIterableIterator<ChatThreadItem, ChatThreadItem[], PageSettings>

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

Anular a subscrição do chatMessageDeleted.

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

Parâmetros

event

"chatMessageDeleted"

O ChatMessageDeletedEvent.

listener

(e: ChatMessageDeletedEvent) => void

O serviço de escuta para processar o evento.

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

Anular a subscrição do chatMessageEdited.

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

Parâmetros

event

"chatMessageEdited"

O ChatMessageEditedEvent.

listener

(e: ChatMessageEditedEvent) => void

O serviço de escuta para processar o evento.

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

Anular a subscrição do chatMessageReceived.

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

Parâmetros

event

"chatMessageReceived"

O ChatMessageReceivedEvent.

listener

(e: ChatMessageReceivedEvent) => void

O serviço de escuta para processar o evento.

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

Anular a subscrição do chatThreadCreated.

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

Parâmetros

event

"chatThreadCreated"

O ChatThreadCreatedEvent.

listener

(e: ChatThreadCreatedEvent) => void

O serviço de escuta para processar o evento.

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

Anule a subscrição do chatThreadDeleted.

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

Parâmetros

event

"chatThreadDeleted"

O ChatThreadDeletedEvent.

listener

(e: ChatThreadDeletedEvent) => void

O serviço de escuta para processar o evento.

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

Anular a subscrição de chatThreadPropertiesUpdated.

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

Parâmetros

event

"chatThreadPropertiesUpdated"

O ChatThreadPropertiesUpdatedEvent.

listener

(e: ChatThreadPropertiesUpdatedEvent) => void

O serviço de escuta para processar o evento.

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

Anular a subscrição dos participantesAdded.

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

Parâmetros

event

"participantsAdded"

O ParticipantsAddedEvent.

listener

(e: ParticipantsAddedEvent) => void

O serviço de escuta para processar o evento.

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

Anular a subscrição dos participantesRemoved.

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

Parâmetros

event

"participantsRemoved"

The ParticipantsRemovedEvent.

listener

(e: ParticipantsRemovedEvent) => void

O serviço de escuta para processar o evento.

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

Anule a subscrição de readReceiptReceived.

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

Parâmetros

event

"readReceiptReceived"

O ReadReceiptReceivedEvent.

listener

(e: ReadReceiptReceivedEvent) => void

O serviço de escuta para processar o evento.

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

Anule a subscrição de typingIndicatorReceived.

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

Parâmetros

event

"typingIndicatorReceived"

O TypingIndicatorReceivedEvent.

listener

(e: TypingIndicatorReceivedEvent) => void

O serviço de escuta para processar o evento.

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

Subscreva a função para chatMessageDeleted. O remetente inicial também receberá este evento.

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

Parâmetros

event

"chatMessageDeleted"

O ChatMessageDeletedEvent.

listener

(e: ChatMessageDeletedEvent) => void

O serviço de escuta para processar o evento.

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

Subscreva a função para chatMessageEdited. O remetente inicial também receberá este evento.

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

Parâmetros

event

"chatMessageEdited"

O ChatMessageEditedEvent.

listener

(e: ChatMessageEditedEvent) => void

O serviço de escuta para processar o evento.

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

Subscreva a função para chatMessageReceived. O remetente inicial também receberá este evento. Tem de chamar startRealtimeNotifications antes de subscrever qualquer evento.

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

Parâmetros

event

"chatMessageReceived"

O ChatMessageReceivedEvent.

listener

(e: ChatMessageReceivedEvent) => void

O serviço de escuta para processar o evento.

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

Subscreva a função para chatThreadCreated.

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

Parâmetros

event

"chatThreadCreated"

O ChatThreadCreatedEvent.

listener

(e: ChatThreadCreatedEvent) => void

O serviço de escuta para processar o evento.

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

Subscreva a função para chatThreadDeleted.

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

Parâmetros

event

"chatThreadDeleted"

O ChatThreadDeletedEvent.

listener

(e: ChatThreadDeletedEvent) => void

O serviço de escuta para processar o evento.

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

Função Subscrever para chatThreadPropertiesUpdated.

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

Parâmetros

event

"chatThreadPropertiesUpdated"

O ChatThreadPropertiesUpdatedEvent.

listener

(e: ChatThreadPropertiesUpdatedEvent) => void

O serviço de escuta para processar o evento.

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

Subscreva a função para participantesAdded.

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

Parâmetros

event

"participantsAdded"

O ParticipantsAddedEvent.

listener

(e: ParticipantsAddedEvent) => void

O serviço de escuta para processar o evento.

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

Subscreva a função para participantesRemoved.

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

Parâmetros

event

"participantsRemoved"

The ParticipantsRemovedEvent.

listener

(e: ParticipantsRemovedEvent) => void

O serviço de escuta para processar o evento.

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

Subscrever função para readReceiptReceived.

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

Parâmetros

event

"readReceiptReceived"

O ReadReceiptReceivedEvent.

listener

(e: ReadReceiptReceivedEvent) => void

O serviço de escuta para processar o evento.

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

Função Subscribe para realTimeNotificationConnected.

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

Parâmetros

event

"realTimeNotificationConnected"

O Evento realTimeNotificationConnected

listener

() => void

O serviço de escuta para processar o evento.

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

Função Subscribe para realTimeNotificationDisconnected.

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

Parâmetros

event

"realTimeNotificationDisconnected"

O Evento realTimeNotificationDisconnected

listener

() => void

O serviço de escuta para processar o evento.

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

Subscrever função para escreverIndicatorReceived. O remetente inicial também receberá este evento.

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

Parâmetros

event

"typingIndicatorReceived"

O TypingIndicatorReceivedEvent.

listener

(e: TypingIndicatorReceivedEvent) => void

O serviço de escuta para processar o evento.

startRealtimeNotifications()

Comece a receber notificações em tempo real. Chame esta função antes de subscrever qualquer evento.

function startRealtimeNotifications(): Promise<void>

Devoluções

Promise<void>

stopRealtimeNotifications()

Pare de receber notificações em tempo real. Esta função anularia a subscrição de todos os eventos.

function stopRealtimeNotifications(): Promise<void>

Devoluções

Promise<void>