chrome.instanceID

說明

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

權限

gcm

可用性

Chrome 44 以上版本

方法

deleteID()

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

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

參數

  • 回呼

    函式 選用

    callback 參數如下所示： 

    () => void

傳回

  • 承諾<void>

    Chrome 96 以上版本

    Promise 適用於 Manifest V3 及以上版本，但系統會為 回溯相容性您無法在同一函式呼叫中同時使用兩者。 保證會以傳遞至回呼的相同類型來解析。

deleteToken()

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

撤銷授予的權杖。

參數

  • deleteTokenParams

    物件

    deleteToken 的參數。

    • authorizedEntity

      字串

      Chrome 46 以上版本

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

    • 範圍

      字串

      Chrome 46 以上版本

      用來取得權杖的範圍。

  • 回呼

    函式 選用

    callback 參數如下所示： 

    () => void

傳回

  • 承諾<void>

    Chrome 96 以上版本

    Promise 適用於 Manifest V3 及以上版本，但系統會為 回溯相容性您無法在同一函式呼叫中同時使用兩者。 保證會以傳遞至回呼的相同類型來解析。

getCreationTime()

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

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

參數

  • 回呼

    函式 選用

    callback 參數如下所示： 

    (creationTime: number) => void

    • creationTime

      數字

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

傳回

  • Promise&lt;number&gt;

    Chrome 96 以上版本

    Promise 適用於 Manifest V3 及以上版本，但系統會為 回溯相容性您無法在同一函式呼叫中同時使用兩者。 保證會以傳遞至回呼的相同類型來解析。

getID()

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

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

參數

  • 回呼

    函式 選用

    callback 參數如下所示： 

    (instanceID: string) => void

    • instanceID

      字串

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

傳回

  • 承諾<字串>

    Chrome 96 以上版本

    Promise 適用於 Manifest V3 及以上版本，但系統會為 回溯相容性您無法在同一函式呼叫中同時使用兩者。 保證會以傳遞至回呼的相同類型來解析。

getToken()

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

傳回可讓授權實體存取以範圍定義服務的憑證。

參數

  • getTokenParams

    物件

    getToken 的參數。

    • authorizedEntity

      字串

      Chrome 46 以上版本

      識別有權存取與此執行個體 ID 相關聯的資源的實體。可以是 Google Developers Console 中的專案 ID。

    • 選項

      物件 optional

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

      選項已淘汰，因此將遭到忽略。

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

    • 範圍

      字串

      Chrome 46 以上版本

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

  • 回呼

    函式 選用

    callback 參數如下所示： 

    (token: string) => void

    • token

      字串

      要求服務指派的權杖。

傳回

  • 承諾<字串>

    Chrome 96 以上版本

    Promise 適用於 Manifest V3 及以上版本，但系統會為 回溯相容性您無法在同一函式呼叫中同時使用兩者。 保證會以傳遞至回呼的相同類型來解析。

活動

onTokenRefresh

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

需要更新所有授予的權杖時觸發。

參數

  • 回呼

    函式

    callback 參數如下所示： 

    () => void