StatefulChatClient interface

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

function getState(): ChatClientState

Retornos

Permite o cancelamento do registro de eventos 'stateChanged'.

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

Parâmetros

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

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

Parâmetros

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

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

Parâmetros

Retornos

Herdado de ChatClient.createChatThread

Exclui uma conversa de chat.

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

Parâmetros

Retornos

Herdado de ChatClient.deleteChatThread

Retorna ChatThreadClient com a ID de thread específica.

function getChatThreadClient(threadId: string): ChatThreadClient

Parâmetros

Retornos

Herdado de ChatClient.getChatThreadClient

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

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

Parâmetros

Retornos

Herdado de ChatClient.listChatThreads

Cancelar a assinatura do chatMessageDeleted.

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

Parâmetros

Herdado de ChatClient.off

Cancelar a assinatura do chatMessageEdited.

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

Parâmetros

Herdado de ChatClient.off

Cancelar a assinatura do chatMessageReceived.

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

Parâmetros

Herdado de ChatClient.off

Cancelar a assinatura do chatThreadCreated.

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

Parâmetros

Herdado de ChatClient.off

Cancelar a assinatura do chatThreadDeleted.

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

Parâmetros

Herdado de ChatClient.off

Cancelar a assinatura do chatThreadPropertiesUpdated.

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

Parâmetros

Herdado de ChatClient.off

Cancelar assinatura dos participantes Adicionados.

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

Parâmetros

Herdado de ChatClient.off

Cancelar a assinatura dos participantesRemoved.

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

Parâmetros

Herdado de ChatClient.off

Cancelar a assinatura de readReceiptReceived.

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

Parâmetros

Herdado de ChatClient.off

Cancele a assinatura da digitaçãoIndicatorReceived.

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

Parâmetros

Herdado de ChatClient.off

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

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

Parâmetros

Herdado de ChatClient.on

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

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

Parâmetros

Herdado de ChatClient.on

Função Subscribe 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

Herdado de ChatClient.on

Função Subscribe para chatThreadCreated.

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

Parâmetros

Herdado de ChatClient.on

Função Subscribe para chatThreadDeleted.

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

Parâmetros

Herdado de ChatClient.on

Função Subscribe para chatThreadPropertiesUpdated.

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

Parâmetros

Herdado de ChatClient.on

Função de assinatura para participantes Adicionada.

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

Parâmetros

Herdado de ChatClient.on

Função Subscribe para participantesRemoved.

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

Parâmetros

Herdado de ChatClient.on

Função Subscribe para readReceiptReceived.

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

Parâmetros

Herdado de ChatClient.on

Função Subscribe para realTimeNotificationConnected.

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

Parâmetros

Herdado de ChatClient.on

Função Subscribe para realTimeNotificationDisconnected.

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

Parâmetros

Herdado de ChatClient.on

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

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

Parâmetros

Herdado de ChatClient.on

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

function startRealtimeNotifications(): Promise<void>

Retornos

Herdado de ChatClient.startRealtimeNotifications

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

function stopRealtimeNotifications(): Promise<void>

Retornos

Herdado de ChatClient.stopRealtimeNotifications