StatefulChatClient interface

Pacchetto:

@azure/communication-react

Definisce i metodi che consentono l'uso di {@Link @azure/communication-chat#ChatClient} con uno stato generato centralizzato.

L'interfaccia fornisce l'accesso allo stato proxy e consente anche di registrare un gestore per gli eventi di modifica dello stato.

Extends

ChatClient

Metodi

dispose()	Pulisce la cache delle risorse dal client del thread di chat.
downloadResourceToCache(string, string, string)	Scarica una risorsa per un messaggio specifico e la memorizza nella cache.
getState()	Mantiene tutto lo stato di cui è possibile eseguire il proxy da ChatClient {@Link @azure/communication-chat#ChatClient} come ChatClientState {@Link ChatClientState}.
offStateChange((state: ChatClientState) => void)	Consente di annullare la registrazione per gli eventi 'stateChanged'.
onStateChange((state: ChatClientState) => void)	Consente la registrazione di un gestore per gli eventi 'stateChanged'.
removeResourceFromCache(string, string, string)	Rimuove una risorsa dalla cache per un messaggio specifico.

Metodi ereditati

createChatThread(CreateChatThreadRequest, CreateChatThreadOptions)	Crea un thread di chat. Restituisce il client 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(ChatListChatThreadsOptionalParams)	Ottiene l'elenco dei thread di chat di un utente.
off("chatMessageDeleted", (e: ChatMessageDeletedEvent) => void)	Annullare la sottoscrizione a chatMessageDeleted.
off("chatMessageEdited", (e: ChatMessageEditedEvent) => void)	Annullare la sottoscrizione a chatMessageEdited.
off("chatMessageReceived", (e: ChatMessageReceivedEvent) => void)	Annullare la sottoscrizione a chatMessageReceived.
off("chatThreadCreated", (e: ChatThreadCreatedEvent) => void)	Annullare la sottoscrizione alla chatThreadCreated.
off("chatThreadDeleted", (e: ChatThreadDeletedEvent) => void)	Annullare la sottoscrizione alla 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 partecipantiRimo.
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 metodo

dispose()

Pulisce la cache delle risorse dal client del thread di chat.

function dispose()

downloadResourceToCache(string, string, string)

Scarica una risorsa per un messaggio specifico e la memorizza nella cache.

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

Parametri

threadId

string

L'ID del thread della chat.

messageId

string

L'ID del messaggio di chat.

resourceUrl

string

L'URL della risorsa da recuperare e memorizzare nella cache.

getState()

Mantiene tutto lo stato di cui è possibile eseguire il proxy da ChatClient {@Link @azure/communication-chat#ChatClient} come ChatClientState {@Link ChatClientState}.

function getState(): ChatClientState

Restituisce

ChatClientState

offStateChange((state: ChatClientState) => void)

Consente di annullare la registrazione per gli eventi 'stateChanged'.

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

Parametri

handler

(state: ChatClientState) => void

Callback originale da annullare.

onStateChange((state: ChatClientState) => void)

Consente la registrazione di un gestore per gli eventi 'stateChanged'.

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

Parametri

handler

(state: ChatClientState) => void

Callback per ricevere lo stato.

removeResourceFromCache(string, string, string)

Rimuove una risorsa dalla cache per un messaggio specifico.

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

Parametri

threadId

string

L'ID del thread della chat.

messageId

string

L'ID del messaggio di chat.

resourceUrl

string

L'URL della risorsa da rimuovere dalla cache.

Dettagli dei metodi ereditati

createChatThread(CreateChatThreadRequest, CreateChatThreadOptions)

Crea un thread di chat. Restituisce il client 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 dell'operazione.

Restituisce

Promise<CreateChatThreadResult>

ereditato da ChatClient.createChatThread

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 dell'operazione.

Restituisce

Promise<void>

Ereditato da ChatClient.deleteChatThread

getChatThreadClient(string)

Restituisce ChatThreadClient con l'ID thread specifico.

function getChatThreadClient(threadId: string): ChatThreadClient

Parametri

threadId

string

ID thread per ChatThreadClient

Restituisce

ChatThreadClient

ereditato da ChatClient.getChatThreadClient

listChatThreads(ChatListChatThreadsOptionalParams)

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

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

Parametri

options

@azure/communication-chat.ChatListChatThreadsOptionalParams

Elencare le opzioni dei thread di chat.

Restituisce

PagedAsyncIterableIterator<ChatThreadItem, ChatThreadItem[], PageSettings>

ereditato da ChatClient.listChatThreads

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

Annullare la sottoscrizione a chatMessageDeleted.

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

Parametri

event

"chatMessageDeleted"

L'evento ChatMessageDeleted.

listener

(e: ChatMessageDeletedEvent) => void

Listener per gestire l'evento.

ereditato da ChatClient.off

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

Annullare la sottoscrizione a chatMessageEdited.

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

Parametri

event

"chatMessageEdited"

L'oggetto ChatMessageEditedEvent.

listener

(e: ChatMessageEditedEvent) => void

Listener per gestire l'evento.

ereditato da ChatClient.off

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

Annullare la sottoscrizione a chatMessageReceived.

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

Parametri

event

"chatMessageReceived"

L'evento ChatMessageReceived.

listener

(e: ChatMessageReceivedEvent) => void

Listener per gestire l'evento.

ereditato da ChatClient.off

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

Annullare la sottoscrizione alla chatThreadCreated.

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

Parametri

event

"chatThreadCreated"

L'evento ChatThreadCreatedEvent.

listener

(e: ChatThreadCreatedEvent) => void

Listener per gestire l'evento.

ereditato da ChatClient.off

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

Annullare la sottoscrizione alla chatThreadDeleted.

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

Parametri

event

"chatThreadDeleted"

L'evento ChatThreadDeleted.

listener

(e: ChatThreadDeletedEvent) => void

Listener per gestire l'evento.

ereditato da ChatClient.off

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

Annullare la sottoscrizione a chatThreadPropertiesUpdated.

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

Parametri

event

"chatThreadPropertiesUpdated"

L'evento ChatThreadPropertiesUpdatedEvent.

listener

(e: ChatThreadPropertiesUpdatedEvent) => void

Listener per gestire l'evento.

ereditato da ChatClient.off

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.

ereditato da ChatClient.off

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

Annullare la sottoscrizione ai partecipantiRimo.

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

Parametri

event

"participantsRemoved"

PartecipantiRemovedEvent.

listener

(e: ParticipantsRemovedEvent) => void

Listener per gestire l'evento.

ereditato da ChatClient.off

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

Annullare la sottoscrizione a readReceiptReceived.

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

Parametri

event

"readReceiptReceived"

L'oggetto ReadReceiptReceivedEvent.

listener

(e: ReadReceiptReceivedEvent) => void

Listener per gestire l'evento.

ereditato da ChatClient.off

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

Annullare la sottoscrizione alla digitazioneIndicatorReceived.

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

Parametri

event

"typingIndicatorReceived"

L'evento TypingIndicatorReceivedEvent.

listener

(e: TypingIndicatorReceivedEvent) => void

Listener per gestire l'evento.

ereditato da ChatClient.off

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"

L'evento ChatMessageDeleted.

listener

(e: ChatMessageDeletedEvent) => void

Listener per gestire l'evento.

ereditato da ChatClient.on

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"

L'oggetto ChatMessageEditedEvent.

listener

(e: ChatMessageEditedEvent) => void

Listener per gestire l'evento.

ereditato da ChatClient.on

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"

L'evento ChatMessageReceived.

listener

(e: ChatMessageReceivedEvent) => void

Listener per gestire l'evento.

ereditato da ChatClient.on

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

Funzione Subscribe per chatThreadCreated.

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

Parametri

event

"chatThreadCreated"

L'evento ChatThreadCreatedEvent.

listener

(e: ChatThreadCreatedEvent) => void

Listener per gestire l'evento.

ereditato da ChatClient.on

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

Funzione Subscribe per chatThreadDeleted.

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

Parametri

event

"chatThreadDeleted"

L'evento ChatThreadDeleted.

listener

(e: ChatThreadDeletedEvent) => void

Listener per gestire l'evento.

ereditato da ChatClient.on

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

Funzione Subscribe per chatThreadPropertiesUpdated.

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

Parametri

event

"chatThreadPropertiesUpdated"

L'evento ChatThreadPropertiesUpdatedEvent.

listener

(e: ChatThreadPropertiesUpdatedEvent) => void

Listener per gestire l'evento.

ereditato da ChatClient.on

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.

ereditato da ChatClient.on

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.

ereditato da ChatClient.on

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

Funzione Subscribe per readReceiptReceived.

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

Parametri

event

"readReceiptReceived"

L'oggetto ReadReceiptReceivedEvent.

listener

(e: ReadReceiptReceivedEvent) => void

Listener per gestire l'evento.

ereditato da ChatClient.on

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.

ereditato da ChatClient.on

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.

ereditato da ChatClient.on

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"

L'evento TypingIndicatorReceivedEvent.

listener

(e: TypingIndicatorReceivedEvent) => void

Listener per gestire l'evento.

ereditato da ChatClient.on

startRealtimeNotifications()

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

function startRealtimeNotifications(): Promise<void>

Restituisce

Promise<void>

Ereditato da ChatClient.startRealtimeNotifications

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>

Ereditato da ChatClient.stopRealtimeNotifications