Aller au contenu principal

getFormSubscriptions

Obtenez toutes les abonnements de formulaire. 🔐 Cette méthode nécessite .

Description​

Cette méthode renvoie tous les abonnements de formulaire de l'utilisateur actuel. Elle renvoie une Promesse qui se résout en un objet IFormSubscriptionsResponse - un conteneur avec items (les entrées IListFormSubscription) et total - pas un tableau nu.

.getFormSubscriptions(

,

);

Schéma des paramètres​

Schéma

offset: number
Décalage optionnel pour la pagination. Par défaut : 0
exemple : 0

limit: number
Limite optionnelle pour la pagination. Par défaut : 30
exemple : 30

Par défaut, vous pouvez récupérer 10 objets. Cela est dû à la limite d'enregistrement dans les paramètres de permissions du module.
Pour que la pagination fonctionne correctement, vous devez configurer les permissions du module (ouvre dans un nouvel onglet) selon vos besoins dans la section correspondante.*

Exemples​

Exemple minimal​

const response = await Events.getFormSubscriptions();

Exemple avec des attributs​

const response = await Events.getFormSubscriptions(0, 30);

Exemple de réponse​

{
  "total": 0,
  "items": []
}

Schéma de réponse​

Schéma : IFormSubscriptionsResponse

items: IListFormSubscription[]
Tableau des abonnements de formulaire.

items.eventMarker: string
Marqueur d'événement.
exemple : "form_marker"

items.formDataId: number
Identifiant des données du formulaire.
exemple : 123

total: number
Nombre total d'abonnements.
exemple : 0