chrome.instanceID

Description
Use chrome.instanceID to access the Instance ID service.
Permissions
gcm
Availability
Chrome 44+

Summary

Methods
deleteID
deleteToken
getCreationTime
getID
getToken
Events
onTokenRefresh

Methods

deleteID

chrome.instanceID.deleteID(
  callback?: function,
)

Promise

Resets the app instance identifier and revokes all tokens associated with it.

Parameters

callback
function optional
The callback parameter looks like: () => void

Returns

Promise<void>
Pending
This only returns a Promise when the callback parameter is not specified, and with MV3+. The type inside the Promise is the same as the 1st argument to callback.

deleteToken

chrome.instanceID.deleteToken(
  deleteTokenParams: object,
  callback?: function,
)

Promise

Revokes a granted token.

Parameters

deleteTokenParams
object
Parameters for deleteToken.
- authorizedEntity
  string
  Chrome 45+
  The authorized entity that is used to obtain the token.
- scope
  string
  Chrome 45+
  The scope that is used to obtain the token.
callback
function optional
The callback parameter looks like: () => void

Returns

Promise<void>
Pending
This only returns a Promise when the callback parameter is not specified, and with MV3+. The type inside the Promise is the same as the 1st argument to callback.

getCreationTime

chrome.instanceID.getCreationTime(
  callback?: function,
)

Promise

Retrieves the time when the InstanceID has been generated. The creation time will be returned by the callback.

Parameters

callback
function optional
The callback parameter looks like: (creationTime: number) => void
- creationTime
  number
  The time when the Instance ID has been generated, represented in milliseconds since the epoch.

Returns

Promise<number>
Pending
This only returns a Promise when the callback parameter is not specified, and with MV3+. The type inside the Promise is the same as the 1st argument to callback.

getID

chrome.instanceID.getID(
  callback?: function,
)

Promise

Retrieves an identifier for the app instance. The instance ID will be returned by the callback. The same ID will be returned as long as the application identity has not been revoked or expired.

Parameters

callback
function optional
The callback parameter looks like: (instanceID: string) => void
- instanceID
  string
  An Instance ID assigned to the app instance.

Returns

Promise<string>
Pending
This only returns a Promise when the callback parameter is not specified, and with MV3+. The type inside the Promise is the same as the 1st argument to callback.

getToken

chrome.instanceID.getToken(
  getTokenParams: object,
  callback?: function,
)

Promise

Return a token that allows the authorized entity to access the service defined by scope.

Parameters

getTokenParams
object
Parameters for getToken.
- authorizedEntity
  string
  Chrome 45+
  Identifies the entity that is authorized to access resources associated with this Instance ID. It can be a project ID from Google developer console.
- options
  object optional
  Chrome 45+ Deprecated since Chrome 89
  options are deprecated and will be ignored.
  Allows including a small number of string key/value pairs that will be associated with the token and may be used in processing the request.
- scope
  string
  Chrome 45+
  Identifies authorized actions that the authorized entity can take. E.g. for sending GCM messages, GCM scope should be used.
callback
function optional
The callback parameter looks like: (token: string) => void
- token
  string
  A token assigned by the requested service.

Returns

Promise<string>
Pending
This only returns a Promise when the callback parameter is not specified, and with MV3+. The type inside the Promise is the same as the 1st argument to callback.

Events

onTokenRefresh

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

Fired when all the granted tokens need to be refreshed.

Parameters

callback
function
The callback parameter looks like: () => void