chrome.instanceID

說明

請使用 chrome.instanceID 存取執行個體 ID 服務。

權限

gcm

適用國家/地區

Chrome 44 以上版本

方法

deleteID()

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

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

參數

  • 回呼

    函式選用

    callback 參數如下所示： 

    ()=>void

傳回

  • Promise<void>

    Chrome 96 以上版本

    Manifest V3 以上版本支援 Promise，但是為了提供回溯相容性而提供的回呼。您無法在同一個函式呼叫中同時使用這兩者。承諾會用傳遞至回呼的同類型解析。

deleteToken()

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

撤銷已授予的權杖。

參數

  • deleteTokenParams

    物件

    deleteToken 的參數。

    • authorizedEntity

      字串

      Chrome 46 以上版本

      用來取得權杖的授權實體。

    • 範圍

      字串

      Chrome 46 以上版本

      用來取得權杖的範圍。

  • 回呼

    函式選用

    callback 參數如下所示： 

    ()=>void

傳回

  • Promise<void>

    Chrome 96 以上版本

    Manifest V3 以上版本支援 Promise，但是為了提供回溯相容性而提供的回呼。您無法在同一個函式呼叫中同時使用這兩者。承諾會用傳遞至回呼的同類型解析。

getCreationTime()

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

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

參數

  • 回呼

    函式選用

    callback 參數如下所示： 

    (creationTime: number)=>void

    • creationTime

      號碼

      執行個體 ID 的產生時間，以 Epoch 紀元時間起算的毫秒為單位。

傳回

  • Promise<number>

    Chrome 96 以上版本

    Manifest V3 以上版本支援 Promise，但是為了提供回溯相容性而提供的回呼。您無法在同一個函式呼叫中同時使用這兩者。承諾會用傳遞至回呼的同類型解析。

getID()

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

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

參數

  • 回呼

    函式選用

    callback 參數如下所示： 

    (instanceID: string)=>void

    • instanceID

      字串

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

傳回

  • Promise<string>

    Chrome 96 以上版本

    Manifest V3 以上版本支援 Promise，但是為了提供回溯相容性而提供的回呼。您無法在同一個函式呼叫中同時使用這兩者。承諾會用傳遞至回呼的同類型解析。

getToken()

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

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

參數

  • getTokenParams

    物件

    getToken 的參數。

    • authorizedEntity

      字串

      Chrome 46 以上版本

      識別已獲得授權，可以存取與此執行個體 ID 相關聯的資源的實體。也可透過 Google Play 管理中心做為專案 ID。

    • 選項

      物件選用

      Chrome 46 以上版本 自 Chrome 89 版起已淘汰的項目

      選項已淘汰且會遭到忽略

      允許加入少量字串鍵/值組合，這些組合將與權杖相關聯，並可在處理要求時使用。

    • 範圍

      字串

      Chrome 46 以上版本

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

  • 回呼

    函式選用

    callback 參數如下所示： 

    (token: string)=>void

    • 權杖

      字串

      要求的服務指派的權杖。

傳回

  • Promise<string>

    Chrome 96 以上版本

    Manifest V3 以上版本支援 Promise，但是為了提供回溯相容性而提供的回呼。您無法在同一個函式呼叫中同時使用這兩者。承諾會用傳遞至回呼的同類型解析。

活動

onTokenRefresh

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

必須重新整理所有授予的權杖時觸發。

參數

  • 回呼

    功能

    callback 參數如下所示： 

    ()=>void