chrome.gcm

Beschrijving

Gebruik chrome.gcm om apps en extensies in staat te stellen berichten te verzenden en te ontvangen via Firebase Cloud Messaging (FCM).

Toestemmingen

gcm

Eigenschappen

MAX_MESSAGE_SIZE

De maximale grootte (in bytes) van alle sleutel/waarde-paren in een bericht.

Waarde

4096

Methoden

register()

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

Registreert de applicatie bij FCM. De registratie-ID wordt geretourneerd door de callback . Als register opnieuw wordt aangeroepen met dezelfde lijst met senderIds , wordt dezelfde registratie-ID geretourneerd.

Parameters

  • afzender-ID's

    snaar[]

    Een lijst met server-ID's die berichten naar de applicatie mogen verzenden. Deze lijst moet minimaal één en maximaal 100 afzender-ID's bevatten.

  • terugbelverzoek

    functie optioneel

    De callback parameter ziet er als volgt uit: 

    (registrationId: string) => void

    • registratie-ID

      snaar

      Een registratie-ID die door de FCM aan de applicatie is toegekend.

Retourneert

  • Belofte<string>

    Chrome 116+

    Wordt opgelost zodra de registratie is voltooid.

    Promises worden alleen ondersteund voor Manifest V3 en later; voor andere platforms moeten callbacks worden gebruikt.

send()

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

Verstuurt een bericht op basis van de inhoud.

Parameters

  • bericht

    voorwerp

    Een bericht om via FCM naar de andere partij te sturen.

    • gegevens

      voorwerp

      Berichtgegevens die naar de server moeten worden verzonden. Hoofdletterongevoelige goog. en google , evenals hoofdlettergevoelige collapse_key zijn niet toegestaan ​​als sleutelvoorvoegsels. De som van alle sleutel/waarde-paren mag niet groter zijn dan gcm.MAX_MESSAGE_SIZE .

    • bestemmings-ID

      snaar

      De ID van de server waarnaar het bericht moet worden verzonden, zoals toegewezen door de Google API Console .

    • bericht-ID

      snaar

      De ID van het bericht. Deze moet uniek zijn voor elk bericht binnen het toepassingsgebied van de applicaties. Raadpleeg de documentatie over cloudberichten voor advies over het kiezen en beheren van een ID.

    • tijd om te leven

      nummer optioneel

      De time-to-live van het bericht in seconden. Als het niet mogelijk is om het bericht binnen die tijd te verzenden, wordt een onSendError-gebeurtenis geactiveerd. Een time-to-live van 0 geeft aan dat het bericht onmiddellijk moet worden verzonden of moet mislukken als dit niet mogelijk is. De standaardwaarde voor de time-to-live is 86.400 seconden (1 dag) en de maximale waarde is 2.419.200 seconden (28 dagen).

  • terugbelverzoek

    functie optioneel

    De callback parameter ziet er als volgt uit: 

    (messageId: string) => void

    • bericht-ID

      snaar

      De ID van het bericht waarvoor de callback is verzonden.

Retourneert

  • Belofte<string>

    Chrome 116+

    De promise wordt opgelost nadat het bericht succesvol in de wachtrij is geplaatst voor verzending. Als er een fout optreedt, wordt de promise afgewezen.

    Promises worden alleen ondersteund voor Manifest V3 en later; voor andere platforms moeten callbacks worden gebruikt.

unregister()

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

Hiermee wordt de applicatie uitgeschreven bij FCM.

Parameters

  • terugbelverzoek

    functie optioneel

    De callback parameter ziet er als volgt uit: 

    () => void

Retourneert

  • Promise<void>

    Chrome 116+

    Wordt opgelost nadat de uitschrijving is voltooid. De uitschrijving is succesvol verlopen als de belofte niet wordt afgewezen.

    Promises worden alleen ondersteund voor Manifest V3 en later; voor andere platforms moeten callbacks worden gebruikt.

Evenementen

onMessage

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

Wordt geactiveerd wanneer een bericht via FCM wordt ontvangen.

Parameters

  • terugbelverzoek

    functie

    De callback parameter ziet er als volgt uit: 

    (message: object) => void

    • bericht

      voorwerp

      • inklapsleutel

        string optioneel

        De inklaptoets van een bericht. Zie ' Niet-inklapbare en inklapbare berichten' voor meer informatie.

      • gegevens

        voorwerp

        De berichtgegevens.

      • van

        string optioneel

        De afzender die het bericht verstuurde.

onMessagesDeleted

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

Deze gebeurtenis wordt geactiveerd wanneer een FCM-server berichten moet verwijderen die door een applicatieserver naar de applicatie zijn verzonden. Zie 'Levensduur van een bericht' voor meer informatie over het afhandelen van deze gebeurtenis.

Parameters

  • terugbelverzoek

    functie

    De callback parameter ziet er als volgt uit: 

    () => void

onSendError

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

Geactiveerd toen het niet mogelijk was een bericht naar de FCM-server te verzenden.

Parameters

  • terugbelverzoek

    functie

    De callback parameter ziet er als volgt uit: 

    (error: object) => void

    • fout

      voorwerp

      • details

        voorwerp

        Aanvullende details met betrekking tot de fout, indien beschikbaar.

      • foutmelding

        snaar

        Het foutbericht dat het probleem beschrijft.

      • bericht-ID

        string optioneel

        De ID van het bericht met deze fout, indien de fout betrekking heeft op een specifiek bericht.