Aller au contenu
Livstick Développeurs

Événements

Événements personnalisés composés et propagés (bubbling), émis sur le Custom Element. Le composant React appelle la prop équivalente au lieu d’émettre un événement, avec la même forme de detail. Un InitError — le payload de livstick:error — a la forme { code: string, message: string, details?: string, status?: number, source: "client" | "server" }.

Nom Type Par défaut Description
livstick:ready CustomEvent<ReadyEventDetail> Émis une fois le widget initialisé. Prop React : onReady. Propriété detail : { instanceId, uid }.
livstick:route-change CustomEvent<RouteChangeEventDetail> Émis chaque fois que le widget passe à une autre route du parcours d’enregistrement. Prop React : onRouteChange. Propriété detail : { instanceId, route }, où route est l’une des routes du parcours listées ci-dessous.
livstick:recorded CustomEvent<RecordedEventDetail> Émis une fois l’enregistrement envoyé et le message créé. Prop React : onRecorded. Propriété detail : { instanceId, uid, messageId }.
livstick:error CustomEvent<ErrorEventDetail> Émis quand le widget ne parvient pas à s’initialiser ou à mener une opération à bien. Prop React : onError. Propriété detail : { instanceId, error }, où error est un InitError.

Méthodes

Exposées sur l’instance du Custom Element — appelez-les une fois l’élément connecté au document. Le composant React expose les trois mêmes via un handle de ref.

Nom Type Par défaut Description
record() () => void Démarre l’enregistrement par programme, sans que le visiteur ait à utiliser les commandes du widget.
reset() () => void Ramène le widget à son état initial.
cancelUpload() () => void Annule un envoi en cours.

Routes du parcours

Les valeurs que porte le champ route d’un événement livstick:route-change.

Nom Type Par défaut Description
record string L’écran d’enregistrement : la capture commence ici.
loading string L’écran affiché pendant l’envoi d’un enregistrement.
finish string L’écran affiché une fois le message créé.