Déclencheurs Actions : post-user-registration - objet API

Découvrez l’objet API du déclencheur post-user-registration d’Actions.

L’objet API du déclencheur post-user-registration d’Actions comprend :

api.cache

Stocker et récupérer des données conservées d’une exécution à l’autre.

api.cache.delete(key)

Supprime l’enregistrement correspondant à la valeur mise en cache associée à la clé fournie, s’il existe.

Retourne un objet CacheWriteResult avec type: "success" si une valeur a été supprimée du cache. En cas d’échec, l’opération retourne type: "error". En cas d’erreur, l’objet retourné comporte une propriété code qui indique la nature de l’échec.

Paramètre	Description
key	String. La clé de l’enregistrement stocké dans le cache.

api.cache.get(key)

Récupère un enregistrement décrivant une valeur mise en cache associée à la key fournie, si elle existe. Si un enregistrement est trouvé, la valeur mise en cache se trouve dans la propriété value de l’objet renvoyé.

Retourne un enregistrement du cache si un élément est trouvé dans le cache pour la key fournie. Les enregistrements du cache sont des objets dotés d’une propriété value contenant la valeur mise en cache, ainsi que d’une propriété expires_at indiquant l’heure d’expiration maximale de l’enregistrement, en millisecondes depuis l’époque Unix.

Important : Ce cache est conçu pour des données éphémères de courte durée. Il est possible que des éléments ne soient pas disponibles dans des transactions ultérieures, même s’ils se trouvent encore dans leur durée de vie prévue.

Paramètre	Description
key	String. La clé de l’enregistrement stocké dans le cache.

api.cache.set(key, value, [options])

Stocke ou met à jour une chaîne de caractères dans le cache à la clé spécifiée.

Les valeurs stockées dans ce cache sont limitées au déclencheur dans lequel elles sont définies. Elles sont soumises aux limites du cache des Actions.

Les valeurs stockées de cette manière auront une durée de vie pouvant aller jusqu’aux valeurs ttl ou expires_at spécifiées. Si aucune durée de vie n’est spécifiée, une durée de vie par défaut de 15 minutes sera utilisée. Les durées de vie ne peuvent pas dépasser la durée maximale indiquée dans limites du cache des Actions.

Paramètre	Description
key	Chaîne. La clé de l’enregistrement stocké dans le cache.
value	Chaîne. La valeur de l’enregistrement à stocker.
options	Objet facultatif. Options permettant d’ajuster le comportement du cache.
options.expires_at	Nombre facultatif. L’heure d’expiration absolue, en millisecondes depuis l’époque Unix. Bien que les enregistrements mis en cache puissent être évincés plus tôt, ils ne seront jamais conservés au-delà de la valeur expires_at fournie. Remarque : Cette valeur ne doit pas être fournie si une valeur a également été fournie pour ttl. Si les deux options sont fournies, l’expiration la plus proche sera utilisée.
options.ttl	Nombre facultatif. La durée de vie de cette entrée de cache, en millisecondes. Bien que les valeurs mises en cache puissent être évincées plus tôt, elles ne seront jamais conservées au-delà de la valeur ttl fournie. Remarque : Cette valeur ne doit pas être fournie si une valeur a également été fournie pour expires_at. Si les deux options sont fournies, l’expiration la plus proche sera utilisée.