chrome.instanceID

说明

使用 chrome.instanceID 访问实例 ID 服务。

权限

gcm

可用性

Chrome 44 及更高版本

方法

deleteID()

Promise

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

重置应用实例标识符并撤消与其关联的所有令牌。

参数

• callback

  函数（可选）

  callback 参数如下所示：

  ()=>void

返回

• Promise<void>

  Chrome 96 及更高版本

  Manifest V3 及更高版本支持 promise，但提供回调以实现向后兼容性。您不能在同一个函数调用中同时使用这两者。promise 使用传递给回调函数的同一类型进行解析。

deleteToken()

Promise

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

撤消已授予的令牌。

参数

• deleteTokenParams

  对象

  deleteToken 的参数。

  • authorizedEntity

    string

    Chrome 46 及更高版本

    用于获取令牌的授权实体。

  • 范围

    string

    Chrome 46 及更高版本

    用于获取令牌的范围。

• callback

  函数（可选）

  callback 参数如下所示：

  ()=>void

返回

• Promise<void>

  Chrome 96 及更高版本

  Manifest V3 及更高版本支持 promise，但提供回调以实现向后兼容性。您不能在同一个函数调用中同时使用这两者。promise 使用传递给回调函数的同一类型进行解析。

getCreationTime()

Promise

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

检索 InstanceID 生成的时间。创建时间将由 callback 返回。

参数

• callback

  函数（可选）

  callback 参数如下所示：

  (creationTime: number)=>void

  • creationTime

    number

    实例 ID 的生成时间，以自纪元以来的毫秒数表示。

返回

• Promise<数字>

  Chrome 96 及更高版本

  Manifest V3 及更高版本支持 promise，但提供回调以实现向后兼容性。您不能在同一个函数调用中同时使用这两者。promise 使用传递给回调函数的同一类型进行解析。

getID()

Promise

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

检索应用实例的标识符。实例 ID 将由 callback 返回。只要应用身份未被撤消或过期，系统就会返回同一 ID。

参数

• callback

  函数（可选）

  callback 参数如下所示：

  (instanceID: string)=>void

  • instanceID

    string

    分配给应用实例的实例 ID。

返回

• Promise<string>

  Chrome 96 及更高版本

  Manifest V3 及更高版本支持 promise，但提供回调以实现向后兼容性。您不能在同一个函数调用中同时使用这两者。promise 使用传递给回调函数的同一类型进行解析。

getToken()

Promise

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

返回一个令牌，该令牌允许已获授权的实体访问按范围定义的服务。

参数

• getTokenParams

  对象

  getToken 的参数。

  • authorizedEntity

    string

    Chrome 46 及更高版本

    标识有权访问与此实例 ID 关联的资源的实体。它可以是 Google 开发者控制台中的项目 ID。

  • 选项

    对象（可选）

    Chrome 46 及更高版本 从 Chrome 89 开始已废弃

    选项都已弃用，将被忽略。

    允许包含少量将与令牌关联并可用于处理请求的字符串键值对。

  • 范围

    string

    Chrome 46 及更高版本

    指明授权实体可以执行的操作。例如，如需发送 GCM 消息，应使用 GCM 范围。

• callback

  函数（可选）

  callback 参数如下所示：

  (token: string)=>void

  • token

    string

    由所请求的服务分配的令牌。

返回

• Promise<string>

  Chrome 96 及更高版本

  Manifest V3 及更高版本支持 promise，但提供回调以实现向后兼容性。您不能在同一个函数调用中同时使用这两者。promise 使用传递给回调函数的同一类型进行解析。

活动

onTokenRefresh

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

在需要刷新所有已授予的令牌时触发。

参数

• callback

  功能

  callback 参数如下所示：

  ()=>void