Skip to main content

Vue d’ensemble

Un élément d’interface qui affiche une interface de chat.

Utilisation

Utilisation de base

Écouter les événements

Événements

Événements émis par le ChatElement. Écoutez ces événements avec la méthode on() ou en passant des fonctions de rappel dans les options.

error

Émis lorsqu’une erreur se produit pendant l’initialisation ou le fonctionnement de l’élément. Signature du callback : (error: unknown) => void

ready

Émis lorsque l’élément a fini de se charger et est prêt pour l’interaction de l’utilisateur. Signature du callback : (element: ChatElement) => void

optionsUpdated

Émis lorsque les options de l’élément sont mises à jour via updateOptions(). Signature du callback : (options: ChatElementOptions) => void

snapshot

Émis lorsque l’état interne de l’élément change. Signature du callback : (snapshot: ChatElementSnapshot) => void

profileClick

Émis lorsque l’utilisateur clique sur un profil. Signature du callback : (ev: CustomEvent<{ id: string; }>) => void

linkClick

Émis lorsque l’utilisateur clique sur un lien. Signature du callback : (ev: CustomEvent<{ url: string; }>) => void

messageSent

Émis lorsque l’utilisateur envoie un message. Signature du callback : (ev: CustomEvent<{ id: string; content: string; channelId: string; }>) => void

messageDeleted

Émis lorsque l’utilisateur supprime un message. Signature du callback : (ev: CustomEvent<{ id: string; }>) => void

experienceClick

Émis lorsque l’utilisateur clique sur une mention d’expérience. Signature du callback : (ev: CustomEvent<{ id: string; }>) => void

attachmentClick

Émis lorsque l’utilisateur clique sur une pièce jointe. Signature du callback : (ev: CustomEvent<{ messageId: string; attachments: AttachmentClickEventAttachment[]; }>) => void

Méthodes

mount(container)

Monte l’élément dans un conteneur du DOM. Le conteneur doit être un élément vide. L’élément y sera ajouté en tant qu’enfant. Si l’élément est déjà monté, cette méthode affiche un avertissement dans la console et s’arrête.

unmount()

Retire l’élément du DOM et supprime tous les écouteurs d’événements. Après le démontage, l’instance de l’élément ne doit pas être réutilisée. Créez une nouvelle instance de l’élément si vous devez le monter à nouveau.

updateOptions(options)

Met à jour les options de configuration de l’élément après sa création. Seules les options fournies sont mises à jour ; les autres options restent inchangées. L’élément se réaffiche avec les nouvelles options.

getSnapshot()

Récupère l’instantané de l’état actuel de l’élément. L’instantané contient l’état interne actuel de l’élément, comme le statut de chargement, les valeurs de formulaire ou d’autres données propres à l’élément. Renvoie : ChatElementSnapshot

Style

Personnalisez cet élément avec appearance.classes. Consultez la référence de style pour la liste complète des noms de classes stables et des exemples d’extraits.

Types

ChatElementOptions

Options de configuration du ChatElement.

ChatElementSnapshot

Représente l’état actuel du ChatElement. Utilisez element.getSnapshot() pour obtenir l’état actuel, ou écoutez l’événement snapshot pour suivre les changements.