Overzicht
Een UI-element dat een chatinterface weergeeft.Gebruik
Basisgebruik
Luisteren naar events
Events
Events die door de ChatElement worden uitgezonden. Luister naar deze events met de methodeon() of door callbackfuncties mee te geven in de opties.
error
Wordt uitgezonden wanneer er een fout optreedt tijdens de initialisatie of werking van het element.
Callbacksignatuur: (error: unknown) => void
ready
Wordt uitgezonden wanneer het element klaar is met laden en gereed is voor interactie met de gebruiker.
Callbacksignatuur: (element: ChatElement) => void
optionsUpdated
Wordt uitgezonden wanneer de opties van het element worden bijgewerkt via updateOptions().
Callbacksignatuur: (options: ChatElementOptions) => void
snapshot
Wordt uitgezonden wanneer de interne status van het element verandert.
Callbacksignatuur: (snapshot: ChatElementSnapshot) => void
profileClick
Wordt uitgezonden wanneer de gebruiker op een profiel klikt.
Callbacksignatuur: (ev: CustomEvent<{ id: string; }>) => void
linkClick
Wordt uitgezonden wanneer de gebruiker op een link klikt.
Callbacksignatuur: (ev: CustomEvent<{ url: string; }>) => void
messageSent
Wordt uitgezonden wanneer de gebruiker een bericht verstuurt.
Callbacksignatuur: (ev: CustomEvent<{ id: string; content: string; channelId: string; }>) => void
messageDeleted
Wordt uitgezonden wanneer de gebruiker een bericht verwijdert.
Callbacksignatuur: (ev: CustomEvent<{ id: string; }>) => void
experienceClick
Wordt uitgezonden wanneer de gebruiker op een vermelding van een experience klikt.
Callbacksignatuur: (ev: CustomEvent<{ id: string; }>) => void
attachmentClick
Wordt uitgezonden wanneer de gebruiker op een bijlage klikt.
Callbacksignatuur: (ev: CustomEvent<{ messageId: string; attachments: AttachmentClickEventAttachment[]; }>) => void
Methoden
mount(container)
Koppel het element aan een DOM-container.
De container moet een leeg element zijn. Het element wordt als child toegevoegd.
Als het element al gekoppeld is, logt deze methode een waarschuwing en keert terug.
unmount()
Verwijder het element uit de DOM en ruim alle event listeners op.
Na het ontkoppelen mag de elementinstantie niet opnieuw worden gebruikt.
Maak een nieuwe elementinstantie aan als je opnieuw wilt koppelen.
updateOptions(options)
Werk de configuratieopties van het element bij na het aanmaken.
Alleen de opgegeven opties worden bijgewerkt; andere opties blijven ongewijzigd.
Het element wordt opnieuw gerenderd met de nieuwe opties.
getSnapshot()
Haal de huidige status-snapshot van het element op.
De snapshot bevat de huidige interne status van het element, zoals
de laadstatus, formulierwaarden of andere elementspecifieke gegevens.
Retourneert: ChatElementSnapshot
Styling
Pas dit element aan metappearance.classes. Zie de stylingreferentie voor de volledige lijst met stabiele klassenamen en voorbeeldsnippets.
Types
ChatElementOptions
Configuratieopties voor de ChatElement.ChatElementSnapshot
Vertegenwoordigt de huidige status van de ChatElement. Gebruikelement.getSnapshot() om de huidige status op te halen, of luister naar het event snapshot voor wijzigingen.

