chrome.instanceID

說明

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

權限

gcm

保留期限

Chrome 44 以上版本

方法

deleteID()

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

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

參數

  • callback

    函式 選填

    callback 參數如下： 

    () => void

傳回

  • Promise<void>

    Chrome 96 以上版本

    刪除作業完成時，系統會解析這個 Promise。如果 Promise 未遭拒絕，即代表執行個體 ID 已成功撤銷。

    只有資訊清單 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 以上版本

    權杖刪除作業完成時，系統會解析這個 Promise。如果 Promise 未遭拒絕，即代表權杖已成功撤銷。

    只有資訊清單 V3 以上版本支援 Promise，其他平台則需使用回呼。

getCreationTime()

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

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

參數

  • callback

    函式 選填

    callback 參數如下： 

    (creationTime: number) => void

    • creationTime

      數字

      產生執行個體 ID 的時間，以 Epoch 紀元時間起算的毫秒數表示。

傳回

  • Promise<數字>

    Chrome 96 以上版本

    擷取完成時會解析。

    只有資訊清單 V3 以上版本支援 Promise，其他平台則需使用回呼。

getID()

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

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

參數

  • callback

    函式 選填

    callback 參數如下： 

    (instanceID: string) => void

    • instanceID

      字串

      指派給應用程式執行個體的執行個體 ID。

傳回

  • Promise<string>

    Chrome 96 以上版本

    擷取完成時會解析。

    只有資訊清單 V3 以上版本支援 Promise，其他平台則需使用回呼。

getToken()

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

傳回權杖，授權實體即可存取範圍定義的服務。

參數

  • getTokenParams

    物件

    getToken 的參數。

    • authorizedEntity

      字串

      Chrome 46 以上版本

      識別獲授權可存取與這個例項 ID 相關聯資源的實體。可以是 Google 開發人員控制台的專案 ID。

    • 選項

      object 選填

      Chrome 46 以上版本 Chrome 89 以上版本已淘汰

      選項已遭淘汰，系統會忽略這些選項。

      允許加入少量字串鍵/值組合，這些組合會與權杖建立關聯，並可能用於處理要求。

    • 範圍

      字串

      Chrome 46 以上版本

      識別授權實體可執行的授權動作。舉例來說，如要傳送 GCM 訊息，應使用 GCM 範圍。

  • callback

    函式 選填

    callback 參數如下： 

    (token: string) => void

    • token

      字串

      要求服務指派的權杖。

傳回

  • Promise<string>

    Chrome 96 以上版本

    擷取完成時會解析。

    只有資訊清單 V3 以上版本支援 Promise，其他平台則需使用回呼。

事件

onTokenRefresh

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

需要重新整理所有已授予的權杖時觸發。

參數

  • callback

    函式

    callback 參數如下： 

    () => void