StatefulChatClient interface

Pacote:

@azure/communication-react

Define os métodos que permitem que {@Link @azure/communication-chat#ChatClient} sejam usados com um estado gerado centralizado.

A interface fornece acesso ao estado com proxie e também permite registrar um manipulador para eventos de alteração de estado.

Extends

ChatClient

Métodos

dispose()	Limpa o cache de recursos do cliente de thread de chat.
downloadResourceToCache(string, string, string)	Baixa um recurso para uma mensagem específica e o armazena em cache.
getState()	Mantém todo o estado que poderíamos proxy de ChatClient {@Link @azure/communication-chat#ChatClient} como ChatClientState {@Link ChatClientState}.
offStateChange((state: ChatClientState) => void)	Permite o cancelamento do registro de eventos 'stateChanged'.
onStateChange((state: ChatClientState) => void)	Permite que um manipulador seja registrado para eventos 'stateChanged'.
removeResourceFromCache(string, string, string)	Remove um recurso do cache para uma mensagem específica.

Métodos herdados

createChatThread(CreateChatThreadRequest, CreateChatThreadOptions)	Cria um thread de chat. Retorna o cliente thread com a ID do thread criado.
deleteChatThread(string, OperationOptions)	Exclui um thread de chat.
getChatThreadClient(string)	Retorna ChatThreadClient com a ID de thread específica.
listChatThreads(ChatListChatThreadsOptionalParams)	Obtém a lista de threads de chat de um usuário.
off("chatMessageDeleted", (e: ChatMessageDeletedEvent) => void)	Cancelar a assinatura do chatMessageDeleted.
off("chatMessageEdited", (e: ChatMessageEditedEvent) => void)	Cancelar a assinatura do chatMessageEdited.
off("chatMessageReceived", (e: ChatMessageReceivedEvent) => void)	Cancelar a assinatura do chatMessageReceived.
off("chatThreadCreated", (e: ChatThreadCreatedEvent) => void)	Cancelar a assinatura do chatThreadCreated.
off("chatThreadDeleted", (e: ChatThreadDeletedEvent) => void)	Cancelar a assinatura do chatThreadDeleted.
off("chatThreadPropertiesUpdated", (e: ChatThreadPropertiesUpdatedEvent) => void)	Cancelar a assinatura do chatThreadPropertiesUpdated.
off("participantsAdded", (e: ParticipantsAddedEvent) => void)	Cancelar a assinatura dos participantes Adicionados.
off("participantsRemoved", (e: ParticipantsRemovedEvent) => void)	Cancelar a assinatura dos participantesRemoved.
off("readReceiptReceived", (e: ReadReceiptReceivedEvent) => void)	Cancelar a assinatura de readReceiptReceived.
off("typingIndicatorReceived", (e: TypingIndicatorReceivedEvent) => void)	Cancelar a assinatura de digitarIndicatorReceived.
on("chatMessageDeleted", (e: ChatMessageDeletedEvent) => void)	Função de assinatura para chatMessageDeleted. O remetente inicial também receberá esse evento.
on("chatMessageEdited", (e: ChatMessageEditedEvent) => void)	Função de assinatura para chatMessageEdited. O remetente inicial também receberá esse evento.
on("chatMessageReceived", (e: ChatMessageReceivedEvent) => void)	Função de assinatura para chatMessageReceived. O remetente inicial também receberá esse evento. Você precisa chamar startRealtimeNotifications antes de assinar qualquer evento.
on("chatThreadCreated", (e: ChatThreadCreatedEvent) => void)	Função Subscribe para chatThreadCreated.
on("chatThreadDeleted", (e: ChatThreadDeletedEvent) => void)	Função de assinatura para chatThreadDeleted.
on("chatThreadPropertiesUpdated", (e: ChatThreadPropertiesUpdatedEvent) => void)	Função Subscribe para chatThreadPropertiesUpdated.
on("participantsAdded", (e: ParticipantsAddedEvent) => void)	Função Assinar para participantes Adicionados.
on("participantsRemoved", (e: ParticipantsRemovedEvent) => void)	Função de assinatura para participantesRemoved.
on("readReceiptReceived", (e: ReadReceiptReceivedEvent) => void)	Função de assinatura para readReceiptReceived.
on("realTimeNotificationConnected", () => void)	Função Subscribe para realTimeNotificationConnected.
on("realTimeNotificationDisconnected", () => void)	Função Subscribe para realTimeNotificationDisconnected.
on("typingIndicatorReceived", (e: TypingIndicatorReceivedEvent) => void)	Função de assinatura para digitarIndicatorReceived. O remetente inicial também receberá esse evento.
startRealtimeNotifications()	Comece a receber notificações em tempo real. Chame essa função antes de assinar qualquer evento.
stopRealtimeNotifications()	Pare de receber notificações em tempo real. Essa função cancelaria a assinatura de todos os eventos.

Detalhes do método

dispose()

Limpa o cache de recursos do cliente de thread de chat.

function dispose()

downloadResourceToCache(string, string, string)

Baixa um recurso para uma mensagem específica e o armazena em cache.

function downloadResourceToCache(threadId: string, messageId: string, resourceUrl: string)

Parâmetros

threadId

string

A ID do thread do thread de chat.

messageId

string

O ID da mensagem de chat.

resourceUrl

string

A URL do recurso a ser buscada e armazenada em cache.

getState()

Mantém todo o estado que poderíamos proxy de ChatClient {@Link @azure/communication-chat#ChatClient} como ChatClientState {@Link ChatClientState}.

function getState(): ChatClientState

Retornos

ChatClientState

offStateChange((state: ChatClientState) => void)

Permite o cancelamento do registro de eventos 'stateChanged'.

function offStateChange(handler: (state: ChatClientState) => void)

Parâmetros

handler

(state: ChatClientState) => void

Retorno de chamada original a ser cancelado.

onStateChange((state: ChatClientState) => void)

Permite que um manipulador seja registrado para eventos 'stateChanged'.

function onStateChange(handler: (state: ChatClientState) => void)

Parâmetros

handler

(state: ChatClientState) => void

Retorno de chamada para receber o estado.

removeResourceFromCache(string, string, string)

Remove um recurso do cache para uma mensagem específica.

function removeResourceFromCache(threadId: string, messageId: string, resourceUrl: string)

Parâmetros

threadId

string

A ID do thread do thread de chat.

messageId

string

O ID da mensagem de chat.

resourceUrl

string

A URL do recurso a ser removida do cache.

Detalhes do método herdado

createChatThread(CreateChatThreadRequest, CreateChatThreadOptions)

Cria um thread de chat. Retorna o cliente thread com a ID do thread criado.

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

Parâmetros

request

CreateChatThreadRequest

Solicitação para criar um thread de chat.

options

CreateChatThreadOptions

Opções de operação.

Retornos

Promise<CreateChatThreadResult>

herdado de ChatClient.createChatThread

deleteChatThread(string, OperationOptions)

Exclui um thread de chat.

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

Parâmetros

threadId

string

A ID do thread a ser excluído.

options

OperationOptions

Opções de operação.

Retornos

Promise<void>

herdado de ChatClient.deleteChatThread

getChatThreadClient(string)

Retorna ChatThreadClient com a ID de thread específica.

function getChatThreadClient(threadId: string): ChatThreadClient

Parâmetros

threadId

string

ID do thread para o ChatThreadClient

Retornos

ChatThreadClient

herdado de ChatClient.getChatThreadClient

listChatThreads(ChatListChatThreadsOptionalParams)

Obtém a lista de threads de chat de um usuário.

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

Parâmetros

options

@azure/communication-chat.ChatListChatThreadsOptionalParams

Listar opções de threads de chat.

Retornos

PagedAsyncIterableIterator<ChatThreadItem, ChatThreadItem[], PageSettings>

herdado de ChatClient.listChatThreads

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

Cancelar a assinatura do chatMessageDeleted.

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

Parâmetros

event

"chatMessageDeleted"

O ChatMessageDeletedEvent.

listener

(e: ChatMessageDeletedEvent) => void

O ouvinte para lidar com o evento.

herdado de ChatClient.off

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

Cancelar a assinatura do chatMessageEdited.

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

Parâmetros

event

"chatMessageEdited"

O ChatMessageEditedEvent.

listener

(e: ChatMessageEditedEvent) => void

O ouvinte para lidar com o evento.

herdado de ChatClient.off

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

Cancelar a assinatura do chatMessageReceived.

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

Parâmetros

event

"chatMessageReceived"

O ChatMessageReceivedEvent.

listener

(e: ChatMessageReceivedEvent) => void

O ouvinte para lidar com o evento.

herdado de ChatClient.off

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

Cancelar a assinatura do chatThreadCreated.

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

Parâmetros

event

"chatThreadCreated"

O ChatThreadCreatedEvent.

listener

(e: ChatThreadCreatedEvent) => void

O ouvinte para lidar com o evento.

herdado de ChatClient.off

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

Cancelar a assinatura do chatThreadDeleted.

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

Parâmetros

event

"chatThreadDeleted"

O ChatThreadDeletedEvent.

listener

(e: ChatThreadDeletedEvent) => void

O ouvinte para lidar com o evento.

herdado de ChatClient.off

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

Cancelar a assinatura do chatThreadPropertiesUpdated.

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

Parâmetros

event

"chatThreadPropertiesUpdated"

O ChatThreadPropertiesUpdatedEvent.

listener

(e: ChatThreadPropertiesUpdatedEvent) => void

O ouvinte para lidar com o evento.

herdado de ChatClient.off

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

Cancelar a assinatura dos participantes Adicionados.

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

Parâmetros

event

"participantsAdded"

O ParticipantsAddedEvent.

listener

(e: ParticipantsAddedEvent) => void

O ouvinte para lidar com o evento.

herdado de ChatClient.off

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

Cancelar a assinatura dos participantesRemoved.

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

Parâmetros

event

"participantsRemoved"

O ParticipantsRemovedEvent.

listener

(e: ParticipantsRemovedEvent) => void

O ouvinte para lidar com o evento.

herdado de ChatClient.off

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

Cancelar a assinatura de readReceiptReceived.

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

Parâmetros

event

"readReceiptReceived"

O ReadReceiptReceivedEvent.

listener

(e: ReadReceiptReceivedEvent) => void

O ouvinte para lidar com o evento.

herdado de ChatClient.off

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

Cancelar a assinatura de digitarIndicatorReceived.

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

Parâmetros

event

"typingIndicatorReceived"

O TypingIndicatorReceivedEvent.

listener

(e: TypingIndicatorReceivedEvent) => void

O ouvinte para lidar com o evento.

herdado de ChatClient.off

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

Função de assinatura para chatMessageDeleted. O remetente inicial também receberá esse evento.

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

Parâmetros

event

"chatMessageDeleted"

O ChatMessageDeletedEvent.

listener

(e: ChatMessageDeletedEvent) => void

O ouvinte para lidar com o evento.

herdado de ChatClient.on

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

Função de assinatura para chatMessageEdited. O remetente inicial também receberá esse evento.

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

Parâmetros

event

"chatMessageEdited"

O ChatMessageEditedEvent.

listener

(e: ChatMessageEditedEvent) => void

O ouvinte para lidar com o evento.

herdado de ChatClient.on

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

Função de assinatura para chatMessageReceived. O remetente inicial também receberá esse evento. Você precisa chamar startRealtimeNotifications antes de assinar qualquer evento.

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

Parâmetros

event

"chatMessageReceived"

O ChatMessageReceivedEvent.

listener

(e: ChatMessageReceivedEvent) => void

O ouvinte para lidar com o evento.

herdado de ChatClient.on

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

Função Subscribe para chatThreadCreated.

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

Parâmetros

event

"chatThreadCreated"

O ChatThreadCreatedEvent.

listener

(e: ChatThreadCreatedEvent) => void

O ouvinte para lidar com o evento.

herdado de ChatClient.on

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

Função de assinatura para chatThreadDeleted.

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

Parâmetros

event

"chatThreadDeleted"

O ChatThreadDeletedEvent.

listener

(e: ChatThreadDeletedEvent) => void

O ouvinte para lidar com o evento.

herdado de ChatClient.on

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

Função Subscribe para chatThreadPropertiesUpdated.

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

Parâmetros

event

"chatThreadPropertiesUpdated"

O ChatThreadPropertiesUpdatedEvent.

listener

(e: ChatThreadPropertiesUpdatedEvent) => void

O ouvinte para lidar com o evento.

herdado de ChatClient.on

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

Função Assinar para participantes Adicionados.

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

Parâmetros

event

"participantsAdded"

O ParticipantsAddedEvent.

listener

(e: ParticipantsAddedEvent) => void

O ouvinte para lidar com o evento.

herdado de ChatClient.on

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

Função de assinatura para participantesRemoved.

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

Parâmetros

event

"participantsRemoved"

O ParticipantsRemovedEvent.

listener

(e: ParticipantsRemovedEvent) => void

O ouvinte para lidar com o evento.

herdado de ChatClient.on

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

Função de assinatura para readReceiptReceived.

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

Parâmetros

event

"readReceiptReceived"

O ReadReceiptReceivedEvent.

listener

(e: ReadReceiptReceivedEvent) => void

O ouvinte para lidar com o evento.

herdado de ChatClient.on

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

Função Subscribe para realTimeNotificationConnected.

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

Parâmetros

event

"realTimeNotificationConnected"

O evento realTimeNotificationConnected

listener

() => void

O ouvinte para lidar com o evento.

herdado de ChatClient.on

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

Função Subscribe para realTimeNotificationDisconnected.

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

Parâmetros

event

"realTimeNotificationDisconnected"

O evento realTimeNotificationDisconnected

listener

() => void

O ouvinte para lidar com o evento.

herdado de ChatClient.on

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

Função de assinatura para digitarIndicatorReceived. O remetente inicial também receberá esse evento.

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

Parâmetros

event

"typingIndicatorReceived"

O TypingIndicatorReceivedEvent.

listener

(e: TypingIndicatorReceivedEvent) => void

O ouvinte para lidar com o evento.

herdado de ChatClient.on

startRealtimeNotifications()

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

function startRealtimeNotifications(): Promise<void>

Retornos

Promise<void>

Herdado de ChatClient.startRealtimeNotifications

stopRealtimeNotifications()

Pare de receber notificações em tempo real. Essa função cancelaria a assinatura de todos os eventos.

function stopRealtimeNotifications(): Promise<void>

Retornos

Promise<void>

Herdado de ChatClient.stopRealtimeNotifications