browser.gcm

Beschreibung

Mit chrome.gcm können Sie Apps und Erweiterungen erlauben, 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()

browser.gcm.register(
  senderIds: string[],
): Promise<string>

Registriert die Anwendung bei FCM. Die Registrierungs-ID wird von der 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.

Ausgabe

• Promise<string>

  Chrome 116 und höher browser.* seit Chrome 148

  Wird aufgelöst, wenn die Registrierung abgeschlossen ist.

send()

browser.gcm.send(
  message: object,
): 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. goog. und google (Groß-/Kleinschreibung wird nicht berücksichtigt) sowie collapse_key (Groß-/Kleinschreibung wird berücksichtigt) sind als Schlüsselpräfixe 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 von der Google API Console zugewiesen.

  • messageId

    String

    Die ID der Nachricht. Sie muss für jede Nachricht im Bereich der Anwendungen eindeutig sein. In der Cloud Messaging-Dokumentation finden Sie Tipps zur Auswahl und Handhabung einer ID.

  • timeToLive

    number optional

    Gültigkeitsdauer der Nachricht in Sekunden. Wenn die Nachricht nicht innerhalb dieser Zeit gesendet werden kann, wird ein onSendError-Ereignis ausgelöst. Eine Gültigkeitsdauer von 0 bedeutet, dass die Nachricht sofort gesendet werden soll oder fehlschlägt, 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).

Ausgabe

• Promise<string>

  Chrome 116 und höher browser.* seit Chrome 148

  Wird aufgelöst, nachdem die Nachricht erfolgreich in die Warteschlange zum Senden gestellt wurde. Wenn ein Fehler auftritt, wird das Promise abgelehnt.

unregister()

browser.gcm.unregister(): Promise<void>

Meldet die Anwendung von FCM ab.

Ausgabe

• Promise<void>

  Chrome 116 und höher browser.* seit Chrome 148

  Wird aufgelöst, nachdem die Abmeldung abgeschlossen ist. Die Abmeldung war erfolgreich, wenn das Promise nicht abgelehnt wird.

Ereignisse

onMessage

browser.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 Minimierbare und nicht minimierbare Nachrichten.

    • Daten

      Objekt

      Die Nachrichtendaten.

    • von

      String optional

      Der Absender, der die Nachricht gesendet hat.

onMessagesDeleted

browser.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

browser.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, falls verfügbar.

    • errorMessage

      String

      Die Fehlermeldung, die das Problem beschreibt.

    • messageId

      String optional

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