説明
chrome.instanceID を使用して Instance ID サービスにアクセスします。
権限
gcm対象
メソッド
deleteID()
browser.instanceID.deleteID(): Promise<void>
アプリ インスタンス識別子をリセットし、それに関連付けられているすべてのトークンを取り消します。
戻り値
-
Promise<void>
Chrome 96 以降 Chrome 148 以降の browser.*削除が完了すると解決されます。Promise が拒否されなかった場合、インスタンス ID は正常に取り消されています。
deleteToken()
browser.instanceID.deleteToken(
deleteTokenParams: object,
): Promise<void>
付与されたトークンを取り消します。
パラメータ
-
deleteTokenParams
オブジェクト
deleteToken のパラメータ。
-
authorizedEntity
文字列
Chrome 46 以降 Chrome 148 以降の browser.*トークンの取得に使用される認可された事業体。
-
スコープ
文字列
Chrome 46 以降 Chrome 148 以降の browser.*トークンの取得に使用されるスコープ。
-
戻り値
-
Promise<void>
Chrome 96 以降 Chrome 148 以降の browser.*トークンの削除が完了すると解決されます。Promise が拒否されなければ、トークンは正常に取り消されています。
getCreationTime()
browser.instanceID.getCreationTime(): Promise<number>
InstanceID が生成された時刻を取得します。作成時間は callback によって返されます。
戻り値
-
Promise<number>
Chrome 96 以降 Chrome 148 以降の browser.*取得が完了すると解決されます。
getID()
browser.instanceID.getID(): Promise<string>
アプリ インスタンスの識別子を取得します。インスタンス ID は callback によって返されます。アプリケーション ID が取り消されるか、有効期限が切れるまで、同じ ID が返されます。
戻り値
-
Promise<string>
Chrome 96 以降 Chrome 148 以降の browser.*取得が完了すると解決されます。
getToken()
browser.instanceID.getToken(
getTokenParams: object,
): Promise<string>
認可された事業体がスコープで定義されたサービスにアクセスできるようにするトークンを返します。
パラメータ
-
getTokenParams
オブジェクト
getToken のパラメータ。
-
authorizedEntity
文字列
Chrome 46 以降 Chrome 148 以降の browser.*このインスタンス ID に関連付けられたリソースへのアクセスを許可されているエンティティを識別します。Google Developer Console のプロジェクト ID を指定できます。
-
オプション
オブジェクト（省略可）
Chrome 46 以降 Chrome 148 以降の browser.* Chrome 89 以降で非推奨オプションは非推奨であり、無視されます。
トークンに関連付けられ、リクエストの処理で使用される可能性のある、少数の文字列 Key-Value ペアを含めることができます。
-
スコープ
文字列
Chrome 46 以降 Chrome 148 以降の browser.*認可された事業体が実行できる認可されたアクションを識別します。たとえば、GCM メッセージを送信するには、
GCMスコープを使用する必要があります。
-
戻り値
-
Promise<string>
Chrome 96 以降 Chrome 148 以降の browser.*取得が完了すると解決されます。
イベント
onTokenRefresh
browser.instanceID.onTokenRefresh.addListener(
callback: function,
)
付与されたすべてのトークンを更新する必要がある場合に呼び出されます。
パラメータ
-
callback
関数
callbackパラメータは次のようになります。() => void