ChatClient class

  • Referens
Paket:
@azure/communication-chat

Klienten som ska utföra chattåtgärder

Konstruktorer

ChatClient(string, CommunicationTokenCredential, ChatClientOptions)

Skapar en instans av ChatClient för en viss resurs och användare.

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(RestListChatThreadsOptions)

Hämtar en användares lista över chatttrådar.
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 på chatMessageReceived.
off("chatThreadCreated", (e: ChatThreadCreatedEvent) => void)

Avsluta prenumerationen på chatThreadCreated.
off("chatThreadDeleted", (e: ChatThreadDeletedEvent) => void)

Avsluta prenumerationen från chatThreadDeleted.
off("chatThreadPropertiesUpdated", (e: ChatThreadPropertiesUpdatedEvent) => void)

Avsluta prenumerationen från chatThreadPropertiesUpdated.
off("participantsAdded", (e: ParticipantsAddedEvent) => void)

Avsluta prenumerationen från deltagarnaLä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)

Funktionen Prenumerera för chatMessageDeleted. Den första avsändaren tar också emot den här händelsen.
on("chatMessageEdited", (e: ChatMessageEditedEvent) => void)

Funktionen Prenumerera för chatMessageEdited. Den första avsändaren tar också emot den här händelsen.
on("chatMessageReceived", (e: ChatMessageReceivedEvent) => void)

Funktionen Prenumerera 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)

Funktionen Prenumerera för chatThreadCreated.
on("chatThreadDeleted", (e: ChatThreadDeletedEvent) => void)

Funktionen Prenumerera för chatThreadDeleted.
on("chatThreadPropertiesUpdated", (e: ChatThreadPropertiesUpdatedEvent) => void)

Funktionen Prenumerera 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)

Funktionen Prenumerera för readReceiptReceived.
on("realTimeNotificationConnected", () => void)

Funktionen Subscribe för realTimeNotificationConnected.
on("realTimeNotificationDisconnected", () => void)

Funktionen Subscribe för realTimeNotificationDisconnected.
on("typingIndicatorReceived", (e: TypingIndicatorReceivedEvent) => void)

Funktionen Subscribe 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 avbryter prenumerationen på alla händelser.

Konstruktorinformation

ChatClient(string, CommunicationTokenCredential, ChatClientOptions)

Skapar en instans av ChatClient för en viss resurs och användare.

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

Parametrar

endpoint

string

URL:en för Communication Services-resursen.

credential
CommunicationTokenCredential

Tokenautentiseringsuppgifterna. Använd AzureCommunicationTokenCredential från @azure/communication-common för att skapa en autentiseringsuppgift.

options
ChatClientOptions

Ytterligare klientalternativ.

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>

deleteChatThread(string, OperationOptions)

Tar bort en chatttråd.

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

Parametrar

threadId

string

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

options
OperationOptions

Åtgärdsalternativ.

Returer

Promise<void>

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

listChatThreads(RestListChatThreadsOptions)

Hämtar en användares lista över chatttrådar.

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

Parametrar

options
RestListChatThreadsOptions

Lista alternativ för chatttrådar.

Returer

PagedAsyncIterableIterator<ChatThreadItem, ChatThreadItem[], PageSettings>

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.

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.

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

Avsluta prenumerationen på 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.

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

Avsluta prenumerationen på chatThreadCreated.

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

Parametrar

event

"chatThreadCreated"

The ChatThreadCreatedEvent.

listener

(e: ChatThreadCreatedEvent) => void

Lyssnaren för att hantera händelsen.

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.

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

Avsluta prenumerationen från chatThreadPropertiesUpdated.

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

Parametrar

event

"chatThreadPropertiesUpdated"

The ChatThreadPropertiesUpdatedEvent.

listener

(e: ChatThreadPropertiesUpdatedEvent) => void

Lyssnaren för att hantera händelsen.

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

Avsluta prenumerationen från deltagarnaLä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.

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

Avsluta prenumerationen från deltagarnaRemoved.

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

Parametrar

event

"participantsRemoved"

The ParticipantsRemovedEvent.

listener

(e: ParticipantsRemovedEvent) => void

Lyssnaren för att hantera händelsen.

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.

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.

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

Funktionen Prenumerera 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.

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

Funktionen Prenumerera 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.

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

Funktionen Prenumerera 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.

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

Funktionen Prenumerera 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.

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

Funktionen Prenumerera 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.

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

Funktionen Prenumerera 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.

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.

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

Funktionen Prenumerera för deltagareRemoved.

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

Parametrar

event

"participantsRemoved"

The ParticipantsRemovedEvent.

listener

(e: ParticipantsRemovedEvent) => void

Lyssnaren för att hantera händelsen.

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

Funktionen Prenumerera 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.

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

Funktionen Subscribe för realTimeNotificationConnected.

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

Parametrar

event

"realTimeNotificationConnected"

Händelsen realTimeNotificationConnected

listener

() => void

Lyssnaren för att hantera händelsen.

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

Funktionen Subscribe för realTimeNotificationDisconnected.

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

Parametrar

event

"realTimeNotificationDisconnected"

Händelsen realTimeNotificationDisconnected

listener

() => void

Lyssnaren för att hantera händelsen.

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

Funktionen Subscribe 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.

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>

stopRealtimeNotifications()

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

function stopRealtimeNotifications(): Promise<void>

Returer

Promise<void>