StatefulChatClient interface

Pakket:

@azure/communication-react

Definieert de methoden waarmee {@Link @azure/communication-chat#ChatClient} kan worden gebruikt met een gecentraliseerde gegenereerde status.

De interface biedt toegang tot de geproxieerde status en maakt het registreren van een handler mogelijk voor statuswijzigingsgebeurtenissen.

Uitbreiding

ChatClient

Methoden

dispose()	Hiermee wordt de broncache van de chatthreadclient opgeschoond.
downloadResourceToCache(string, string, string)	Downloadt een bron voor een specifiek bericht en slaat deze in de cache op.
getState()	Bevat alle statussen die we kunnen proxyn vanuit ChatClient {@Link @azure/communication-chat#ChatClient} als ChatClientState {@Link ChatClientState}.
offStateChange((state: ChatClientState) => void)	Hiermee staat u de registratie van 'stateChanged'-gebeurtenissen toe.
onStateChange((state: ChatClientState) => void)	Hiermee kan een handler worden geregistreerd voor stateChanged-gebeurtenissen.
removeResourceFromCache(string, string, string)	Hiermee verwijdert u een bron uit de cache voor een specifiek bericht.

Overgenomen methoden

createChatThread(CreateChatThreadRequest, CreateChatThreadOptions)	Hiermee maakt u een chat-thread. Retourneert de threadclient met de id van de gemaakte thread.
deleteChatThread(string, OperationOptions)	Hiermee verwijdert u een chatgesprek.
getChatThreadClient(string)	Hiermee wordt ChatThreadClient geretourneerd met de specifieke thread-id.
listChatThreads(ChatListChatThreadsOptionalParams)	Hiermee haalt u de lijst met chatthreads van een gebruiker op.
off("chatMessageDeleted", (e: ChatMessageDeletedEvent) => void)	Afmelden voor chatMessageDeleted.
off("chatMessageEdited", (e: ChatMessageEditedEvent) => void)	Afmelden bij chatMessageEdited.
off("chatMessageReceived", (e: ChatMessageReceivedEvent) => void)	Afmelden voor chatMessageReceived.
off("chatThreadCreated", (e: ChatThreadCreatedEvent) => void)	Afmelden voor chatThreadCreated.
off("chatThreadDeleted", (e: ChatThreadDeletedEvent) => void)	Afmelden voor chatThreadDeleted.
off("chatThreadPropertiesUpdated", (e: ChatThreadPropertiesUpdatedEvent) => void)	Afmelden voor chatThreadPropertiesUpdated.
off("participantsAdded", (e: ParticipantsAddedEvent) => void)	Afmelden voor deelnemersToevoegen.
off("participantsRemoved", (e: ParticipantsRemovedEvent) => void)	Afmelden voor deelnemers Die zijn verplaatst.
off("readReceiptReceived", (e: ReadReceiptReceivedEvent) => void)	Afmelden voor readReceiptReceived.
off("typingIndicatorReceived", (e: TypingIndicatorReceivedEvent) => void)	Afmelden voor typeIndicatorReceived.
on("chatMessageDeleted", (e: ChatMessageDeletedEvent) => void)	Abonneer de functie voor chatMessageDeleted. De initiële afzender ontvangt deze gebeurtenis ook.
on("chatMessageEdited", (e: ChatMessageEditedEvent) => void)	Abonneer de functie voor chatMessageEdited. De initiële afzender ontvangt deze gebeurtenis ook.
on("chatMessageReceived", (e: ChatMessageReceivedEvent) => void)	Abonneer de functie voor chatMessageReceived. De initiële afzender ontvangt deze gebeurtenis ook. U moet startRealtimeNotifications aanroepen voordat u zich abonneert op een gebeurtenis.
on("chatThreadCreated", (e: ChatThreadCreatedEvent) => void)	Abonneer de functie voor chatThreadCreated.
on("chatThreadDeleted", (e: ChatThreadDeletedEvent) => void)	Abonneer de functie voor chatThreadDeleted.
on("chatThreadPropertiesUpdated", (e: ChatThreadPropertiesUpdatedEvent) => void)	Abonneer de functie voor chatThreadPropertiesUpdated.
on("participantsAdded", (e: ParticipantsAddedEvent) => void)	Abonneer de functie voor participantsAdded.
on("participantsRemoved", (e: ParticipantsRemovedEvent) => void)	Abonneer de functie voor deelnemers Die zijn verplaatst.
on("readReceiptReceived", (e: ReadReceiptReceivedEvent) => void)	Abonneer de functie voor readReceiptReceived.
on("realTimeNotificationConnected", () => void)	Abonneer de functie voor realTimeNotificationConnected.
on("realTimeNotificationDisconnected", () => void)	Abonneer de functie voor realTimeNotificationDisconnected.
on("typingIndicatorReceived", (e: TypingIndicatorReceivedEvent) => void)	De functie Abonneren voor typeIndicatorReceived. De initiële afzender ontvangt deze gebeurtenis ook.
startRealtimeNotifications()	Ontvang realtime meldingen. Roep deze functie aan voordat u zich abonneert op een gebeurtenis.
stopRealtimeNotifications()	Geen realtime meldingen meer ontvangen. Deze functie zou zich afmelden voor alle gebeurtenissen.

Methodedetails

dispose()

Hiermee wordt de broncache van de chatthreadclient opgeschoond.

function dispose()

downloadResourceToCache(string, string, string)

Downloadt een bron voor een specifiek bericht en slaat deze in de cache op.

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

Parameters

threadId

string

De thread-id van de chatthread.

messageId

string

De bericht-ID van het chatbericht.

resourceUrl

string

De bron-url die moet worden opgehaald en in de cache opgeslagen.

getState()

Bevat alle statussen die we kunnen proxyn vanuit ChatClient {@Link @azure/communication-chat#ChatClient} als ChatClientState {@Link ChatClientState}.

function getState(): ChatClientState

Retouren

ChatClientState

offStateChange((state: ChatClientState) => void)

Hiermee staat u de registratie van 'stateChanged'-gebeurtenissen toe.

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

Parameters

handler

(state: ChatClientState) => void

Oorspronkelijke callback die moet worden afgemeld.

onStateChange((state: ChatClientState) => void)

Hiermee kan een handler worden geregistreerd voor stateChanged-gebeurtenissen.

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

Parameters

handler

(state: ChatClientState) => void

Callback om de status te ontvangen.

removeResourceFromCache(string, string, string)

Hiermee verwijdert u een bron uit de cache voor een specifiek bericht.

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

Parameters

threadId

string

De thread-id van de chatthread.

messageId

string

De bericht-ID van het chatbericht.

resourceUrl

string

De bron-url die uit de cache moet worden verwijderd.

Details overgenomen methode

createChatThread(CreateChatThreadRequest, CreateChatThreadOptions)

Hiermee maakt u een chat-thread. Retourneert de threadclient met de id van de gemaakte thread.

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

Parameters

request

CreateChatThreadRequest

Aanvraag voor het maken van een chatgesprek.

options

CreateChatThreadOptions

Bewerkingsopties.

Retouren

Promise<CreateChatThreadResult>

overgenomen van ChatClient.createChatThread

deleteChatThread(string, OperationOptions)

Hiermee verwijdert u een chatgesprek.

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

Parameters

threadId

string

De id van de thread die moet worden verwijderd.

options

OperationOptions

Bewerkingsopties.

Retouren

Promise<void>

overgenomen van ChatClient.deleteChatThread

getChatThreadClient(string)

Hiermee wordt ChatThreadClient geretourneerd met de specifieke thread-id.

function getChatThreadClient(threadId: string): ChatThreadClient

Parameters

threadId

string

Thread-id voor de ChatThreadClient

Retouren

ChatThreadClient

overgenomen van ChatClient.getChatThreadClient

listChatThreads(ChatListChatThreadsOptionalParams)

Hiermee haalt u de lijst met chatthreads van een gebruiker op.

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

Parameters

options

@azure/communication-chat.ChatListChatThreadsOptionalParams

Opties voor chatthreads weergeven.

Retouren

PagedAsyncIterableIterator<ChatThreadItem, ChatThreadItem[], PageSettings>

overgenomen van ChatClient.listChatThreads

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

Afmelden voor chatMessageDeleted.

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

Parameters

event

"chatMessageDeleted"

De ChatMessageDeletedEvent.

listener

(e: ChatMessageDeletedEvent) => void

De listener voor het afhandelen van de gebeurtenis.

overgenomen van ChatClient.off

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

Afmelden bij chatMessageEdited.

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

Parameters

event

"chatMessageEdited"

De ChatMessageEditedEvent.

listener

(e: ChatMessageEditedEvent) => void

De listener voor het afhandelen van de gebeurtenis.

overgenomen van ChatClient.off

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

Afmelden voor chatMessageReceived.

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

Parameters

event

"chatMessageReceived"

De ChatMessageReceivedEvent.

listener

(e: ChatMessageReceivedEvent) => void

De listener voor het afhandelen van de gebeurtenis.

overgenomen van ChatClient.off

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

Afmelden voor chatThreadCreated.

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

Parameters

event

"chatThreadCreated"

De ChatThreadCreatedEvent.

listener

(e: ChatThreadCreatedEvent) => void

De listener voor het afhandelen van de gebeurtenis.

overgenomen van ChatClient.off

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

Afmelden voor chatThreadDeleted.

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

Parameters

event

"chatThreadDeleted"

De ChatThreadDeletedEvent.

listener

(e: ChatThreadDeletedEvent) => void

De listener voor het afhandelen van de gebeurtenis.

overgenomen van ChatClient.off

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

Afmelden voor chatThreadPropertiesUpdated.

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

Parameters

event

"chatThreadPropertiesUpdated"

De ChatThreadPropertiesUpdatedEvent.

listener

(e: ChatThreadPropertiesUpdatedEvent) => void

De listener voor het afhandelen van de gebeurtenis.

overgenomen van ChatClient.off

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

Afmelden voor deelnemersToevoegen.

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

Parameters

event

"participantsAdded"

De ParticipantsAddedEvent.

listener

(e: ParticipantsAddedEvent) => void

De listener voor het afhandelen van de gebeurtenis.

overgenomen van ChatClient.off

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

Afmelden voor deelnemers Die zijn verplaatst.

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

Parameters

event

"participantsRemoved"

De ParticipantsRemovedEvent.

listener

(e: ParticipantsRemovedEvent) => void

De listener voor het afhandelen van de gebeurtenis.

overgenomen van ChatClient.off

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

Afmelden voor readReceiptReceived.

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

Parameters

event

"readReceiptReceived"

De ReadReceiptReceivedEvent.

listener

(e: ReadReceiptReceivedEvent) => void

De listener voor het afhandelen van de gebeurtenis.

overgenomen van ChatClient.off

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

Afmelden voor typeIndicatorReceived.

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

Parameters

event

"typingIndicatorReceived"

De TypeIndicatorReceivedEvent.

listener

(e: TypingIndicatorReceivedEvent) => void

De listener voor het afhandelen van de gebeurtenis.

overgenomen van ChatClient.off

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

Abonneer de functie voor chatMessageDeleted. De initiële afzender ontvangt deze gebeurtenis ook.

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

Parameters

event

"chatMessageDeleted"

De ChatMessageDeletedEvent.

listener

(e: ChatMessageDeletedEvent) => void

De listener voor het afhandelen van de gebeurtenis.

overgenomen van ChatClient.on

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

Abonneer de functie voor chatMessageEdited. De initiële afzender ontvangt deze gebeurtenis ook.

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

Parameters

event

"chatMessageEdited"

De ChatMessageEditedEvent.

listener

(e: ChatMessageEditedEvent) => void

De listener voor het afhandelen van de gebeurtenis.

overgenomen van ChatClient.on

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

Abonneer de functie voor chatMessageReceived. De initiële afzender ontvangt deze gebeurtenis ook. U moet startRealtimeNotifications aanroepen voordat u zich abonneert op een gebeurtenis.

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

Parameters

event

"chatMessageReceived"

De ChatMessageReceivedEvent.

listener

(e: ChatMessageReceivedEvent) => void

De listener voor het afhandelen van de gebeurtenis.

overgenomen van ChatClient.on

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

Abonneer de functie voor chatThreadCreated.

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

Parameters

event

"chatThreadCreated"

De ChatThreadCreatedEvent.

listener

(e: ChatThreadCreatedEvent) => void

De listener voor het afhandelen van de gebeurtenis.

overgenomen van ChatClient.on

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

Abonneer de functie voor chatThreadDeleted.

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

Parameters

event

"chatThreadDeleted"

De ChatThreadDeletedEvent.

listener

(e: ChatThreadDeletedEvent) => void

De listener voor het afhandelen van de gebeurtenis.

overgenomen van ChatClient.on

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

Abonneer de functie voor chatThreadPropertiesUpdated.

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

Parameters

event

"chatThreadPropertiesUpdated"

De ChatThreadPropertiesUpdatedEvent.

listener

(e: ChatThreadPropertiesUpdatedEvent) => void

De listener voor het afhandelen van de gebeurtenis.

overgenomen van ChatClient.on

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

Abonneer de functie voor participantsAdded.

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

Parameters

event

"participantsAdded"

De ParticipantsAddedEvent.

listener

(e: ParticipantsAddedEvent) => void

De listener voor het afhandelen van de gebeurtenis.

overgenomen van ChatClient.on

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

Abonneer de functie voor deelnemers Die zijn verplaatst.

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

Parameters

event

"participantsRemoved"

De ParticipantsRemovedEvent.

listener

(e: ParticipantsRemovedEvent) => void

De listener voor het afhandelen van de gebeurtenis.

overgenomen van ChatClient.on

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

Abonneer de functie voor readReceiptReceived.

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

Parameters

event

"readReceiptReceived"

De ReadReceiptReceivedEvent.

listener

(e: ReadReceiptReceivedEvent) => void

De listener voor het afhandelen van de gebeurtenis.

overgenomen van ChatClient.on

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

Abonneer de functie voor realTimeNotificationConnected.

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

Parameters

event

"realTimeNotificationConnected"

De realTimeNotificationConnected-gebeurtenis

listener

() => void

De listener voor het afhandelen van de gebeurtenis.

overgenomen van ChatClient.on

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

Abonneer de functie voor realTimeNotificationDisconnected.

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

Parameters

event

"realTimeNotificationDisconnected"

De realTimeNotificationDisconnected-gebeurtenis

listener

() => void

De listener voor het afhandelen van de gebeurtenis.

overgenomen van ChatClient.on

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

De functie Abonneren voor typeIndicatorReceived. De initiële afzender ontvangt deze gebeurtenis ook.

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

Parameters

event

"typingIndicatorReceived"

De TypeIndicatorReceivedEvent.

listener

(e: TypingIndicatorReceivedEvent) => void

De listener voor het afhandelen van de gebeurtenis.

overgenomen van ChatClient.on

startRealtimeNotifications()

Ontvang realtime meldingen. Roep deze functie aan voordat u zich abonneert op een gebeurtenis.

function startRealtimeNotifications(): Promise<void>

Retouren

Promise<void>

overgenomen van ChatClient.startRealtimeNotifications

stopRealtimeNotifications()

Geen realtime meldingen meer ontvangen. Deze functie zou zich afmelden voor alle gebeurtenissen.

function stopRealtimeNotifications(): Promise<void>

Retouren

Promise<void>

overgenomen van ChatClient.stopRealtimeNotifications