Déclencheurs d’actions : post-change-password - Objet API
L’objet API pour le déclencheur d’actions post-change-password
inclut :
api.cache
Stockez et récupérez des données qui persistent entre les exécutions.
api.cache.delete(key)
Supprime un enregistrement décrivant une valeur mise en cache à la clé fournie, si elle existe.
Renvoie un objet CacheWriteResult
avec type: "success"
si une valeur a été supprimée du cache. Une opération échouée renvoie type: "error"
. En cas d’erreur, l’objet renvoyé aura une propriété
code
qui indique la nature de l’échec.
Paramètre | Description |
---|---|
key |
Chaîne. La clé de l’enregistrement est stockée dans le cache. |
api.cache.get(key)
Récupère un enregistrement décrivant une valeur mise en cache à la
key
fournie, si elle existe. Si un enregistrement est trouvé, la valeur mise en cache
peut être trouvée dans la propriété value
de l’objet retourné.
Renvoie un enregistrement de cache si un élément est trouvé dans le cache pour la
key
. Les enregistrements de cache sont des objets dotés d’une propriété
value
contenant la valeur mise en cache et d’une propriété
expires_at
indiquant l’expiration maximale
de l’enregistrement en millisecondes depuis l’époque Unix.
Important : Ce cache est conçu pour des données de courte durée et éphémères. Les éléments peuvent ne pas être disponibles lors de transactions ultérieures, même s’ils sont dans la limite de leur durée de vie.
Paramètre | Description |
---|---|
key |
Chaîne. La clé de l’enregistrement est stockée dans le cache. |
api.cache.set(key, value, [options])
Stockez ou mettez à jour une valeur de chaîne dans le cache à la clé indiqué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 de cache des actions.
Les valeurs stockées de cette manière auront des durées de vie allant jusqu’aux valeurs spécifiées
ttl
ou expires_at
. 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 doivent pas dépasser la durée maximale indiquée dans les
Limites de cache des actions.
Paramètre | Description |
---|---|
key |
Chaîne. La clé de l’enregistrement est stockée 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 |
Numéro facultatif. Le temps d’expiration absolu en millisecondes
depuis l’époque Unix. Bien que les enregistrements mis en cache puissent être expulsés plus tôt,
ils ne resteront jamais au-delà du
Remarque : Cette valeur ne doit pas être fournie si on a aussi
fourni une valeur pour |
options.ttl |
Numéro facultatif. Valeur de la durée de vie de cette entrée de cache
en millisecondes. Bien que les valeurs mises en cache puissent être expulsées plus tôt, elles
ne resteront jamais au-delà de la durée de validité
Remarque : Cette valeur ne doit pas être fournie si on a aussi
fourni une valeur pour |