chrome.instanceID

说明

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

权限

gcm

可用性

Chrome 44 及更高版本

方法

deleteID()

Promise 
chrome.instanceID.deleteID(
  callback?: function,
): Promise<void>

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

参数

  • callback

    函数 可选

    callback 参数如下所示： 

    () => void

返回

  • Promise<void>

    Chrome 96 及更高版本

    仅 Manifest V3 及更高版本支持 Promise，其他平台需要使用回调。

deleteToken()

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

撤消已授予的令牌。

参数

  • deleteTokenParams

    对象

    deleteToken 的参数。

    • authorizedEntity

      字符串

      Chrome 46 及更高版本

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

    • 范围

      字符串

      Chrome 46 及更高版本

      用于获取令牌的范围。

  • callback

    函数 可选

    callback 参数如下所示： 

    () => void

返回

  • Promise<void>

    Chrome 96 及更高版本

    仅 Manifest V3 及更高版本支持 Promise，其他平台需要使用回调。

getCreationTime()

Promise 
chrome.instanceID.getCreationTime(
  callback?: function,
): Promise<number>

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

参数

  • callback

    函数 可选

    callback 参数如下所示： 

    (creationTime: number) => void

    • creationTime

      数值

      生成实例 ID 的时间，以自纪元开始算起的毫秒数表示。

返回

  • Promise<number>

    Chrome 96 及更高版本

    仅 Manifest V3 及更高版本支持 Promise，其他平台需要使用回调。

getID()

Promise 
chrome.instanceID.getID(
  callback?: function,
): Promise<string>

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

参数

  • callback

    函数 可选

    callback 参数如下所示： 

    (instanceID: string) => void

    • instanceID

      字符串

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

返回

  • Promise<string>

    Chrome 96 及更高版本

    仅 Manifest V3 及更高版本支持 Promise，其他平台需要使用回调。

getToken()

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

返回一个令牌，允许经过授权的实体访问由范围定义的服务。

参数

  • getTokenParams

    对象

    getToken 的参数。

    • authorizedEntity

      字符串

      Chrome 46 及更高版本

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

    • 选项

      对象（可选）

      Chrome 46 及更高版本 自 Chrome 89 起已弃用

      选项已被弃用，系统会忽略这些选项。

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

    • 范围

      字符串

      Chrome 46 及更高版本

      标识授权实体可以执行的授权操作。例如，对于发送 GCM 消息，应使用 GCM 范围。

  • callback

    函数 可选

    callback 参数如下所示： 

    (token: string) => void

    • token

      字符串

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

返回

  • Promise<string>

    Chrome 96 及更高版本

    仅 Manifest V3 及更高版本支持 Promise，其他平台需要使用回调。

事件

onTokenRefresh

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

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

参数

  • callback

    函数

    callback 参数如下所示： 

    () => void