アクションのトリガー：custom-phone-providerのAPIオブジェクト

api.cache

実行間で維持されるデータの保存と取得を行います。

api.cache.delete(key)

提供されたkeyにキャッシュ済みの値が存在する場合は、それを記述したレコードを削除します。

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

api.cache.get(key)

提供されたkeyにキャッシュ済みの値が存在する場合は、それを記述したレコードを取得します。レコードが見つかった場合には、返されたvalueプロパティにキャッシュ済みの値が含まれます。

提供されたkeyにキャッシュが見つかった場合には、キャッシュレコードを返します。キャッシュレコードはvalueプロパティを含むオブジェクトで、このプロパティにはキャッシュ済みの値の他にもexpires_atプロパティが含まれ、レコードの有効期間をUNIXエポックからの経過ミリ秒数で示します。

重要：このキャッシュは、短命で一時的なデータ向けに設計されています。項目が所定のライフタイム内であったとしても、後のトランザクションでは利用できないかもしれません。

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

指定されたkeyのキャッシュに文字列値を保管または更新します。

このキャッシュに保管された値は、それを設定するトリガーにスコープが限定されます。これはアクションのキャッシュ制限の対象になります。

このように保管された値には、指定されたttlまたはexpires_at値までのライフタイムがあります。ライフタイムが指定されない場合には、デフォルトのライフタイムである15分が使用されます。ライフタイムはアクションのキャッシュ制限が定める最大値を超過してはいけません。

任意の数値です。このキャッシュエントリの存続時間をミリ秒単位で指定します。キャッシュ済みのレコードは早期に削除されることはあっても、ttlで指定された時点を過ぎて存続することはありません。

注意：同じ値がexpires_atで指定されている場合には、この値を指定するべきではありません。両方で指定された場合は、2つの中で早い方の有効期限が適用されます。

api.notification

通知イベントを再試行または中止するべきかをか知らせます。実際の動作については、これらの各メソッドの詳細を参照してください。呼び出しを複数回行った場合には、最後の呼び出しのみが有効になります。

api.notification.drop(reason)

呼び出されると、通知イベントは未回復の失敗として扱われます。

このイベント(fn)はエラーとしてログに記録されますが、その後、アクションには送信されません。

この通知イベントの再試行が必要な場合には、代わりにapi.notification.retryの呼び出しを検討してください。

api.notification.retry(reason)

呼び出されると、通知イベントは失敗として扱われますが、回復する可能性があります。

このイベント(fn)はエラーとしてログに記録され、その後、数分にかけて5回まで再試行されます。

この通知イベントの再試行が不必要な場合には、代わりにapi.notification.dropの呼び出しを検討してください。