browser.instanceID

說明

使用 chrome.instanceID 存取 Instance ID 服務。

權限

gcm

可用性

Chrome 44 以上版本 瀏覽器。*自 Chrome 148 起

方法

deleteID()

browser.instanceID.deleteID(): Promise<void>

重設應用程式執行個體 ID,並撤銷與其相關聯的所有權杖。

傳回

  • 承諾<void>

    Chrome 96 以上版本 Chrome 148 以上版本中的 browser.*

    刪除完成後,系統會解析。如果 Promise 未拒絕,表示執行個體 ID 已成功撤銷。

deleteToken()

browser.instanceID.deleteToken(
  deleteTokenParams: object,
)
: Promise<void>

撤銷已授予的權杖。

參數

  • deleteTokenParams

    物件

    deleteToken 的參數。

    • authorizedEntity

      字串

      Chrome 46 以上版本 Chrome 148 以上版本為 browser.*

      用於取得權杖的獲得授權的實體。

    • 範圍

      字串

      Chrome 46 以上版本 Chrome 148 以上版本為 browser.*

      用於取得權杖的範圍。

傳回

  • 承諾<void>

    Chrome 96 以上版本 Chrome 148 以上版本中的 browser.*

    權杖刪除完成後,系統會解析。如果 Promise 未拒絕,表示權杖已成功撤銷。

getCreationTime()

browser.instanceID.getCreationTime(): Promise<number>

擷取 InstanceID 的產生時間。callback 會傳回建立時間。

傳回

  • Promise<number>

    Chrome 96 以上版本 Chrome 148 以上版本中的 browser.*

    擷取完成後,系統會解析。

getID()

browser.instanceID.getID(): Promise<string>

擷取應用程式執行個體的 ID。callback 會傳回執行個體 ID。只要應用程式身分未撤銷或過期,系統就會傳回相同的 ID。

傳回

  • Promise<string>

    Chrome 96 以上版本 Chrome 148 以上版本中的 browser.*

    擷取完成後,系統會解析。

getToken()

browser.instanceID.getToken(
  getTokenParams: object,
)
: Promise<string>

傳回權杖,允許獲得授權的實體存取範圍定義的服務。

參數

  • getTokenParams

    物件

    getToken 的參數。

    • authorizedEntity

      字串

      Chrome 46 以上版本 Chrome 148 以上版本為 browser.*

      識別有權存取與這個執行個體 ID 相關聯資源的實體。可以是 Google 開發人員控制台中的專案 ID。

    • 選項

      物件 選填

      Chrome 46 以上版本 Chrome 148 以上版本為 browser.* Chrome 89 以上版本已淘汰

      選項已淘汰,系統會忽略。

      允許加入少量與權杖相關聯的字串鍵/值組合,可用於處理要求。

    • 範圍

      字串

      Chrome 46 以上版本 Chrome 148 以上版本為 browser.*

      識別獲得授權的實體可採取的授權動作。例如,如要傳送 GCM 訊息,應使用 GCM 範圍。

傳回

  • Promise<string>

    Chrome 96 以上版本 Chrome 148 以上版本中的 browser.*

    擷取完成後,系統會解析。

事件

onTokenRefresh

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

當所有已授予的權杖都需要重新整理時,系統會觸發這個事件。

參數

  • callback

    函式

    callback 參數如下:

    () => void