Déclencheurs Actions : event-stream - objet API

Découvrez l’objet API du déclencheur event-stream d’Actions.

L’objet API du déclencheur event-stream 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 à une valeur mise en cache pour la clé fournie, s’il existe.

key · string

Clé de l’enregistrement du cache à supprimer.

​

api.cache.get(key)

Récupère un enregistrement décrivant une valeur mise en cache associée à la clé fournie, s’il existe. Si un enregistrement est trouvé, la valeur mise en cache est accessible dans la propriété value de l’objet renvoyé.

key · string

La clé de l’enregistrement stocké dans le cache.

​

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

Stocke ou met à jour une valeur de type chaîne 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 façon 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 les limites du cache des Actions.

Important : Ce cache est conçu pour des données éphémères à courte durée de vie. Il se peut que des éléments ne soient pas disponibles dans des transactions ultérieures, même s’ils se situent toujours dans leur durée de vie spécifiée.

key · string

Clé de l’enregistrement à stocker.

value · string

Valeur de l’enregistrement à stocker.

options · cachesetoptions · optional

Options permettant d’ajuster le comportement du cache.

Masquer propriétés de options

expires_at · number · optional

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 aussi été fournie pour ttl. Si les deux options sont fournies, l’expiration la plus rapprochée des deux sera utilisée.

ttl · number · optional

Valeur de 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 aussi été fournie pour expires_at. Si les deux options sont fournies, l’expiration la plus rapprochée des deux sera utilisée.