chrome.instanceID

Beschreibung

Verwenden Sie chrome.instanceID, um auf den Instanz-ID-Dienst zuzugreifen.

Berechtigungen

gcm

Verfügbarkeit

Chrome 44 und höher

Methoden

deleteID()

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

Setzt die App-Instanz-ID zurück und widerruft alle zugehörigen Tokens.

Parameter

  • callback

    Funktion optional

    Der Parameter callback sieht so aus: 

    () => void

Ausgabe

  • Promise<void>

    Chrome 96 und höher

    Wird aufgelöst, wenn das Löschen abgeschlossen ist. Die Instanz-ID wurde erfolgreich widerrufen, wenn das Promise nicht abgelehnt wird.

    Promises werden nur für Manifest V3 und höher unterstützt. Auf anderen Plattformen müssen Callbacks verwendet werden.

deleteToken()

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

Widerruft ein erteiltes Token.

Parameter

  • deleteTokenParams

    Objekt

    Parameter für deleteToken.

    • authorizedEntity

      String

      Chrome 46 und höher

      Die autorisierte Entität, die zum Abrufen des Tokens verwendet wird.

    • Bereich

      String

      Chrome 46 und höher

      Der Bereich, der zum Abrufen des Tokens verwendet wird.

  • callback

    Funktion optional

    Der Parameter callback sieht so aus: 

    () => void

Ausgabe

  • Promise<void>

    Chrome 96 und höher

    Wird aufgelöst, wenn das Löschen des Tokens abgeschlossen ist. Das Token wurde erfolgreich widerrufen, wenn das Promise nicht abgelehnt wird.

    Promises werden nur für Manifest V3 und höher unterstützt. Auf anderen Plattformen müssen Callbacks verwendet werden.

getCreationTime()

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

Ruft die Uhrzeit ab, zu der die InstanceID generiert wurde. Der Erstellungszeitpunkt wird von callback zurückgegeben.

Parameter

  • callback

    Funktion optional

    Der Parameter callback sieht so aus: 

    (creationTime: number) => void

    • creationTime

      Zahl

      Der Zeitpunkt, zu dem die Instanz-ID generiert wurde, in Millisekunden seit der Epoche.

Ausgabe

  • Promise<number>

    Chrome 96 und höher

    Wird aufgelöst, wenn der Abruf abgeschlossen ist.

    Promises werden nur für Manifest V3 und höher unterstützt. Auf anderen Plattformen müssen Callbacks verwendet werden.

getID()

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

Ruft eine Kennung für die App-Instanz ab. Die Instanz-ID wird von callback zurückgegeben. Solange die Anwendungsidentität nicht widerrufen wurde oder abgelaufen ist, wird dieselbe ID zurückgegeben.

Parameter

  • callback

    Funktion optional

    Der Parameter callback sieht so aus: 

    (instanceID: string) => void

    • instanceID

      String

      Eine Instanz-ID, die der App-Instanz zugewiesen ist.

Ausgabe

  • Promise<string>

    Chrome 96 und höher

    Wird aufgelöst, wenn der Abruf abgeschlossen ist.

    Promises werden nur für Manifest V3 und höher unterstützt. Auf anderen Plattformen müssen Callbacks verwendet werden.

getToken()

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

Gibt ein Token zurück, mit dem die autorisierte Entität auf den durch den Bereich definierten Dienst zugreifen kann.

Parameter

  • getTokenParams

    Objekt

    Parameter für getToken.

    • authorizedEntity

      String

      Chrome 46 und höher

      Gibt die Entität an, die berechtigt ist, auf Ressourcen zuzugreifen, die mit dieser Instanz-ID verknüpft sind. Das kann eine Projekt-ID aus der Google Developer Console sein.

    • Optionen

      object optional

      Chrome 46 und höher Seit Chrome 89 eingestellt

      Optionen wurden eingestellt und werden ignoriert.

      Ermöglicht das Einbeziehen einer kleinen Anzahl von Schlüssel/Wert-Paaren vom Typ „String“, die dem Token zugeordnet werden und bei der Verarbeitung der Anfrage verwendet werden können.

    • Bereich

      String

      Chrome 46 und höher

      Gibt autorisierte Aktionen an, die die autorisierte Entität ausführen kann. Zum Senden von GCM-Nachrichten sollte beispielsweise der Bereich GCM verwendet werden.

  • callback

    Funktion optional

    Der Parameter callback sieht so aus: 

    (token: string) => void

    • Token

      String

      Ein vom angeforderten Dienst zugewiesenes Token.

Ausgabe

  • Promise<string>

    Chrome 96 und höher

    Wird aufgelöst, wenn der Abruf abgeschlossen ist.

    Promises werden nur für Manifest V3 und höher unterstützt. Auf anderen Plattformen müssen Callbacks verwendet werden.

Ereignisse

onTokenRefresh

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

Wird ausgelöst, wenn alle gewährten Tokens aktualisiert werden müssen.

Parameter

  • callback

    Funktion

    Der Parameter callback sieht so aus: 

    () => void