api.access
ログインしようとしているユーザーのアクセスを変更します。たとえば、ログイン試行を拒否できます。
api.access.deny(reason, userMessage)
ユーザーの登録を拒否します。このActionの完了後、サインアップフローは直ちに停止し、
以降のActionsは実行されません。
パラメータ
api.user
ログインするユーザーのメタデータを変更します。
api.user.setAppMetadata(key, value)
ログイン中のユーザーのアプリケーション固有のメタデータを設定します。
注: このメソッドはコールバック内では使用しないでください。このメソッドを呼び出しても、メタデータはすぐには更新されません。
同じフロー内の複数のActionsでこのメソッドを複数回呼び出すことができます。エンジンは変更を集約し、
フローの完了前にメタデータをまとめて更新します。
パラメータ
api.user.setUserMetadata(key, value)
ログインしているユーザーの一般メタデータを設定します。
注: このメソッドはコールバック内で使用しないでください。このメソッドを呼び出しても、メタデータはすぐには更新されません。
同じフロー内の複数のActionsでこのメソッドを複数回呼び出すことができます。エンジンが変更を集約し、
フローの完了前にメタデータをまとめて更新します。
パラメータ
api.cache
実行間で保持されるデータを保存・取得します。
api.cache.delete(key)
指定したキーのキャッシュ値を表すレコードが存在する場合、そのレコードを削除します。
パラメータ
api.cache.get(key)
指定したキーに対応するキャッシュ値のレコードが存在する場合は、それを取得します。レコードが見つかった場合、キャッシュ値は返されたオブジェクトの value プロパティで取得できます。
パラメータ
api.cache.set(key, value, options)
指定したキーに文字列値をキャッシュへ保存または更新します。
このキャッシュに保存された値は、設定されたトリガーにスコープが設定されます。
また、Actions Cache Limits の制限が適用されます。
この方法で保存された値の有効期間は、指定した
ttl または expires_at の値までです。有効期間を指定しない場合、デフォルトで
15 分が使用されます。有効期間は、Actions Cache Limits に記載された最大
期間を超えることはできません。
重要: このキャッシュは、短期間の一時的なデータ用に設計されています。指定した有効期間内であっても、
後続のトランザクションでは項目を利用できない場合があります。
パラメータ