説明
chrome.instanceID
を使用してインスタンス ID サービスにアクセスします。
権限
gcm
対象
Methods
deleteID()
chrome.instanceID.deleteID(
callback?: function,
)
アプリ インスタンス ID をリセットし、それに関連付けられているすべてのトークンを取り消します。
パラメータ
-
callback
関数(省略可)
callback
パラメータは次のようになります。() => void
戻り値
-
Promise<void>
Chrome 96 以降Promise は Manifest V3 以降でサポートされていますが、コールバックは下位互換性のために提供されています。同じ関数呼び出しで両方を使用することはできません。Promise は、コールバックに渡されたのと同じ型で解決されます。
deleteToken()
chrome.instanceID.deleteToken(
deleteTokenParams: object,
callback?: function,
)
付与されたトークンを取り消します。
パラメータ
-
deleteTokenParams
オブジェクト
deleteToken のパラメータ。
-
authorizedEntity
文字列
Chrome 46 以降トークンを取得するために使用される承認済みエンティティ。
-
スコープ
文字列
Chrome 46 以降トークンを取得するために使用されるスコープ。
-
-
callback
関数(省略可)
callback
パラメータは次のようになります。() => void
戻り値
-
Promise<void>
Chrome 96 以降Promise は Manifest V3 以降でサポートされていますが、コールバックは下位互換性のために提供されています。同じ関数呼び出しで両方を使用することはできません。Promise は、コールバックに渡されたのと同じ型で解決されます。
getCreationTime()
chrome.instanceID.getCreationTime(
callback?: function,
)
InstanceID が生成された時刻を取得します。作成時刻は callback
によって返されます。
パラメータ
-
callback
関数(省略可)
callback
パラメータは次のようになります。(creationTime: number) => void
-
creationTime
数値
インスタンス ID が生成された時刻(エポックからのミリ秒数)。
-
戻り値
-
Promise<数値>
Chrome 96 以降Promise は Manifest V3 以降でサポートされていますが、コールバックは下位互換性のために提供されています。同じ関数呼び出しで両方を使用することはできません。Promise は、コールバックに渡されたのと同じ型で解決されます。
getID()
chrome.instanceID.getID(
callback?: function,
)
アプリ インスタンスの識別子を取得します。インスタンス ID は callback
によって返されます。アプリケーション ID が失効または期限切れになっていない限り、同じ ID が返されます。
パラメータ
-
callback
関数(省略可)
callback
パラメータは次のようになります。(instanceID: string) => void
-
instanceID
文字列
アプリ インスタンスに割り当てられたインスタンス ID。
-
戻り値
-
Promise<文字列>
Chrome 96 以降Promise は Manifest V3 以降でサポートされていますが、コールバックは下位互換性のために提供されています。同じ関数呼び出しで両方を使用することはできません。Promise は、コールバックに渡されたのと同じ型で解決されます。
getToken()
chrome.instanceID.getToken(
getTokenParams: object,
callback?: function,
)
承認されたエンティティに、スコープで定義されたサービスへのアクセスを許可するトークンを返します。
パラメータ
-
getTokenParams
オブジェクト
getToken のパラメータ。
-
authorizedEntity
文字列
Chrome 46 以降このインスタンス ID に関連付けられているリソースへのアクセスが認可されているエンティティを識別します。Google Developers Console のプロジェクト ID を指定できます。
-
オプション
オブジェクト 省略可
Chrome 46 以降 Chrome 89 以降で非推奨サポートが終了しているため、無視されます。
トークンに関連付けられ、リクエストの処理に使用できる少数の文字列の Key-Value ペアを含めることができます。
-
スコープ
文字列
Chrome 46 以降承認されたエンティティが実行できる承認済みアクションを指定します。たとえば、GCM メッセージを送信する場合は、
GCM
スコープを使用する必要があります。
-
-
callback
関数(省略可)
callback
パラメータは次のようになります。(token: string) => void
-
token
文字列
リクエストされたサービスによって割り当てられたトークン。
-
戻り値
-
Promise<文字列>
Chrome 96 以降Promise は Manifest V3 以降でサポートされていますが、コールバックは下位互換性のために提供されています。同じ関数呼び出しで両方を使用することはできません。Promise は、コールバックに渡されたのと同じ型で解決されます。
イベント
onTokenRefresh
chrome.instanceID.onTokenRefresh.addListener(
callback: function,
)
付与されたすべてのトークンを更新する必要がある場合に呼び出されます。
パラメータ
-
callback
機能
callback
パラメータは次のようになります。() => void