Actions トリガー: send-phone-message - API オブジェクト

send-phone-message Action トリガーの API オブジェクトについて説明します。

send-phone-message Actions トリガーの API オブジェクトには、次の項目が含まれます。

​

api.cache

実行をまたいで保持されるデータを保存・取得します。

​

api.cache.delete(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 のプロパティ

expires_at · number · optional

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

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

ttl · number · optional

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

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