subscribeToForm
Abonnez-vous à un événement de formulaire par marqueur. 🔐 Cette méthode nécessite l'autorisation.
Description
Cette méthode abonne l'utilisateur actuel à un événement de formulaire identifié par son marqueur, pour un enregistrement de données de formulaire spécifique. Elle renvoie une promesse qui se résout en true si l'abonnement a réussi, ou un objet IError s'il y a eu un problème.
Événements.subscribeToForm(
marker*,
body*,
body.formDataId*,
body.status
);
Schéma des paramètres
Schéma
marker(obligatoire): string
Marqueur d'événement
exemple : "form_marker"
body(obligatoire): ISubscribeFormEvent
Corps de l'abonnement. Exemple : { formDataId: 123 }
body.formDataId(obligatoire): number
Identifiant des données de formulaire.
exemple : 123
body.status: string
Statut d'abonnement optionnel.
Exemples
Exemple minimal
const response = await Events.subscribeToForm('form_marker', { formDataId: 123 });
Exemple de réponse
true
Schéma de réponse
Schéma : boolean
boolean: boolean
Renvoie true si l'abonnement a réussi.
exemple : true