StatefulChatClient interface

Paket:

@azure/communication-react

Definierar de metoder som gör att {@Link @azure/communication-chat#ChatClient} kan användas med ett centraliserat genererat tillstånd.

Gränssnittet ger åtkomst till proportionellt tillstånd och tillåter även registrering av en hanterare för tillståndsändringshändelser.

Extends

ChatClient

Metoder

dispose()	Rensar resurscachen från chatttrådsklienten.
downloadResourceToCache(string, string, string)	Laddar ned en resurs för ett specifikt meddelande och cachelagrar den.
getState()	Innehåller allt tillstånd som vi kan proxy från ChatClient {@Link @azure/communication-chat#ChatClient} som ChatClientState {@Link ChatClientState}.
offStateChange((state: ChatClientState) => void)	Tillåter avregistrering för "stateChanged"-händelser.
onStateChange((state: ChatClientState) => void)	Tillåter att en hanterare registreras för "stateChanged"-händelser.
removeResourceFromCache(string, string, string)	Tar bort en resurs från cacheminnet för ett visst meddelande.

Ärvda metoder

createChatThread(CreateChatThreadRequest, CreateChatThreadOptions)	Skapar en chatttråd. Returnerar trådklienten med ID:t för den skapade tråden.
deleteChatThread(string, OperationOptions)	Tar bort en chatttråd.
getChatThreadClient(string)	Returnerar ChatThreadClient med det specifika tråd-ID:t.
listChatThreads(ChatListChatThreadsOptionalParams)	Hämtar listan över chatttrådar för en användare.
off("chatMessageDeleted", (e: ChatMessageDeletedEvent) => void)	Avsluta prenumerationen på chatMessageDeleted.
off("chatMessageEdited", (e: ChatMessageEditedEvent) => void)	Avsluta prenumerationen från chatMessageEdited.
off("chatMessageReceived", (e: ChatMessageReceivedEvent) => void)	Avsluta prenumerationen från chatMessageReceived.
off("chatThreadCreated", (e: ChatThreadCreatedEvent) => void)	Avsluta prenumerationen från chattEn har skapats.
off("chatThreadDeleted", (e: ChatThreadDeletedEvent) => void)	Avsluta prenumerationen från chatThreadDeleted.
off("chatThreadPropertiesUpdated", (e: ChatThreadPropertiesUpdatedEvent) => void)	Avsluta prenumerationen från chatThreadPropertiesUppdaterad.
off("participantsAdded", (e: ParticipantsAddedEvent) => void)	Avsluta prenumerationen från deltagareLägg till.
off("participantsRemoved", (e: ParticipantsRemovedEvent) => void)	Avsluta prenumerationen från deltagarnaRemoved.
off("readReceiptReceived", (e: ReadReceiptReceivedEvent) => void)	Avsluta prenumerationen från readReceiptReceived.
off("typingIndicatorReceived", (e: TypingIndicatorReceivedEvent) => void)	Avsluta prenumerationen från att skrivaIndicatorReceived.
on("chatMessageDeleted", (e: ChatMessageDeletedEvent) => void)	Prenumerationsfunktion för chatMessageDeleted. Den första avsändaren tar också emot den här händelsen.
on("chatMessageEdited", (e: ChatMessageEditedEvent) => void)	Prenumerationsfunktion för chatMessageEdited. Den första avsändaren tar också emot den här händelsen.
on("chatMessageReceived", (e: ChatMessageReceivedEvent) => void)	Prenumerationsfunktion för chatMessageReceived. Den första avsändaren tar också emot den här händelsen. Du måste anropa startRealtimeNotifications innan du prenumererar på någon händelse.
on("chatThreadCreated", (e: ChatThreadCreatedEvent) => void)	Prenumerationsfunktion för chatThreadCreated.
on("chatThreadDeleted", (e: ChatThreadDeletedEvent) => void)	Prenumerationsfunktion för chatThreadDeleted.
on("chatThreadPropertiesUpdated", (e: ChatThreadPropertiesUpdatedEvent) => void)	Prenumerationsfunktion för chatThreadPropertiesUpdated.
on("participantsAdded", (e: ParticipantsAddedEvent) => void)	Prenumerationsfunktion för deltagareLägg till.
on("participantsRemoved", (e: ParticipantsRemovedEvent) => void)	Funktionen Prenumerera för deltagareRemoved.
on("readReceiptReceived", (e: ReadReceiptReceivedEvent) => void)	Prenumerationsfunktionen för readReceiptReceived.
on("realTimeNotificationConnected", () => void)	Prenumerationsfunktionen för realTimeNotificationConnected.
on("realTimeNotificationDisconnected", () => void)	Prenumerationsfunktionen för realTimeNotificationDisconnected.
on("typingIndicatorReceived", (e: TypingIndicatorReceivedEvent) => void)	Prenumerationsfunktion för att skrivaIndicatorReceived. Den första avsändaren tar också emot den här händelsen.
startRealtimeNotifications()	Börja ta emot realtidsaviseringar. Anropa den här funktionen innan du prenumererar på någon händelse.
stopRealtimeNotifications()	Sluta ta emot realtidsaviseringar. Den här funktionen skulle avbryta prenumerationen på alla händelser.

Metodinformation

dispose()

Rensar resurscachen från chatttrådsklienten.

function dispose()

downloadResourceToCache(string, string, string)

Laddar ned en resurs för ett specifikt meddelande och cachelagrar den.

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

Parametrar

threadId

string

Tråd-ID:t för chatttråden.

messageId

string

Meddelande-ID för chattmeddelandet.

resourceUrl

string

Resurs-URL:en som ska hämtas och cachelagras.

getState()

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

function getState(): ChatClientState

Returer

ChatClientState

offStateChange((state: ChatClientState) => void)

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

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

Parametrar

handler

(state: ChatClientState) => void

Ursprunglig återanrop som ska avbrytas.

onStateChange((state: ChatClientState) => void)

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

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

Parametrar

handler

(state: ChatClientState) => void

Återanrop för att ta emot tillståndet.

removeResourceFromCache(string, string, string)

Tar bort en resurs från cacheminnet för ett visst meddelande.

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

Parametrar

threadId

string

Tråd-ID:t för chatttråden.

messageId

string

Meddelande-ID för chattmeddelandet.

resourceUrl

string

Resurs-URL:en som ska tas bort från cachen.

Ärvd metodinformation

createChatThread(CreateChatThreadRequest, CreateChatThreadOptions)

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

request

CreateChatThreadRequest

Begäran om att skapa en chatttråd.

options

CreateChatThreadOptions

Åtgärdsalternativ.

Returer

Promise<CreateChatThreadResult>

ärvd från ChatClient.createChatThread

deleteChatThread(string, OperationOptions)

Tar bort en chatttråd.

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

Parametrar

threadId

string

ID för den tråd som ska tas bort.

options

OperationOptions

Åtgärdsalternativ.

Returer

Promise<void>

ärvd från ChatClient.deleteChatThread

getChatThreadClient(string)

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

function getChatThreadClient(threadId: string): ChatThreadClient

Parametrar

threadId

string

Tråd-ID för ChatThreadClient

Returer

ChatThreadClient

ärvd från ChatClient.getChatThreadClient

listChatThreads(ChatListChatThreadsOptionalParams)

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

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

Parametrar

options

@azure/communication-chat.ChatListChatThreadsOptionalParams

Lista alternativ för chatttrådar.

Returer

PagedAsyncIterableIterator<ChatThreadItem, ChatThreadItem[], PageSettings>

ärvd från ChatClient.listChatThreads

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

Avsluta prenumerationen på chatMessageDeleted.

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

Parametrar

event

"chatMessageDeleted"

The ChatMessageDeletedEvent.

listener

(e: ChatMessageDeletedEvent) => void

Lyssnaren för att hantera händelsen.

ärvd från ChatClient.off

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

Avsluta prenumerationen från chatMessageEdited.

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

Parametrar

event

"chatMessageEdited"

The ChatMessageEditedEvent.

listener

(e: ChatMessageEditedEvent) => void

Lyssnaren för att hantera händelsen.

ärvd från ChatClient.off

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

Avsluta prenumerationen från chatMessageReceived.

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

Parametrar

event

"chatMessageReceived"

The ChatMessageReceivedEvent.

listener

(e: ChatMessageReceivedEvent) => void

Lyssnaren för att hantera händelsen.

ärvd från ChatClient.off

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

Avsluta prenumerationen från chattEn har skapats.

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

Parametrar

event

"chatThreadCreated"

The ChatThreadCreatedEvent.

listener

(e: ChatThreadCreatedEvent) => void

Lyssnaren för att hantera händelsen.

ärvd från ChatClient.off

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

Avsluta prenumerationen från chatThreadDeleted.

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

Parametrar

event

"chatThreadDeleted"

The ChatThreadDeletedEvent.

listener

(e: ChatThreadDeletedEvent) => void

Lyssnaren för att hantera händelsen.

ärvd från ChatClient.off

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

Avsluta prenumerationen från chatThreadPropertiesUppdaterad.

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

Parametrar

event

"chatThreadPropertiesUpdated"

The ChatThreadPropertiesUpdatedEvent.

listener

(e: ChatThreadPropertiesUpdatedEvent) => void

Lyssnaren för att hantera händelsen.

ärvd från ChatClient.off

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

Avsluta prenumerationen från deltagareLägg till.

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

Parametrar

event

"participantsAdded"

DeltagarnaAddedEvent.

listener

(e: ParticipantsAddedEvent) => void

Lyssnaren för att hantera händelsen.

ärvd från ChatClient.off

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

Avsluta prenumerationen från deltagarnaRemoved.

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

Parametrar

event

"participantsRemoved"

DeltagarnaRemovedEvent.

listener

(e: ParticipantsRemovedEvent) => void

Lyssnaren för att hantera händelsen.

ärvd från ChatClient.off

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

Avsluta prenumerationen från readReceiptReceived.

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

Parametrar

event

"readReceiptReceived"

The ReadReceiptReceivedEvent.

listener

(e: ReadReceiptReceivedEvent) => void

Lyssnaren för att hantera händelsen.

ärvd från ChatClient.off

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

Avsluta prenumerationen från att skrivaIndicatorReceived.

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

Parametrar

event

"typingIndicatorReceived"

The TypingIndicatorReceivedEvent.

listener

(e: TypingIndicatorReceivedEvent) => void

Lyssnaren för att hantera händelsen.

ärvd från ChatClient.off

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

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

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

Parametrar

event

"chatMessageDeleted"

The ChatMessageDeletedEvent.

listener

(e: ChatMessageDeletedEvent) => void

Lyssnaren för att hantera händelsen.

ärvd från ChatClient.on

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

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

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

Parametrar

event

"chatMessageEdited"

The ChatMessageEditedEvent.

listener

(e: ChatMessageEditedEvent) => void

Lyssnaren för att hantera händelsen.

ärvd från ChatClient.on

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

Prenumerationsfunktion för chatMessageReceived. Den första avsändaren tar också emot den här händelsen. Du måste anropa startRealtimeNotifications innan du prenumererar på någon händelse.

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

Parametrar

event

"chatMessageReceived"

The ChatMessageReceivedEvent.

listener

(e: ChatMessageReceivedEvent) => void

Lyssnaren för att hantera händelsen.

ärvd från ChatClient.on

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

Prenumerationsfunktion för chatThreadCreated.

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

Parametrar

event

"chatThreadCreated"

The ChatThreadCreatedEvent.

listener

(e: ChatThreadCreatedEvent) => void

Lyssnaren för att hantera händelsen.

ärvd från ChatClient.on

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

Prenumerationsfunktion för chatThreadDeleted.

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

Parametrar

event

"chatThreadDeleted"

The ChatThreadDeletedEvent.

listener

(e: ChatThreadDeletedEvent) => void

Lyssnaren för att hantera händelsen.

ärvd från ChatClient.on

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

Prenumerationsfunktion för chatThreadPropertiesUpdated.

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

Parametrar

event

"chatThreadPropertiesUpdated"

The ChatThreadPropertiesUpdatedEvent.

listener

(e: ChatThreadPropertiesUpdatedEvent) => void

Lyssnaren för att hantera händelsen.

ärvd från ChatClient.on

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

Prenumerationsfunktion för deltagareLägg till.

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

Parametrar

event

"participantsAdded"

DeltagarnaAddedEvent.

listener

(e: ParticipantsAddedEvent) => void

Lyssnaren för att hantera händelsen.

ärvd från ChatClient.on

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

Funktionen Prenumerera för deltagareRemoved.

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

Parametrar

event

"participantsRemoved"

DeltagarnaRemovedEvent.

listener

(e: ParticipantsRemovedEvent) => void

Lyssnaren för att hantera händelsen.

ärvd från ChatClient.on

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

Prenumerationsfunktionen för readReceiptReceived.

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

Parametrar

event

"readReceiptReceived"

The ReadReceiptReceivedEvent.

listener

(e: ReadReceiptReceivedEvent) => void

Lyssnaren för att hantera händelsen.

ärvd från ChatClient.on

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

Prenumerationsfunktionen för realTimeNotificationConnected.

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

Parametrar

event

"realTimeNotificationConnected"

Händelsen realTimeNotificationConnected

listener

() => void

Lyssnaren för att hantera händelsen.

ärvd från ChatClient.on

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

Prenumerationsfunktionen för realTimeNotificationDisconnected.

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

Parametrar

event

"realTimeNotificationDisconnected"

Händelsen realTimeNotificationDisconnected

listener

() => void

Lyssnaren för att hantera händelsen.

ärvd från ChatClient.on

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

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

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

Parametrar

event

"typingIndicatorReceived"

The TypingIndicatorReceivedEvent.

listener

(e: TypingIndicatorReceivedEvent) => void

Lyssnaren för att hantera händelsen.

ärvd från ChatClient.on

startRealtimeNotifications()

Börja ta emot realtidsaviseringar. Anropa den här funktionen innan du prenumererar på någon händelse.

function startRealtimeNotifications(): Promise<void>

Returer

Promise<void>

ärvd från ChatClient.startRealtimeNotifications

stopRealtimeNotifications()

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

function stopRealtimeNotifications(): Promise<void>

Returer

Promise<void>

ärvd från ChatClient.stopRealtimeNotifications