custom-email-providerアクショントリガーのAPIオブジェクトは以下を含みます。
api.cache
api.cache.delete(key)
CacheWriteResultオブジェクトにtype: "success"を含めて返します。操作に失敗すると、type: "error"を返します。エラーの場合には、返すオブジェクトにcodeプロパティを含めて、失敗の詳細を示します。
| パラメーター | 説明 |
|---|---|
key | 文字列。キャッシュに保管されているレコードのキー。 |
api.cache.get(key)
keyにキャッシュ済みの項目が存在する場合は、それを記述したレコードを返します。キャッシュレコードは、キャッシュされた値のあるvalueプロパティと、レコードの最大有効期限をUNIXエポックからのミリ秒単位で示すexpires_atプロパティを含むオブジェクトです。
重要 ：このキャッシュは、短命で一時的なデータ向けに設計されています。項目が所定のライフタイム内であったとしても、後のトランザクションでは利用できないかもしれません。
| パラメーター | 説明 |
|---|---|
key | 文字列。キャッシュに保管されているレコードのキー。 |
api.cache.set(key, value, [options])
ttlまたはexpires_at値までのライフタイムがあります。ライフタイムが指定されない場合には、デフォルトのライフタイムである15分が使用されます。ライフタイムはアクションのキャッシュ制限が定める最大値を超過してはいけません。
| パラメーター | 説明 |
|---|---|
key | 文字列。キャッシュに保管されているレコードのキー。 |
value | 文字列。保管するレコードの値。 |
options | 任意のオブジェクト。キャッシュの動作を調整するためのオプション。 |
options.expires_at | 任意の数字。UNIXエポックからのミリ秒単位で指定した絶対有効期限。キャッシュ済みのレコードは早期に削除されることはあっても、 注意：この値が |
options.ttl | 任意の数値。このキャッシュエントリーのミリ秒単位で指定した存続時間。キャッシュ済みのレコードは早期に削除されることはあっても、 注意：この値が |
api.notification
api.notification.drop(reason)
(fn)のエラーがログに記録されますが、今後アクションに再度送信されることはありません。
この通知イベントを再試行する必要がある場合は、代わりにapi.notification.retryを呼び出すことを検討してください。
| パラメーター | 説明 |
|---|---|
reason | 任意の文字列。これはログエントリの一部となり、エラーをさらに分析するのに役立ちます。このフィールドは1024文字までに制限されており、それを超える場合は切り捨てられることに注意してください。 |
api.notification.retry(reason)
(fn)のエラーがログに記録されますが、数分以内に最大5回再試行されます。
この通知イベントを再試行しない必要がある場合は、代わりにapi.notification.dropを呼び出すことを検討してください。
| パラメーター | 説明 |
|---|---|
reason | 任意の文字列。これはログエントリの一部となり、エラーをさらに分析するのに役立ちます。このフィールドは1024文字までに制限されており、それを超える場合は切り捨てられることに注意してください。 |