StatefulChatClient interface

Innehåller alla tillstånd som vi kan proxy från ChatClient {@Link @azure/communication-chat#ChatClient} som ChatClientState {@Link ChatClientState}.

function getState(): ChatClientState

Returer

Tillåter avregistrering för "stateChanged"-händelser.

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

Parametrar

Tillåter att en hanterare registreras för "stateChanged"-händelser.

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

Parametrar

Skapar en chatttråd. Returnerar trådklienten med ID:t för den skapade tråden.

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

Parametrar

Returer

Ärvd från ChatClient.createChatThread

Tar bort en chatttråd.

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

Parametrar

Returer

Ärvd från ChatClient.deleteChatThread

Returnerar ChatThreadClient med det specifika tråd-ID:t.

function getChatThreadClient(threadId: string): ChatThreadClient

Parametrar

Returer

Ärvd från ChatClient.getChatThreadClient

Hämtar listan över chatttrådar för en användare.

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

Parametrar

Returer

Ärvd från ChatClient.listChatThreads

Avbryt prenumerationen på chatMessageDeleted.

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

Parametrar

Ärvd från ChatClient.off

Avbryt prenumerationen på chatMessageEdited.

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

Parametrar

Ärvd från ChatClient.off

Avbryt prenumerationen på chatMessageReceived.

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

Parametrar

Ärvd från ChatClient.off

Avbryt prenumerationen på chatThreadCreated.

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

Parametrar

Ärvd från ChatClient.off

Avbryt prenumerationen på chatThreadDeleted.

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

Parametrar

Ärvd från ChatClient.off

Avbryt prenumerationen på chatThreadPropertiesUppdaterat.

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

Parametrar

Ärvd från ChatClient.off

Avsluta prenumerationen på deltagareLägg till.

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

Parametrar

Ärvd från ChatClient.off

Avsluta prenumerationen på deltagareRemoved.

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

Parametrar

Ärvd från ChatClient.off

Avbryt prenumerationen på readReceiptReceived.

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

Parametrar

Ärvd från ChatClient.off

Avsluta prenumerationen från att skrivaIndicatorReceived.

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

Parametrar

Ärvd från ChatClient.off

Funktionen Subscribe för chatMessageDeleted. Den första avsändaren tar också emot händelsen.

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

Parametrar

Ärvd från ChatClient.on

Funktionen Subscribe för chatMessageEdited. Den första avsändaren tar också emot händelsen.

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

Parametrar

Ärvd från ChatClient.on

Funktionen Subscribe för chatMessageReceived. Den första avsändaren tar också emot händelsen. Du måste anropa startRealtimeNotifications innan du prenumererar på en händelse.

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

Parametrar

Ärvd från ChatClient.on

Prenumerationsfunktionen för chatThreadCreated.

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

Parametrar

Ärvd från ChatClient.on

Prenumerationsfunktion för chatThreadDeleted.

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

Parametrar

Ärvd från ChatClient.on

Funktionen Subscribe för chatThreadPropertiesUpdated.

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

Parametrar

Ärvd från ChatClient.on

Prenumerationsfunktion för deltagareLägg till.

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

Parametrar

Ärvd från ChatClient.on

Prenumerationsfunktionen för deltagareRemoved.

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

Parametrar

Ärvd från ChatClient.on

Funktionen Subscribe för readReceiptReceived.

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

Parametrar

Ärvd från ChatClient.on

Funktionen Subscribe för realTimeNotificationConnected.

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

Parametrar

Ärvd från ChatClient.on

Funktionen Subscribe för realTimeNotificationDisconnected.

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

Parametrar

Ärvd från ChatClient.on

Funktionen Subscribe för att skrivaIndicatorReceived. Den första avsändaren tar också emot händelsen.

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

Parametrar

Ärvd från ChatClient.on

Börja få meddelanden i realtid. Anropa den här funktionen innan du prenumererar på någon händelse.

function startRealtimeNotifications(): Promise<void>

Returer

Ärvd från ChatClient.startRealtimeNotifications

Sluta ta emot meddelanden i realtid. Den här funktionen skulle avbryta prenumerationen på alla händelser.

function stopRealtimeNotifications(): Promise<void>

Returer

Ärvd från ChatClient.stopRealtimeNotifications