chrome.instanceID

説明

chrome.instanceID を使用して Instance ID サービスにアクセスします。

権限

gcm

対象

Chrome 44 以降

メソッド

deleteID()

chrome.instanceID.deleteID(): Promise<void>

アプリ インスタンス識別子をリセットし、それに関連付けられているすべてのトークンを取り消します。

戻り値

  • Promise<void>

    Chrome 96 以降

deleteToken()

chrome.instanceID.deleteToken(
  deleteTokenParams: object,
): Promise<void>

付与されたトークンを取り消します。

パラメータ

  • deleteTokenParams

    オブジェクト

    deleteToken のパラメータ。

    • authorizedEntity

      文字列

      Chrome 46 以降

      トークンの取得に使用される承認済みエンティティ。

    • スコープ

      文字列

      Chrome 46 以降

      トークンの取得に使用されるスコープ。

戻り値

  • Promise<void>

    Chrome 96 以降

getCreationTime()

chrome.instanceID.getCreationTime(): Promise<number>

InstanceID が生成された時刻を取得します。作成時間は callback によって返されます。

戻り値

  • Promise<number>

    Chrome 96 以降

getID()

chrome.instanceID.getID(): Promise<string>

アプリ インスタンスの識別子を取得します。インスタンス ID は callback によって返されます。アプリケーション ID が取り消されるか期限切れにならない限り、同じ ID が返されます。

戻り値

  • Promise<string>

    Chrome 96 以降

getToken()

chrome.instanceID.getToken(
  getTokenParams: object,
): Promise<string>

認可されたエンティティがスコープで定義されたサービスにアクセスできるようにするトークンを返します。

パラメータ

  • getTokenParams

    オブジェクト

    getToken のパラメータ。

    • authorizedEntity

      文字列

      Chrome 46 以降

      このインスタンス ID に関連付けられたリソースへのアクセス権を持つエンティティを識別します。Google デベロッパー コンソールのプロジェクト ID を指定できます。

    • オプション

      オブジェクト 省略可

      Chrome 46 以降 Chrome 89 以降で非推奨

      オプションは非推奨であり、無視されます。

      トークンに関連付けられ、リクエストの処理で使用される可能性のある少数の文字列 Key-Value ペアを含めることができます。

    • スコープ

      文字列

      Chrome 46 以降

      認可されたエンティティが実行できる認可済みアクションを特定します。たとえば、GCM メッセージを送信する場合は、GCM スコープを使用する必要があります。

戻り値

  • Promise<string>

    Chrome 96 以降

イベント

onTokenRefresh

chrome.instanceID.onTokenRefresh.addListener(
  callback: function,
)

付与されたすべてのトークンを更新する必要がある場合に発生します。

パラメータ

  • callback

    関数

    callback パラメータは次のようになります。 

    () => void