Actions Triggers: post-change-password - API オブジェクト

post-change-password Action トリガーの API オブジェクトについて説明します。

post-change-password Actions トリガーの API オブジェクトには、以下が含まれます。

​

api.cache

実行間で保持されるデータを保存および取得します。

​

api.cache.delete(key)

指定した key に対応するキャッシュレコードが存在する場合は、削除します。

key · string

削除するキャッシュレコードのキー。

​

api.cache.get(key)

指定されたキーのキャッシュ済みの値を示すレコードが存在する場合は、 そのレコードを取得します。レコードが見つかった場合、キャッシュされた値は 返されたオブジェクトの value プロパティに格納されています。

key · string

キャッシュに保存されているレコードのキー。

​

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

指定したキーに文字列値をキャッシュへ保存または更新します。

このキャッシュに保存された値のスコープは、それらが設定された Trigger に限定されます。 また、Actions Cache Limits の制限が適用されます。

この方法で保存された値の有効期間は、指定した ttl または expires_at の値までの 最大 です。有効期間を指定しない場合は、 デフォルトで 15 分が使用されます。有効期間は、 Actions Cache Limits に記載されている最大時間を超えることはできません。

重要: このキャッシュは、短期間の一時的なデータ向けに設計されています。項目は、 指定した有効期間内であっても、後続のトランザクションでは利用できない場合があります。

key · string

保存するレコードのキー。

value · string

保存するレコードの値。

options · cachesetoptions · optional

キャッシュの動作を調整するためのオプション。

非表示 options properties

expires_at · number · optional

Unix エポックからの経過時間をミリ秒で表した絶対有効期限です。 キャッシュされたレコードはこれより前に削除されることがありますが、 指定した expires_at を超えて保持されることはありません。

注: ttl にも 値を指定している場合は、この値を指定しないでください。両方のオプションを指定した場合は、 2 つのうち早い方の有効期限が使用されます。

ttl · number · optional

このキャッシュエントリの有効期間 (time-to-live) をミリ秒で表した値です。 キャッシュされた値はこれより前に削除されることがありますが、 指定した ttl を超えて保持されることはありません。

注: expires_at にも 値を指定している場合は、この値を指定しないでください。両方のオプションを指定した場合は、 2 つのうち早い方の有効期限が使用されます。