chrome.gcm

Beschreibung

Verwenden Sie chrome.gcm, um Apps und Erweiterungen zu ermöglichen, Nachrichten über Firebase Cloud Messaging (FCM) zu senden und zu empfangen.

Berechtigungen

gcm

Attribute

MAX_MESSAGE_SIZE

Die maximale Größe (in Byte) aller Schlüssel/Wert-Paare in einer Nachricht.

Wert

4096

Methoden

register()

<ph type="x-smartling-placeholder"></ph> Versprechen 
chrome.gcm.register(
  senderIds: string[],
  callback?: function,
)

Registriert die Anwendung bei FCM. Die Registrierungs-ID wird von callback zurückgegeben. Wenn register noch einmal mit derselben Liste von senderIds aufgerufen wird, wird dieselbe Registrierungs-ID zurückgegeben.

Parameter

  • senderIds

    String[]

    Eine Liste der Server-IDs, die Nachrichten an die Anwendung senden dürfen. Sie sollte mindestens eine und darf nicht mehr als 100 Absender-IDs enthalten.

  • callback

    Funktion optional

    Der Parameter callback sieht so aus: <ph type="x-smartling-placeholder"></ph>

    (registrationId: string) => void

    • registrationId

      String

      Eine Registrierungs-ID, die der Anwendung von FCM zugewiesen wurde.

Gibt Folgendes zurück:

  • Promise&lt;string&gt;

    Chrome 116 und höher

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

send()

<ph type="x-smartling-placeholder"></ph> Versprechen 
chrome.gcm.send(
  message: object,
  callback?: function,
)

Sendet eine Nachricht gemäß ihrem Inhalt.

Parameter

  • Nachricht

    Objekt

    Eine Nachricht, die über FCM an die andere Partei gesendet werden soll.

    • Daten

      Objekt

      An den Server zu sendende Nachrichtendaten. goog. und google, bei denen die Groß-/Kleinschreibung nicht berücksichtigt wird, sowie collapse_key, bei denen die Groß-/Kleinschreibung zu beachten ist, sind als Schlüsselpräfixe unzulässig. Die Summe aller Schlüssel/Wert-Paare darf gcm.MAX_MESSAGE_SIZE nicht überschreiten.

    • destinationId

      String

      Die ID des Servers, an den die Nachricht gesendet werden soll, wie von der Google API Console zugewiesen.

    • messageId

      String

      Die ID der Nachricht. Sie muss für jede Nachricht im Anwendungsbereich eindeutig sein. Hinweise zum Auswählen und Umgang mit einer ID finden Sie in der Cloud Messaging-Dokumentation.

    • timeToLive

      Zahl optional

      Gültigkeitsdauer der Nachricht in Sekunden. Wenn es nicht möglich ist, die Nachricht innerhalb dieser Zeit zu senden, wird ein onSendError-Ereignis ausgelöst. Eine Gültigkeitsdauer von 0 gibt an, dass die Nachricht sofort gesendet werden sollte oder fehlschlagen sollte, wenn dies nicht möglich ist. Der Standardwert für die Gültigkeitsdauer beträgt 86.400 Sekunden (1 Tag) und der Höchstwert 2.419.200 Sekunden (28 Tage).

  • callback

    Funktion optional

    Der Parameter callback sieht so aus: <ph type="x-smartling-placeholder"></ph>

    (messageId: string) => void

    • messageId

      String

      Die ID der Nachricht, für die der Rückruf erfolgt ist.

Gibt Folgendes zurück:

  • Promise&lt;string&gt;

    Chrome 116 und höher

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

unregister()

<ph type="x-smartling-placeholder"></ph> Versprechen 
chrome.gcm.unregister(
  callback?: function,
)

Hebt die Registrierung der Anwendung bei FCM auf.

Parameter

  • callback

    Funktion optional

    Der Parameter callback sieht so aus: <ph type="x-smartling-placeholder"></ph>

    () => void

Gibt Folgendes zurück:

  • Versprechen<void>

    Chrome 116 und höher

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

Ereignisse

onMessage

chrome.gcm.onMessage.addListener(
  callback: function,
)

Wird ausgelöst, wenn eine Nachricht über FCM empfangen wird

Parameter

  • callback

    Funktion

    Der Parameter callback sieht so aus: <ph type="x-smartling-placeholder"></ph>

    (message: object) => void

    • Nachricht

      Objekt

      • collapseKey

        String optional

        Der Minimierungsschlüssel einer Nachricht. Weitere Informationen finden Sie unter Nicht minimierbare und minimierbare Nachrichten.

      • Daten

        Objekt

        Die Nachrichtendaten.

      • von

        String optional

        Der Absender, der die Nachricht ausgegeben hat

onMessagesDeleted

chrome.gcm.onMessagesDeleted.addListener(
  callback: function,
)

Wird ausgelöst, wenn ein FCM-Server Nachrichten löschen musste, die von einem Anwendungsserver an die Anwendung gesendet wurden Weitere Informationen zur Verarbeitung dieses Ereignisses finden Sie unter Lebensdauer einer Nachricht.

Parameter

  • callback

    Funktion

    Der Parameter callback sieht so aus: <ph type="x-smartling-placeholder"></ph>

    () => void

onSendError

chrome.gcm.onSendError.addListener(
  callback: function,
)

Wird ausgelöst, wenn keine Nachricht an den FCM-Server gesendet werden konnte

Parameter

  • callback

    Funktion

    Der Parameter callback sieht so aus: <ph type="x-smartling-placeholder"></ph>

    (error: object) => void

    • Fehler

      Objekt

      • Details

        Objekt

        Weitere Details zum Fehler, falls verfügbar.

      • errorMessage

        String

        Die Fehlermeldung, die das Problem beschreibt.

      • messageId

        String optional

        Die ID der Nachricht mit diesem Fehler, wenn sich der Fehler auf eine bestimmte Nachricht bezieht.