chrome.gcm

Beschreibung

Verwenden Sie chrome.gcm, um Apps und Erweiterungen das Senden und Empfangen von Nachrichten über Firebase Cloud Messaging (FCM) zu aktivieren.

Berechtigungen

gcm

Attribute

MAX_MESSAGE_SIZE

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

Wert

4.096

Methoden

register()

Versprechen 
chrome.gcm.register(
  senderIds: string[],
  callback?: function,
)

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

Parameters

  • senderIds

    String[]

    Eine Liste der Server-IDs, die Nachrichten an die Anwendung senden dürfen. Sie sollte mindestens eine und nicht mehr als 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 wird.

Rückgaben

  • Versprechen<string>

    Chrome 116 oder höher

    Promise-Objekte werden in Manifest V3 und höher unterstützt, Callbacks werden jedoch aus Gründen der Abwärtskompatibilität bereitgestellt. Sie können nicht beide in einem Funktionsaufruf verwenden. Das Promise wird mit demselben Typ aufgelöst, der an den Callback übergeben wird.

send()

Versprechen 
chrome.gcm.send(
  message: object,
  callback?: function,
)

Sendet eine Nachricht entsprechend ihrem Inhalt.

Parameters

  • 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, bei denen die Groß-/Kleinschreibung nicht berücksichtigt wird, sowie collapse_key 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 von der Google API Console zugewiesene ID des Servers, an den die Nachricht gesendet werden soll.

    • messageId

      String

      Die ID der Nachricht. Sie muss für jede Nachricht im Anwendungsbereich eindeutig sein. Hinweise zur Auswahl und Handhabung einer ID finden Sie in der Cloud Messaging-Dokumentation.

    • timeToLive

      Nummer 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 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).

  • callback

    Funktion optional

    Der Parameter callback sieht so aus: 

    (messageId: string)=>void

    • messageId

      String

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

Rückgaben

  • Versprechen<string>

    Chrome 116 oder höher

    Promise-Objekte werden in Manifest V3 und höher unterstützt, Callbacks werden jedoch aus Gründen der Abwärtskompatibilität bereitgestellt. Sie können nicht beide in einem Funktionsaufruf verwenden. Das Promise wird mit demselben Typ aufgelöst, der an den Callback übergeben wird.

unregister()

Versprechen 
chrome.gcm.unregister(
  callback?: function,
)

Hebt die Registrierung der Anwendung für FCM auf

Parameters

  • callback

    Funktion optional

    Der Parameter callback sieht so aus: 

    ()=>void

Rückgaben

  • Promise<void>

    Chrome 116 oder höher

    Promise-Objekte werden in Manifest V3 und höher unterstützt, Callbacks werden jedoch aus Gründen der Abwärtskompatibilität bereitgestellt. Sie können nicht beide in einem Funktionsaufruf verwenden. Das Promise wird mit demselben Typ aufgelöst, der an den Callback übergeben wird.

Veranstaltungen

onMessage

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

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

Parameters

  • callback

    Funktion

    Der Parameter callback sieht so aus: 

    (message: object)=>void

    • Nachricht

      Objekt

      • collapseKey

        String optional

        Der Schlüssel für die Minimierung einer Nachricht. Weitere Informationen finden Sie unter Nicht minimierbare und minimierbare Nachrichten.

      • Daten

        Objekt

        Die Nachrichtendaten.

      • von

        String optional

        Der Absender der Nachricht.

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 Verarbeiten dieses Ereignisses finden Sie unter Lebensdauer einer Nachricht.

Parameters

  • callback

    Funktion

    Der Parameter callback sieht so aus: 

    ()=>void

onSendError

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

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

Parameters

  • callback

    Funktion

    Der Parameter callback sieht so aus: 

    (error: object)=>void

    • error

      Objekt

      • Details

        Objekt

        Weitere Details zum Fehler, sofern verfügbar.

      • errorMessage

        String

        Die Fehlermeldung, in der das Problem beschrieben wird.

      • messageId

        String optional

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