StatefulChatClient interface

Balíček:

@azure/communication-react

Definuje metody, které umožňují použití {@Link @azure/communication-chat#ChatClient} s centralizovaným vygenerovaným stavem.

Rozhraní poskytuje přístup kxied stavu a také umožňuje registraci obslužné rutiny pro události změny stavu.

Extends

ChatClient

Metody

dispose()	Vyčistí mezipaměť prostředků z klienta vlákna chatu.
downloadResourceToCache(string, string, string)	Stáhne prostředek pro konkrétní zprávu a uloží jej do mezipaměti.
getState()	Uchovává veškerý stav, který bychom mohli proxy z ChatClient {@Link @azure/communication-chat#ChatClient} jako ChatClientState {@Link ChatClientState}.
offStateChange((state: ChatClientState) => void)	Povoluje zrušení registrace událostí stateChanged.
onStateChange((state: ChatClientState) => void)	Umožňuje registraci obslužné rutiny pro události stateChanged.
removeResourceFromCache(string, string, string)	Odebere z mezipaměti prostředek pro konkrétní zprávu.

Zděděné metody

createChatThread(CreateChatThreadRequest, CreateChatThreadOptions)	Vytvoří vlákno chatu. Vrátí klienta vlákna s ID vytvořeného vlákna.
deleteChatThread(string, OperationOptions)	Odstraní vlákno chatu.
getChatThreadClient(string)	Vrátí ChatThreadClient s konkrétním ID vlákna.
listChatThreads(ChatListChatThreadsOptionalParams)	Získá seznam vláken chatu uživatele.
off("chatMessageDeleted", (e: ChatMessageDeletedEvent) => void)	Odhlásit odběr chatMessageDeleted
off("chatMessageEdited", (e: ChatMessageEditedEvent) => void)	Odhlásit odběr chatMessageEdited.
off("chatMessageReceived", (e: ChatMessageReceivedEvent) => void)	Odhlásit odběr chatMessageReceived.
off("chatThreadCreated", (e: ChatThreadCreatedEvent) => void)	Odhlásit odběr chatuThreadCreated
off("chatThreadDeleted", (e: ChatThreadDeletedEvent) => void)	Odhlásit odběr chatuThreadDeleted
off("chatThreadPropertiesUpdated", (e: ChatThreadPropertiesUpdatedEvent) => void)	Odhlásit odběr chatuThreadPropertiesUpdated
off("participantsAdded", (e: ParticipantsAddedEvent) => void)	Odhlaste se od účastníkůAdded.
off("participantsRemoved", (e: ParticipantsRemovedEvent) => void)	Odhlásit odběr účastníkůRemoved.
off("readReceiptReceived", (e: ReadReceiptReceivedEvent) => void)	Odhlásit odběr z readReceiptReceived.
off("typingIndicatorReceived", (e: TypingIndicatorReceivedEvent) => void)	Odhlaste se od psaníIndicatorReceived.
on("chatMessageDeleted", (e: ChatMessageDeletedEvent) => void)	Funkce Subscribe pro chatMessageDeleted Tuto událost obdrží také počáteční odesílatel.
on("chatMessageEdited", (e: ChatMessageEditedEvent) => void)	Funkce Subscribe pro chatMessageEdited. Tuto událost obdrží také počáteční odesílatel.
on("chatMessageReceived", (e: ChatMessageReceivedEvent) => void)	Funkce Subscribe pro chatMessageReceived. Tuto událost obdrží také počáteční odesílatel. Před přihlášením k odběru jakékoli události musíte volat startRealtimeNotifications.
on("chatThreadCreated", (e: ChatThreadCreatedEvent) => void)	Funkce Subscribe pro chatThreadCreated
on("chatThreadDeleted", (e: ChatThreadDeletedEvent) => void)	Funkce Subscribe pro chatThreadDeleted.
on("chatThreadPropertiesUpdated", (e: ChatThreadPropertiesUpdatedEvent) => void)	Funkce Subscribe pro chatThreadPropertiesUpdated
on("participantsAdded", (e: ParticipantsAddedEvent) => void)	Přihlásit se k odběru funkce pro účastníkyAdded.
on("participantsRemoved", (e: ParticipantsRemovedEvent) => void)	Přihlásit se k odběru funkce pro účastníkyRemoved.
on("readReceiptReceived", (e: ReadReceiptReceivedEvent) => void)	Funkce Subscribe pro readReceiptReceived.
on("realTimeNotificationConnected", () => void)	Funkce Subscribe pro realTimeNotificationConnected
on("realTimeNotificationDisconnected", () => void)	Funkce Subscribe pro realTimeNotificationDisconnected
on("typingIndicatorReceived", (e: TypingIndicatorReceivedEvent) => void)	Funkce Subscribe pro psaníIndicatorReceived Tuto událost obdrží také počáteční odesílatel.
startRealtimeNotifications()	Začněte přijímat oznámení v reálném čase. Před přihlášením k odběru jakékoli události zavolejte tuto funkci.
stopRealtimeNotifications()	Přestaňte přijímat oznámení v reálném čase. Tato funkce by odhlásila odběr všech událostí.

Podrobnosti metody

dispose()

Vyčistí mezipaměť prostředků z klienta vlákna chatu.

function dispose()

downloadResourceToCache(string, string, string)

Stáhne prostředek pro konkrétní zprávu a uloží jej do mezipaměti.

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

Parametry

threadId

string

ID vlákna vlákna chatu.

messageId

string

ID zprávy chatu.

resourceUrl

string

Adresa URL zdroje pro načtení a mezipaměť.

getState()

Uchovává veškerý stav, který bychom mohli proxy z ChatClient {@Link @azure/communication-chat#ChatClient} jako ChatClientState {@Link ChatClientState}.

function getState(): ChatClientState

Návraty

ChatClientState

offStateChange((state: ChatClientState) => void)

Povoluje zrušení registrace událostí stateChanged.

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

Parametry

handler

(state: ChatClientState) => void

Původní zpětné volání, které se má odhlásit.

onStateChange((state: ChatClientState) => void)

Umožňuje registraci obslužné rutiny pro události stateChanged.

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

Parametry

handler

(state: ChatClientState) => void

Zpětná volání pro příjem stavu.

removeResourceFromCache(string, string, string)

Odebere z mezipaměti prostředek pro konkrétní zprávu.

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

Parametry

threadId

string

ID vlákna vlákna chatu.

messageId

string

ID zprávy chatu.

resourceUrl

string

Adresa URL zdroje, která má být odebrána z mezipaměti.

Podrobnosti zděděných metod

createChatThread(CreateChatThreadRequest, CreateChatThreadOptions)

Vytvoří vlákno chatu. Vrátí klienta vlákna s ID vytvořeného vlákna.

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

Parametry

request

CreateChatThreadRequest

Žádost o vytvoření vlákna chatu

options

CreateChatThreadOptions

Možnosti operace.

Návraty

Promise<CreateChatThreadResult>

zděděno z ChatClient.createChatThread

deleteChatThread(string, OperationOptions)

Odstraní vlákno chatu.

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

Parametry

threadId

string

ID vlákna, které chcete odstranit.

options

OperationOptions

Možnosti operace.

Návraty

Promise<void>

zděděno z ChatClient.deleteChatThread

getChatThreadClient(string)

Vrátí ChatThreadClient s konkrétním ID vlákna.

function getChatThreadClient(threadId: string): ChatThreadClient

Parametry

threadId

string

ID vlákna pro ChatThreadClient

Návraty

ChatThreadClient

zděděno z ChatClient.getChatThreadClient

listChatThreads(ChatListChatThreadsOptionalParams)

Získá seznam vláken chatu uživatele.

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

Parametry

options

@azure/communication-chat.ChatListChatThreadsOptionalParams

Seznam možností vláken chatu

Návraty

PagedAsyncIterableIterator<ChatThreadItem, ChatThreadItem[], PageSettings>

zděděno z ChatClient.listChatThreads

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

Odhlásit odběr chatMessageDeleted

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

Parametry

event

"chatMessageDeleted"

Událost ChatMessageDeleted.

listener

(e: ChatMessageDeletedEvent) => void

Naslouchací proces pro zpracování události.

zděděno z ChatClient.off

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

Odhlásit odběr chatMessageEdited.

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

Parametry

event

"chatMessageEdited"

Událost ChatMessageEdited.

listener

(e: ChatMessageEditedEvent) => void

Naslouchací proces pro zpracování události.

zděděno z ChatClient.off

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

Odhlásit odběr chatMessageReceived.

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

Parametry

event

"chatMessageReceived"

Událost ChatMessageReceivedEvent.

listener

(e: ChatMessageReceivedEvent) => void

Naslouchací proces pro zpracování události.

zděděno z ChatClient.off

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

Odhlásit odběr chatuThreadCreated

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

Parametry

event

"chatThreadCreated"

Událost ChatThreadCreatedEvent.

listener

(e: ChatThreadCreatedEvent) => void

Naslouchací proces pro zpracování události.

zděděno z ChatClient.off

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

Odhlásit odběr chatuThreadDeleted

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

Parametry

event

"chatThreadDeleted"

Událost ChatThreadDeletedEvent.

listener

(e: ChatThreadDeletedEvent) => void

Naslouchací proces pro zpracování události.

zděděno z ChatClient.off

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

Odhlásit odběr chatuThreadPropertiesUpdated

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

Parametry

event

"chatThreadPropertiesUpdated"

Událost ChatThreadPropertiesUpdated.

listener

(e: ChatThreadPropertiesUpdatedEvent) => void

Naslouchací proces pro zpracování události.

zděděno z ChatClient.off

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

Odhlaste se od účastníkůAdded.

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

Parametry

event

"participantsAdded"

ÚčastníciAddedEvent.

listener

(e: ParticipantsAddedEvent) => void

Naslouchací proces pro zpracování události.

zděděno z ChatClient.off

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

Odhlásit odběr účastníkůRemoved.

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

Parametry

event

"participantsRemoved"

ÚčastníciRemovedEvent.

listener

(e: ParticipantsRemovedEvent) => void

Naslouchací proces pro zpracování události.

zděděno z ChatClient.off

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

Odhlásit odběr z readReceiptReceived.

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

Parametry

event

"readReceiptReceived"

Událost ReadReceiptReceived.

listener

(e: ReadReceiptReceivedEvent) => void

Naslouchací proces pro zpracování události.

zděděno z ChatClient.off

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

Odhlaste se od psaníIndicatorReceived.

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

Parametry

event

"typingIndicatorReceived"

Událost TypingIndicatorReceivedEvent.

listener

(e: TypingIndicatorReceivedEvent) => void

Naslouchací proces pro zpracování události.

zděděno z ChatClient.off

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

Funkce Subscribe pro chatMessageDeleted Tuto událost obdrží také počáteční odesílatel.

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

Parametry

event

"chatMessageDeleted"

Událost ChatMessageDeleted.

listener

(e: ChatMessageDeletedEvent) => void

Naslouchací proces pro zpracování události.

zděděno z ChatClient.on

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

Funkce Subscribe pro chatMessageEdited. Tuto událost obdrží také počáteční odesílatel.

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

Parametry

event

"chatMessageEdited"

Událost ChatMessageEdited.

listener

(e: ChatMessageEditedEvent) => void

Naslouchací proces pro zpracování události.

zděděno z ChatClient.on

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

Funkce Subscribe pro chatMessageReceived. Tuto událost obdrží také počáteční odesílatel. Před přihlášením k odběru jakékoli události musíte volat startRealtimeNotifications.

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

Parametry

event

"chatMessageReceived"

Událost ChatMessageReceivedEvent.

listener

(e: ChatMessageReceivedEvent) => void

Naslouchací proces pro zpracování události.

zděděno z ChatClient.on

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

Funkce Subscribe pro chatThreadCreated

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

Parametry

event

"chatThreadCreated"

Událost ChatThreadCreatedEvent.

listener

(e: ChatThreadCreatedEvent) => void

Naslouchací proces pro zpracování události.

zděděno z ChatClient.on

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

Funkce Subscribe pro chatThreadDeleted.

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

Parametry

event

"chatThreadDeleted"

Událost ChatThreadDeletedEvent.

listener

(e: ChatThreadDeletedEvent) => void

Naslouchací proces pro zpracování události.

zděděno z ChatClient.on

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

Funkce Subscribe pro chatThreadPropertiesUpdated

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

Parametry

event

"chatThreadPropertiesUpdated"

Událost ChatThreadPropertiesUpdated.

listener

(e: ChatThreadPropertiesUpdatedEvent) => void

Naslouchací proces pro zpracování události.

zděděno z ChatClient.on

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

Přihlásit se k odběru funkce pro účastníkyAdded.

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

Parametry

event

"participantsAdded"

ÚčastníciAddedEvent.

listener

(e: ParticipantsAddedEvent) => void

Naslouchací proces pro zpracování události.

zděděno z ChatClient.on

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

Přihlásit se k odběru funkce pro účastníkyRemoved.

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

Parametry

event

"participantsRemoved"

ÚčastníciRemovedEvent.

listener

(e: ParticipantsRemovedEvent) => void

Naslouchací proces pro zpracování události.

zděděno z ChatClient.on

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

Funkce Subscribe pro readReceiptReceived.

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

Parametry

event

"readReceiptReceived"

Událost ReadReceiptReceived.

listener

(e: ReadReceiptReceivedEvent) => void

Naslouchací proces pro zpracování události.

zděděno z ChatClient.on

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

Funkce Subscribe pro realTimeNotificationConnected

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

Parametry

event

"realTimeNotificationConnected"

RealTimeNotificationConnected – událost

listener

() => void

Naslouchací proces pro zpracování události.

zděděno z ChatClient.on

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

Funkce Subscribe pro realTimeNotificationDisconnected

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

Parametry

event

"realTimeNotificationDisconnected"

RealTimeNotificationDisconnected – událost

listener

() => void

Naslouchací proces pro zpracování události.

zděděno z ChatClient.on

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

Funkce Subscribe pro psaníIndicatorReceived Tuto událost obdrží také počáteční odesílatel.

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

Parametry

event

"typingIndicatorReceived"

Událost TypingIndicatorReceivedEvent.

listener

(e: TypingIndicatorReceivedEvent) => void

Naslouchací proces pro zpracování události.

zděděno z ChatClient.on

startRealtimeNotifications()

Začněte přijímat oznámení v reálném čase. Před přihlášením k odběru jakékoli události zavolejte tuto funkci.

function startRealtimeNotifications(): Promise<void>

Návraty

Promise<void>

zděděno z ChatClient.startRealtimeNotifications

stopRealtimeNotifications()

Přestaňte přijímat oznámení v reálném čase. Tato funkce by odhlásila odběr všech událostí.

function stopRealtimeNotifications(): Promise<void>

Návraty

Promise<void>

zděděno z ChatClient.stopRealtimeNotifications