ChatClient class

Pacchetto:

@azure/communication-chat

Il client per eseguire operazioni di chat

Costruttori

ChatClient(string, CommunicationTokenCredential, ChatClientOptions)

Crea un'istanza di ChatClient per una risorsa e un utente specificati.

Metodi

createChatThread(CreateChatThreadRequest, CreateChatThreadOptions)	Crea un thread di chat. Restituisce il client di thread con l'ID del thread creato.
deleteChatThread(string, OperationOptions)	Elimina un thread di chat.
getChatThreadClient(string)	Restituisce ChatThreadClient con l'ID thread specifico.
listChatThreads(RestListChatThreadsOptions)	Ottiene l'elenco dei thread di chat di un utente.
off("chatMessageDeleted", (e: ChatMessageDeletedEvent) => void)	Annullare la sottoscrizione da chatMessageDeleted.
off("chatMessageEdited", (e: ChatMessageEditedEvent) => void)	Annullare la sottoscrizione da chatMessageEdited.
off("chatMessageReceived", (e: ChatMessageReceivedEvent) => void)	Annullare la sottoscrizione da chatMessageReceived.
off("chatThreadCreated", (e: ChatThreadCreatedEvent) => void)	Annullare la sottoscrizione a chatThreadCreated.
off("chatThreadDeleted", (e: ChatThreadDeletedEvent) => void)	Annullare la sottoscrizione a chatThreadDeleted.
off("chatThreadPropertiesUpdated", (e: ChatThreadPropertiesUpdatedEvent) => void)	Annullare la sottoscrizione a chatThreadPropertiesUpdated.
off("participantsAdded", (e: ParticipantsAddedEvent) => void)	Annullare la sottoscrizione ai partecipantiAggiungi.
off("participantsRemoved", (e: ParticipantsRemovedEvent) => void)	Annullare la sottoscrizione ai partecipantiRemoved.
off("readReceiptReceived", (e: ReadReceiptReceivedEvent) => void)	Annullare la sottoscrizione a readReceiptReceived.
off("typingIndicatorReceived", (e: TypingIndicatorReceivedEvent) => void)	Annullare la sottoscrizione alla digitazioneIndicatorReceived.
on("chatMessageDeleted", (e: ChatMessageDeletedEvent) => void)	Funzione Subscribe per chatMessageDeleted. Il mittente iniziale riceverà anche questo evento.
on("chatMessageEdited", (e: ChatMessageEditedEvent) => void)	Funzione Subscribe per chatMessageEdited. Il mittente iniziale riceverà anche questo evento.
on("chatMessageReceived", (e: ChatMessageReceivedEvent) => void)	Funzione Subscribe per chatMessageReceived. Il mittente iniziale riceverà anche questo evento. È necessario chiamare startRealtimeNotifications prima di sottoscrivere qualsiasi evento.
on("chatThreadCreated", (e: ChatThreadCreatedEvent) => void)	Funzione Subscribe per chatThreadCreated.
on("chatThreadDeleted", (e: ChatThreadDeletedEvent) => void)	Funzione Subscribe per chatThreadDeleted.
on("chatThreadPropertiesUpdated", (e: ChatThreadPropertiesUpdatedEvent) => void)	Funzione Subscribe per chatThreadPropertiesUpdated.
on("participantsAdded", (e: ParticipantsAddedEvent) => void)	Funzione Subscribe per i partecipantiAdded.
on("participantsRemoved", (e: ParticipantsRemovedEvent) => void)	Funzione Subscribe per i partecipantiRemoved.
on("readReceiptReceived", (e: ReadReceiptReceivedEvent) => void)	Funzione Subscribe per readReceiptReceived.
on("realTimeNotificationConnected", () => void)	Funzione Subscribe per realTimeNotificationConnected.
on("realTimeNotificationDisconnected", () => void)	Funzione Subscribe per realTimeNotificationDisconnected.
on("typingIndicatorReceived", (e: TypingIndicatorReceivedEvent) => void)	Funzione Subscribe per la digitazioneIndicatorReceived. Il mittente iniziale riceverà anche questo evento.
startRealtimeNotifications()	Iniziare a ricevere notifiche in tempo reale. Chiamare questa funzione prima di sottoscrivere qualsiasi evento.
stopRealtimeNotifications()	Interrompere la ricezione di notifiche in tempo reale. Questa funzione annulla la sottoscrizione a tutti gli eventi.

Dettagli costruttore

ChatClient(string, CommunicationTokenCredential, ChatClientOptions)

Crea un'istanza di ChatClient per una risorsa e un utente specificati.

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

Parametri

endpoint

string

URL della risorsa Servizi di comunicazione.

credential

CommunicationTokenCredential

Credenziali del token. Usare AzureCommunicationTokenCredential da @azure/communication-common per creare credenziali.

options

ChatClientOptions

Opzioni client aggiuntive.

Dettagli metodo

createChatThread(CreateChatThreadRequest, CreateChatThreadOptions)

Crea un thread di chat. Restituisce il client di thread con l'ID del thread creato.

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

Parametri

request

CreateChatThreadRequest

Richiesta di creazione di un thread di chat.

options

CreateChatThreadOptions

Opzioni di operazione.

Restituisce

Promise<CreateChatThreadResult>

deleteChatThread(string, OperationOptions)

Elimina un thread di chat.

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

Parametri

threadId

string

ID del thread da eliminare.

options

OperationOptions

Opzioni di operazione.

Restituisce

Promise<void>

getChatThreadClient(string)

Restituisce ChatThreadClient con l'ID thread specifico.

function getChatThreadClient(threadId: string): ChatThreadClient

Parametri

threadId

string

ID thread per ChatThreadClient

Restituisce

ChatThreadClient

listChatThreads(RestListChatThreadsOptions)

Ottiene l'elenco dei thread di chat di un utente.

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

Parametri

options

RestListChatThreadsOptions

Elencare le opzioni dei thread di chat.

Restituisce

PagedAsyncIterableIterator<ChatThreadItem, ChatThreadItem[], PageSettings>

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

Annullare la sottoscrizione da chatMessageDeleted.

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

Parametri

event

"chatMessageDeleted"

The ChatMessageDeletedEvent.

listener

(e: ChatMessageDeletedEvent) => void

Listener per gestire l'evento.

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

Annullare la sottoscrizione da chatMessageEdited.

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

Parametri

event

"chatMessageEdited"

The ChatMessageEditedEvent.

listener

(e: ChatMessageEditedEvent) => void

Listener per gestire l'evento.

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

Annullare la sottoscrizione da chatMessageReceived.

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

Parametri

event

"chatMessageReceived"

The ChatMessageReceivedEvent.

listener

(e: ChatMessageReceivedEvent) => void

Listener per gestire l'evento.

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

Annullare la sottoscrizione a chatThreadCreated.

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

Parametri

event

"chatThreadCreated"

The ChatThreadCreatedEvent.

listener

(e: ChatThreadCreatedEvent) => void

Listener per gestire l'evento.

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

Annullare la sottoscrizione a chatThreadDeleted.

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

Parametri

event

"chatThreadDeleted"

The ChatThreadDeletedEvent.

listener

(e: ChatThreadDeletedEvent) => void

Listener per gestire l'evento.

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

Annullare la sottoscrizione a chatThreadPropertiesUpdated.

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

Parametri

event

"chatThreadPropertiesUpdated"

The ChatThreadPropertiesUpdatedEvent.

listener

(e: ChatThreadPropertiesUpdatedEvent) => void

Listener per gestire l'evento.

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

Annullare la sottoscrizione ai partecipantiAggiungi.

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

Parametri

event

"participantsAdded"

PartecipantiAddedEvent.

listener

(e: ParticipantsAddedEvent) => void

Listener per gestire l'evento.

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

Annullare la sottoscrizione ai partecipantiRemoved.

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

Parametri

event

"participantsRemoved"

PartecipantiRemovedEvent.

listener

(e: ParticipantsRemovedEvent) => void

Listener per gestire l'evento.

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

Annullare la sottoscrizione a readReceiptReceived.

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

Parametri

event

"readReceiptReceived"

The ReadReceiptReceivedEvent.

listener

(e: ReadReceiptReceivedEvent) => void

Listener per gestire l'evento.

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

Annullare la sottoscrizione alla digitazioneIndicatorReceived.

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

Parametri

event

"typingIndicatorReceived"

The TypingIndicatorReceivedEvent.

listener

(e: TypingIndicatorReceivedEvent) => void

Listener per gestire l'evento.

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

Funzione Subscribe per chatMessageDeleted. Il mittente iniziale riceverà anche questo evento.

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

Parametri

event

"chatMessageDeleted"

The ChatMessageDeletedEvent.

listener

(e: ChatMessageDeletedEvent) => void

Listener per gestire l'evento.

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

Funzione Subscribe per chatMessageEdited. Il mittente iniziale riceverà anche questo evento.

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

Parametri

event

"chatMessageEdited"

The ChatMessageEditedEvent.

listener

(e: ChatMessageEditedEvent) => void

Listener per gestire l'evento.

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

Funzione Subscribe per chatMessageReceived. Il mittente iniziale riceverà anche questo evento. È necessario chiamare startRealtimeNotifications prima di sottoscrivere qualsiasi evento.

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

Parametri

event

"chatMessageReceived"

The ChatMessageReceivedEvent.

listener

(e: ChatMessageReceivedEvent) => void

Listener per gestire l'evento.

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

Funzione Subscribe per chatThreadCreated.

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

Parametri

event

"chatThreadCreated"

The ChatThreadCreatedEvent.

listener

(e: ChatThreadCreatedEvent) => void

Listener per gestire l'evento.

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

Funzione Subscribe per chatThreadDeleted.

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

Parametri

event

"chatThreadDeleted"

The ChatThreadDeletedEvent.

listener

(e: ChatThreadDeletedEvent) => void

Listener per gestire l'evento.

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

Funzione Subscribe per chatThreadPropertiesUpdated.

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

Parametri

event

"chatThreadPropertiesUpdated"

The ChatThreadPropertiesUpdatedEvent.

listener

(e: ChatThreadPropertiesUpdatedEvent) => void

Listener per gestire l'evento.

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

Funzione Subscribe per i partecipantiAdded.

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

Parametri

event

"participantsAdded"

PartecipantiAddedEvent.

listener

(e: ParticipantsAddedEvent) => void

Listener per gestire l'evento.

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

Funzione Subscribe per i partecipantiRemoved.

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

Parametri

event

"participantsRemoved"

PartecipantiRemovedEvent.

listener

(e: ParticipantsRemovedEvent) => void

Listener per gestire l'evento.

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

Funzione Subscribe per readReceiptReceived.

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

Parametri

event

"readReceiptReceived"

The ReadReceiptReceivedEvent.

listener

(e: ReadReceiptReceivedEvent) => void

Listener per gestire l'evento.

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

Funzione Subscribe per realTimeNotificationConnected.

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

Parametri

event

"realTimeNotificationConnected"

Evento realTimeNotificationConnected

listener

() => void

Listener per gestire l'evento.

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

Funzione Subscribe per realTimeNotificationDisconnected.

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

Parametri

event

"realTimeNotificationDisconnected"

Evento realTimeNotificationDisconnected

listener

() => void

Listener per gestire l'evento.

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

Funzione Subscribe per la digitazioneIndicatorReceived. Il mittente iniziale riceverà anche questo evento.

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

Parametri

event

"typingIndicatorReceived"

The TypingIndicatorReceivedEvent.

listener

(e: TypingIndicatorReceivedEvent) => void

Listener per gestire l'evento.

startRealtimeNotifications()

Iniziare a ricevere notifiche in tempo reale. Chiamare questa funzione prima di sottoscrivere qualsiasi evento.

function startRealtimeNotifications(): Promise<void>

Restituisce

Promise<void>

stopRealtimeNotifications()

Interrompere la ricezione di notifiche in tempo reale. Questa funzione annulla la sottoscrizione a tutti gli eventi.

function stopRealtimeNotifications(): Promise<void>

Restituisce

Promise<void>