api.access
api.access.deny(code, reason)
apiオブジェクトにリファレンスを返します。
| パラメーター | 説明 |
|---|---|
code | 文字列。ログインの拒絶を判断するOAuthエラーコード。次のうちの一つです： |
reason | 文字列。アクセストークン付与を拒否するための人間が理解できる説明。 |
api.accessToken
api.accessToken.setCustomClaim(name, value)
apiオブジェクトへの参照を返します。
| パラメーター | 説明 |
|---|---|
name | 文字列。クレームの名前（これは完全修飾URLの必要がある場合があります）。 |
value | 任意の値。クレームの値。 |
api.cache
api.cache.delete(key)
CacheWriteResultオブジェクトにtype: "success"を含めて返します。操作に失敗すると、type: "error"を返します。エラーの場合には、返すオブジェクトにcodeプロパティを含めて、失敗の詳細を示します。
| パラメーター | 説明 |
|---|---|
key | 文字列。キャッシュに保管されているレコードのキー。 |
api.cache.get(key)
keyにキャッシュ済みの値が存在する場合は、それを記述したレコードを取得します。レコードが見つかった場合には、返されたオブジェクトのvalueプロパティにキャッシュ済みの値があります。
提供された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 | 任意の数値。このキャッシュエントリーのミリ秒単位で指定した存続時間。キャッシュ済みのレコードは早期に削除されることはあっても、 注意：この値が |