chrome.gcm

Beschrijving

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

Machtigingen

gcm

Eigenschappen

MAX_MESSAGE_SIZE

De maximale grootte (in bytes) van alle sleutel/waardeparen 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 sturen. Deze lijst moet minimaal één en maximaal 100 afzender-ID's bevatten.

  • terugbellen

    functie optioneel

    De callback ziet er als volgt uit: 

    (registrationId: string) => void

    • registratie-ID

      snaar

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

Retourneren

  • Belofte<string>

    Chroom 116+

    Promises worden alleen ondersteund voor Manifest V3 en hoger. Andere platforms moeten callbacks gebruiken.

send()

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

Stuurt een bericht op basis van de inhoud.

Parameters

  • bericht

    voorwerp

    Een bericht dat via FCM naar de andere partij moet worden verzonden.

    • gegevens

      voorwerp

      Berichtgegevens die naar de server moeten worden verzonden. Hoofdlettergevoelige tekens goog. en google , evenals hoofdlettergevoelige collapse_key , zijn niet toegestaan als sleutelprefixen. De som van alle sleutel/waardeparen 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 Google API Console .

    • bericht-ID

      snaar

      De ID van het bericht. Deze moet uniek zijn voor elk bericht binnen het bereik van de applicaties. Raadpleeg de documentatie van Cloud Messaging voor advies over het selecteren en verwerken van een ID.

    • tijdOmTeLeven

      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 gegenereerd. 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 van de time-to-live is 86.400 seconden (1 dag) en de maximumwaarde is 2.419.200 seconden (28 dagen).

  • terugbellen

    functie optioneel

    De callback ziet er als volgt uit: 

    (messageId: string) => void

    • bericht-ID

      snaar

      De ID van het bericht waarvoor de callback is uitgegeven.

Retourneren

  • Belofte<string>

    Chroom 116+

    Promises worden alleen ondersteund voor Manifest V3 en hoger. Andere platforms moeten callbacks gebruiken.

unregister()

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

Registreert de applicatie niet meer bij FCM.

Parameters

  • terugbellen

    functie optioneel

    De callback ziet er als volgt uit: 

    () => void

Retourneren

  • Belofte<leegte>

    Chroom 116+

    Promises worden alleen ondersteund voor Manifest V3 en hoger. Andere platforms moeten callbacks gebruiken.

Evenementen

onMessage

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

Wordt geactiveerd wanneer een bericht via FCM wordt ontvangen.

Parameters

  • terugbellen

    functie

    De callback ziet er als volgt uit: 

    (message: object) => void

    • bericht

      voorwerp

      • instortenSleutel

        string optioneel

        De knop om een bericht samen te vouwen. Zie ' Niet-samenvouwbare en samenvouwbare berichten' voor meer informatie.

      • gegevens

        voorwerp

        De berichtgegevens.

      • van

        string optioneel

        De afzender die het bericht heeft verzonden.

onMessagesDeleted

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

Geactiveerd wanneer een FCM-server berichten moest verwijderen die door een app-server naar de applicatie waren verzonden. Zie Levensduur van een bericht voor meer informatie over het afhandelen van deze gebeurtenis.

Parameters

  • terugbellen

    functie

    De callback ziet er als volgt uit: 

    () => void

onSendError

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

Geactiveerd wanneer het niet mogelijk was om een bericht naar de FCM-server te sturen.

Parameters

  • terugbellen

    functie

    De callback ziet er als volgt uit: 

    (error: object) => void

    • fout

      voorwerp

      • details

        voorwerp

        Aanvullende details over de fout, indien beschikbaar.

      • foutbericht

        snaar

        Het foutbericht dat het probleem beschrijft.

      • bericht-ID

        string optioneel

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