API オブジェクト

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

post-user-registration Actions トリガーの API オブジェクトには、次のものが含まれます。

​

api.cache

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

​

api.cache.delete(key)

指定されたキーのキャッシュ値を表すレコードが存在する場合は、削除します。

パラメータ

非表示 パラメータ

key · string

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

​

api.cache.get(key)

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

パラメータ

非表示 パラメータ

key · string

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

​

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

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

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

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

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

パラメータ

非表示 パラメータ

key · string

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

value · string

保存するレコードの値。

options · cachesetoptions

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

表示 options properties

expires_at · number

unix epochからのミリ秒単位の絶対有効期限。 キャッシュされたレコードはこれより早く削除される場合がありますが、 指定した expires_at を超えて保持されることはありません。

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

ttl · number

このキャッシュエントリのミリ秒単位の有効期間。 キャッシュ値はこれより早く削除される場合がありますが、 指定した ttl を超えて保持されることはありません。

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