chrome.instanceID

说明

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

权限

gcm

可用性

Chrome 44 及更高版本

方法

deleteID()

<ph type="x-smartling-placeholder"></ph> 承诺
chrome.instanceID.deleteID(
  callback?: function,
)

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

参数

  • callback

    函数(可选)

    callback 参数如下所示:

    () => void

返回

  • 承诺<void>

    Chrome 96 及更高版本

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

deleteToken()

<ph type="x-smartling-placeholder"></ph> 承诺
chrome.instanceID.deleteToken(
  deleteTokenParams: object,
  callback?: function,
)

撤消已授予的令牌。

参数

  • deleteTokenParams

    对象

    deleteToken 的参数。

    • authorizedEntity

      字符串

      Chrome 46 及更高版本

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

    • 范围

      字符串

      Chrome 46 及更高版本

      用于获取令牌的范围。

  • callback

    函数(可选)

    callback 参数如下所示:

    () => void

返回

  • 承诺<void>

    Chrome 96 及更高版本

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

getCreationTime()

<ph type="x-smartling-placeholder"></ph> 承诺
chrome.instanceID.getCreationTime(
  callback?: function,
)

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

参数

  • callback

    函数(可选)

    callback 参数如下所示:

    (creationTime: number) => void

    • creationTime

      number

      实例 ID 的生成时间,以从公元纪年开始计算的毫秒数表示。

返回

  • Promise&lt;number&gt;

    Chrome 96 及更高版本

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

getID()

<ph type="x-smartling-placeholder"></ph> 承诺
chrome.instanceID.getID(
  callback?: function,
)

检索应用实例的标识符。callback 将返回实例 ID。只要应用身份没有被撤消或过期,系统就会返回相同的 ID。

参数

  • callback

    函数(可选)

    callback 参数如下所示:

    (instanceID: string) => void

    • instanceID

      字符串

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

返回

  • 承诺<字符串>

    Chrome 96 及更高版本

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

getToken()

<ph type="x-smartling-placeholder"></ph> 承诺
chrome.instanceID.getToken(
  getTokenParams: object,
  callback?: function,
)

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

参数

  • getTokenParams

    对象

    getToken 的参数。

    • authorizedEntity

      字符串

      Chrome 46 及更高版本

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

    • 选项

      对象(可选

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

      选项已被弃用,将被忽略。

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

    • 范围

      字符串

      Chrome 46 及更高版本

      用于标识已获授权实体可执行的授权操作。例如:若要发送 GCM 消息,应使用 GCM 范围。

  • callback

    函数(可选)

    callback 参数如下所示:

    (token: string) => void

    • token

      字符串

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

返回

  • 承诺<字符串>

    Chrome 96 及更高版本

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

事件

onTokenRefresh

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

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

参数

  • callback

    函数

    callback 参数如下所示:

    () => void