chrome.gcm

Beschreibung

Mit chrome.gcm können Apps und Erweiterungen Nachrichten über Firebase Cloud Messaging (FCM) senden und 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()

Promise 
chrome.gcm.register(
  senderIds: string[],
  callback?: function,
): Promise<string>

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 maximal 100 Absender-IDs enthalten.

  • callback

    Funktion optional

    Der Parameter callback sieht so aus: 

    (registrationId: string) => void

    • registrationId

      String

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

Ausgabe

  • Promise<string>

    Chrome 116 und höher

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

send()

Promise 
chrome.gcm.send(
  message: object,
  callback?: function,
): Promise<string>

Sendet eine Nachricht entsprechend ihrem Inhalt.

Parameter

  • Nachricht

    Objekt

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

    • Daten

      Objekt

      Nachrichtendaten, die an den Server gesendet werden sollen. Bei den Schlüsselpräfixen sind goog. und google (Groß-/Kleinschreibung wird nicht berücksichtigt) sowie collapse_key (Groß-/Kleinschreibung wird berücksichtigt) nicht zulä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 sie von der Google API Console zugewiesen wird.

    • messageId

      String

      Die ID der Mitteilung. Er muss für jede Nachricht im Anwendungsbereich eindeutig sein. In der Cloud Messaging-Dokumentation finden Sie Tipps zur Auswahl und Verarbeitung einer ID.

    • timeToLive

      number optional

      Die Gültigkeitsdauer der Nachricht in Sekunden. Wenn die Nachricht innerhalb dieses Zeitraums nicht gesendet werden kann, wird ein „onSendError“-Ereignis ausgelöst. Ein TTL-Wert von 0 gibt an, dass die Nachricht sofort gesendet werden soll oder dass der Vorgang fehlschlagen soll, 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: 

    (messageId: string) => void

    • messageId

      String

      Die ID der Nachricht, für die der Rückruf ausgegeben wurde.

Ausgabe

  • Promise<string>

    Chrome 116 und höher

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

unregister()

Promise 
chrome.gcm.unregister(
  callback?: function,
): Promise<void>

Hebt die Registrierung der Anwendung bei FCM auf.

Parameter

  • callback

    Funktion optional

    Der Parameter callback sieht so aus: 

    () => void

Ausgabe

  • Promise<void>

    Chrome 116 und höher

    Promises 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: 

    (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 gesendet hat.

onMessagesDeleted

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

Wird ausgelöst, wenn ein FCM-Server Nachrichten löschen musste, die von einem App-Server an die Anwendung gesendet wurden. Weitere Informationen zum Umgang mit diesem Ereignis finden Sie unter Lebensdauer einer Nachricht.

Parameter

  • callback

    Funktion

    Der Parameter callback sieht so aus: 

    () => void

onSendError

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

Wird ausgelöst, wenn eine Nachricht nicht an den FCM-Server gesendet werden konnte.

Parameter

  • callback

    Funktion

    Der Parameter callback sieht so aus: 

    (error: object) => void

    • Fehler

      Objekt

      • Details

        Objekt

        Zusätzliche Details zum Fehler, sofern verfügbar.

      • errorMessage

        String

        Die Fehlermeldung, die das Problem beschreibt.

      • messageId

        String optional

        Die ID der Nachricht mit diesem Fehler, falls der Fehler mit einer bestimmten Nachricht zusammenhängt.