ChatClient class

Pakket:

@azure/communication-chat

De client om chatbewerkingen uit te voeren

Constructors

ChatClient(string, CommunicationTokenCredential, ChatClientOptions)

Hiermee maakt u een exemplaar van de ChatClient voor een bepaalde resource en gebruiker.

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.

Constructordetails

ChatClient(string, CommunicationTokenCredential, ChatClientOptions)

Hiermee maakt u een exemplaar van de ChatClient voor een bepaalde resource en gebruiker.

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

Parameters

endpoint

string

De URL van de Communication Services-resource.

credential

CommunicationTokenCredential

De tokenreferentie. Gebruik AzureCommunicationTokenCredential van @azure/communication-common om een referentie te maken.

options

ChatClientOptions

Aanvullende clientopties.

Methodedetails

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>

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>

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

listChatThreads(ChatListChatThreadsOptionalParams)

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

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

Parameters

options

RestListChatThreadsOptions

Opties voor chatthreads weergeven.

Retouren

PagedAsyncIterableIterator<ChatThreadItem, ChatThreadItem[], PageSettings>

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.

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.

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.

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.

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.

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.

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.

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.

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.

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.

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.

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.

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.

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.

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.

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.

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.

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.

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.

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.

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.

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.

startRealtimeNotifications()

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

function startRealtimeNotifications(): Promise<void>

Retouren

Promise<void>

stopRealtimeNotifications()

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

function stopRealtimeNotifications(): Promise<void>

Retouren

Promise<void>