Skip to main content

Oversigt

Et UI-element, der viser en chatgrænseflade.

Brug

Grundlæggende brug

Lyt efter hændelser

Hændelser

Hændelser, der udsendes af ChatElement. Lyt efter disse hændelser med metoden on() eller ved at sende callback-funktioner med i indstillingerne.

error

Udsendes, når der opstår en fejl under elementets initialisering eller drift. Callback-signatur: (error: unknown) => void

ready

Udsendes, når elementet er færdig med at indlæse og er klar til brugerinteraktion. Callback-signatur: (element: ChatElement) => void

optionsUpdated

Udsendes, når elementets indstillinger opdateres via updateOptions(). Callback-signatur: (options: ChatElementOptions) => void

snapshot

Udsendes, når elementets interne tilstand ændres. Callback-signatur: (snapshot: ChatElementSnapshot) => void

profileClick

Udsendes, når brugeren klikker på en profil. Callback-signatur: (ev: CustomEvent<{ id: string; }>) => void

linkClick

Udsendes, når brugeren klikker på et link. Callback-signatur: (ev: CustomEvent<{ url: string; }>) => void

messageSent

Udsendes, når brugeren sender en besked. Callback-signatur: (ev: CustomEvent<{ id: string; content: string; channelId: string; }>) => void

messageDeleted

Udsendes, når brugeren sletter en besked. Callback-signatur: (ev: CustomEvent<{ id: string; }>) => void

experienceClick

Udsendes, når brugeren klikker på en omtale af en experience. Callback-signatur: (ev: CustomEvent<{ id: string; }>) => void

attachmentClick

Udsendes, når brugeren klikker på en vedhæftet fil. Callback-signatur: (ev: CustomEvent<{ messageId: string; attachments: AttachmentClickEventAttachment[]; }>) => void

Metoder

mount(container)

Monter elementet i en DOM-container. Containeren skal være et tomt element. Elementet tilføjes som et underelement. Hvis elementet allerede er monteret, logger denne metode en advarsel og returnerer.

unmount()

Fjern elementet fra DOM’en, og ryd op i alle event listeners. Efter afmontering bør elementinstansen ikke genbruges. Opret en ny elementinstans, hvis du skal montere igen.

updateOptions(options)

Opdater elementets konfigurationsindstillinger efter oprettelse. Kun de angivne indstillinger opdateres; andre indstillinger forbliver uændrede. Elementet gengives igen med de nye indstillinger.

getSnapshot()

Hent det aktuelle tilstands-snapshot af elementet. Snapshottet indeholder elementets aktuelle interne tilstand, såsom indlæsningsstatus, formularværdier eller andre elementspecifikke data. Returnerer: ChatElementSnapshot

Styling

Tilpas dette element med appearance.classes. Se styling-referencen for den fulde liste over stabile klassenavne og eksempelsnippets.

Typer

ChatElementOptions

Konfigurationsindstillinger for ChatElement.

ChatElementSnapshot

Repræsenterer den aktuelle tilstand af ChatElement. Brug element.getSnapshot() til at hente den aktuelle tilstand, eller lyt efter snapshot-hændelsen for ændringer.