Actions トリガー: post-user-registration - API オブジェクト

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

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

api.cache

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

api.cache.delete(key)

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

キャッシュから値が削除された場合は、type: "success" を持つ CacheWriteResult オブジェクトを返します。操作に失敗した場合は、type: "error" を返します。エラー時には、返されるオブジェクトに、失敗の内容を示す code プロパティが含まれます。

パラメーター	説明
key	String。キャッシュに格納されているレコードのキー。

api.cache.get(key)

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

指定した key に対応する項目がキャッシュ内で見つかった場合は、キャッシュレコードを返します。キャッシュレコードはオブジェクトで、キャッシュされた値を保持する value プロパティと、Unix エポックからの経過時間をミリ秒単位で表したレコードの最大有効期限を示す expires_at プロパティを持ちます。

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

Parameter	Description
key	String. キャッシュに保存されているレコードのキー。

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

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

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

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

Parameter	Description
key	String. キャッシュに保存されるレコードのキー。
value	String. 保存するレコードの値。
options	Optional object. キャッシュの動作を調整するためのオプション。
options.expires_at	Optional number. Unix エポックからの経過時間をミリ秒で表した絶対有効期限。キャッシュされたレコードはそれより前に削除される場合がありますが、指定された expires_at を過ぎて保持されることはありません。 Note: ttl にも値が指定されている場合、この値は指定しないでください。両方のオプションが指定された場合は、2 つのうち早い方の有効期限が使用されます。
options.ttl	Optional number. このキャッシュエントリの有効期間 (ミリ秒) 。キャッシュされた値はそれより前に削除される場合がありますが、指定された ttl を過ぎて保持されることはありません。 Note: expires_at にも値が指定されている場合、この値は指定しないでください。両方のオプションが指定された場合は、2 つのうち早い方の有効期限が使用されます。