ChatClient class

Csomag:

@azure/communication-chat

Az ügyfél, aki csevegőműveleteket hajt végre

Konstruktorok

ChatClient(string, CommunicationTokenCredential, ChatClientOptions)

Létrehozza a ChatClient egy példányát egy adott erőforráshoz és felhasználóhoz.

Metódusok

createChatThread(CreateChatThreadRequest, CreateChatThreadOptions)	Létrehoz egy csevegési szálat. Visszaadja a szálügyfélt a létrehozott szál azonosítójával.
deleteChatThread(string, OperationOptions)	Csevegőszál törlése.
getChatThreadClient(string)	A ChatThreadClient értéket adja vissza az adott szálazonosítóval.
listChatThreads(ChatListChatThreadsOptionalParams)	Lekéri egy felhasználó csevegési szálainak listáját.
off("chatMessageDeleted", (e: ChatMessageDeletedEvent) => void)	Leiratkozás a chatMessageDeleted szolgáltatásról.
off("chatMessageEdited", (e: ChatMessageEditedEvent) => void)	Leiratkozás a chatMessageEdited szolgáltatásról.
off("chatMessageReceived", (e: ChatMessageReceivedEvent) => void)	Leiratkozás a chatMessageReceived szolgáltatásról.
off("chatThreadCreated", (e: ChatThreadCreatedEvent) => void)	Leiratkozás a chatThreadCreated szolgáltatásról.
off("chatThreadDeleted", (e: ChatThreadDeletedEvent) => void)	Leiratkozás a chatThreadDeleted szolgáltatásról.
off("chatThreadPropertiesUpdated", (e: ChatThreadPropertiesUpdatedEvent) => void)	Leiratkozás a csevegésrőlThreadPropertiesUpdated.
off("participantsAdded", (e: ParticipantsAddedEvent) => void)	Leiratkozás a résztvevőkrőlAdded.
off("participantsRemoved", (e: ParticipantsRemovedEvent) => void)	Leiratkozás a résztvevőkrőlRemoved.
off("readReceiptReceived", (e: ReadReceiptReceivedEvent) => void)	Leiratkozás a readReceiptReceived fájlról.
off("typingIndicatorReceived", (e: TypingIndicatorReceivedEvent) => void)	Leiratkozás azIndicatorReceived beírásáról.
on("chatMessageDeleted", (e: ChatMessageDeletedEvent) => void)	Feliratkozás függvény a chatMessageDeleted szolgáltatáshoz. A kezdeti feladó is megkapja ezt az eseményt.
on("chatMessageEdited", (e: ChatMessageEditedEvent) => void)	A chatMessageEdited előfizetési függvénye. A kezdeti feladó is megkapja ezt az eseményt.
on("chatMessageReceived", (e: ChatMessageReceivedEvent) => void)	A chatMessageReceived előfizetési függvénye. A kezdeti feladó is megkapja ezt az eseményt. Minden eseményre való feliratkozás előtt meg kell hívnia a startRealtimeNotifications parancsot.
on("chatThreadCreated", (e: ChatThreadCreatedEvent) => void)	Feliratkozás függvény a chatThreadCreated szolgáltatáshoz.
on("chatThreadDeleted", (e: ChatThreadDeletedEvent) => void)	Feliratkozás függvény a chatThreadDeleted szolgáltatáshoz.
on("chatThreadPropertiesUpdated", (e: ChatThreadPropertiesUpdatedEvent) => void)	Feliratkozás függvény a chatThreadPropertiesUpdated függvényhez.
on("participantsAdded", (e: ParticipantsAddedEvent) => void)	Feliratkozás függvény a résztvevők számáraAdded.
on("participantsRemoved", (e: ParticipantsRemovedEvent) => void)	Feliratkozási függvény a résztvevők számáraRemoved.
on("readReceiptReceived", (e: ReadReceiptReceivedEvent) => void)	A readReceiptReceived előfizetési függvénye.
on("realTimeNotificationConnected", () => void)	A realTimeNotificationConnected előfizetési függvénye.
on("realTimeNotificationDisconnected", () => void)	A realTimeNotificationDisconnected előfizetési függvénye.
on("typingIndicatorReceived", (e: TypingIndicatorReceivedEvent) => void)	Feliratkozás függvény azIndicatorReceived beírásához. A kezdeti feladó is megkapja ezt az eseményt.
startRealtimeNotifications()	Valós idejű értesítések fogadása. Hívja meg ezt a függvényt, mielőtt bármilyen eseményre feliratkozik.
stopRealtimeNotifications()	Állítsa le a valós idejű értesítések fogadását. Ez a függvény minden eseményre leiratkozik.

Konstruktor adatai

ChatClient(string, CommunicationTokenCredential, ChatClientOptions)

Létrehozza a ChatClient egy példányát egy adott erőforráshoz és felhasználóhoz.

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

Paraméterek

endpoint

string

A Communication Services-erőforrás URL-címe.

credential

CommunicationTokenCredential

A jogkivonat hitelesítő adatai. Az AzureCommunicationTokenCredential @azure/communication-common használatával hozzon létre hitelesítő adatokat.

options

ChatClientOptions

További ügyfélbeállítások.

Metódus adatai

createChatThread(CreateChatThreadRequest, CreateChatThreadOptions)

Létrehoz egy csevegési szálat. Visszaadja a szálügyfélt a létrehozott szál azonosítójával.

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

Paraméterek

request

CreateChatThreadRequest

Kérés csevegési szál létrehozására.

options

CreateChatThreadOptions

Műveleti beállítások.

Válaszok

Promise<CreateChatThreadResult>

deleteChatThread(string, OperationOptions)

Csevegőszál törlése.

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

Paraméterek

threadId

string

A törölni kívánt szál azonosítója.

options

OperationOptions

Műveleti beállítások.

Válaszok

Promise<void>

getChatThreadClient(string)

A ChatThreadClient értéket adja vissza az adott szálazonosítóval.

function getChatThreadClient(threadId: string): ChatThreadClient

Paraméterek

threadId

string

A ChatThreadClient szálazonosítója

Válaszok

ChatThreadClient

listChatThreads(ChatListChatThreadsOptionalParams)

Lekéri egy felhasználó csevegési szálainak listáját.

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

Paraméterek

options

RestListChatThreadsOptions

Csevegési szálak beállításainak listázása.

Válaszok

PagedAsyncIterableIterator<ChatThreadItem, ChatThreadItem[], PageSettings>

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

Leiratkozás a chatMessageDeleted szolgáltatásról.

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

Paraméterek

event

"chatMessageDeleted"

A ChatMessageDeletedEvent.

listener

(e: ChatMessageDeletedEvent) => void

Az eseményt kezelő figyelő.

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

Leiratkozás a chatMessageEdited szolgáltatásról.

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

Paraméterek

event

"chatMessageEdited"

A ChatMessageEditedEvent.

listener

(e: ChatMessageEditedEvent) => void

Az eseményt kezelő figyelő.

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

Leiratkozás a chatMessageReceived szolgáltatásról.

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

Paraméterek

event

"chatMessageReceived"

A ChatMessageReceivedEvent.

listener

(e: ChatMessageReceivedEvent) => void

Az eseményt kezelő figyelő.

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

Leiratkozás a chatThreadCreated szolgáltatásról.

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

Paraméterek

event

"chatThreadCreated"

A ChatThreadCreatedEvent.

listener

(e: ChatThreadCreatedEvent) => void

Az eseményt kezelő figyelő.

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

Leiratkozás a chatThreadDeleted szolgáltatásról.

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

Paraméterek

event

"chatThreadDeleted"

A ChatThreadDeletedEvent.

listener

(e: ChatThreadDeletedEvent) => void

Az eseményt kezelő figyelő.

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

Leiratkozás a csevegésrőlThreadPropertiesUpdated.

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

Paraméterek

event

"chatThreadPropertiesUpdated"

A ChatThreadPropertiesUpdatedEvent.

listener

(e: ChatThreadPropertiesUpdatedEvent) => void

Az eseményt kezelő figyelő.

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

Leiratkozás a résztvevőkrőlAdded.

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

Paraméterek

event

"participantsAdded"

A ParticipantsAddedEvent.

listener

(e: ParticipantsAddedEvent) => void

Az eseményt kezelő figyelő.

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

Leiratkozás a résztvevőkrőlRemoved.

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

Paraméterek

event

"participantsRemoved"

A ParticipantsRemovedEvent.

listener

(e: ParticipantsRemovedEvent) => void

Az eseményt kezelő figyelő.

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

Leiratkozás a readReceiptReceived fájlról.

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

Paraméterek

event

"readReceiptReceived"

A ReadReceiptReceivedEvent.

listener

(e: ReadReceiptReceivedEvent) => void

Az eseményt kezelő figyelő.

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

Leiratkozás azIndicatorReceived beírásáról.

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

Paraméterek

event

"typingIndicatorReceived"

A TypingIndicatorReceivedEvent.

listener

(e: TypingIndicatorReceivedEvent) => void

Az eseményt kezelő figyelő.

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

Feliratkozás függvény a chatMessageDeleted szolgáltatáshoz. A kezdeti feladó is megkapja ezt az eseményt.

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

Paraméterek

event

"chatMessageDeleted"

A ChatMessageDeletedEvent.

listener

(e: ChatMessageDeletedEvent) => void

Az eseményt kezelő figyelő.

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

A chatMessageEdited előfizetési függvénye. A kezdeti feladó is megkapja ezt az eseményt.

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

Paraméterek

event

"chatMessageEdited"

A ChatMessageEditedEvent.

listener

(e: ChatMessageEditedEvent) => void

Az eseményt kezelő figyelő.

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

A chatMessageReceived előfizetési függvénye. A kezdeti feladó is megkapja ezt az eseményt. Minden eseményre való feliratkozás előtt meg kell hívnia a startRealtimeNotifications parancsot.

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

Paraméterek

event

"chatMessageReceived"

A ChatMessageReceivedEvent.

listener

(e: ChatMessageReceivedEvent) => void

Az eseményt kezelő figyelő.

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

Feliratkozás függvény a chatThreadCreated szolgáltatáshoz.

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

Paraméterek

event

"chatThreadCreated"

A ChatThreadCreatedEvent.

listener

(e: ChatThreadCreatedEvent) => void

Az eseményt kezelő figyelő.

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

Feliratkozás függvény a chatThreadDeleted szolgáltatáshoz.

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

Paraméterek

event

"chatThreadDeleted"

A ChatThreadDeletedEvent.

listener

(e: ChatThreadDeletedEvent) => void

Az eseményt kezelő figyelő.

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

Feliratkozás függvény a chatThreadPropertiesUpdated függvényhez.

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

Paraméterek

event

"chatThreadPropertiesUpdated"

A ChatThreadPropertiesUpdatedEvent.

listener

(e: ChatThreadPropertiesUpdatedEvent) => void

Az eseményt kezelő figyelő.

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

Feliratkozás függvény a résztvevők számáraAdded.

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

Paraméterek

event

"participantsAdded"

A ParticipantsAddedEvent.

listener

(e: ParticipantsAddedEvent) => void

Az eseményt kezelő figyelő.

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

Feliratkozási függvény a résztvevők számáraRemoved.

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

Paraméterek

event

"participantsRemoved"

A ParticipantsRemovedEvent.

listener

(e: ParticipantsRemovedEvent) => void

Az eseményt kezelő figyelő.

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

A readReceiptReceived előfizetési függvénye.

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

Paraméterek

event

"readReceiptReceived"

A ReadReceiptReceivedEvent.

listener

(e: ReadReceiptReceivedEvent) => void

Az eseményt kezelő figyelő.

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

A realTimeNotificationConnected előfizetési függvénye.

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

Paraméterek

event

"realTimeNotificationConnected"

A realTimeNotificationConnected esemény

listener

() => void

Az eseményt kezelő figyelő.

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

A realTimeNotificationDisconnected előfizetési függvénye.

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

Paraméterek

event

"realTimeNotificationDisconnected"

A realTimeNotificationDisconnected esemény

listener

() => void

Az eseményt kezelő figyelő.

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

Feliratkozás függvény azIndicatorReceived beírásához. A kezdeti feladó is megkapja ezt az eseményt.

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

Paraméterek

event

"typingIndicatorReceived"

A TypingIndicatorReceivedEvent.

listener

(e: TypingIndicatorReceivedEvent) => void

Az eseményt kezelő figyelő.

startRealtimeNotifications()

Valós idejű értesítések fogadása. Hívja meg ezt a függvényt, mielőtt bármilyen eseményre feliratkozik.

function startRealtimeNotifications(): Promise<void>

Válaszok

Promise<void>

stopRealtimeNotifications()

Állítsa le a valós idejű értesítések fogadását. Ez a függvény minden eseményre leiratkozik.

function stopRealtimeNotifications(): Promise<void>

Válaszok

Promise<void>