browser.gcm

Beschrijving

Gebruik chrome.gcm om apps en extensies toe te staan berichten te sturen en te krijgen via Firebase Cloud Messaging (FCM).

Rechten

gcm

Eigenschappen

MAX_MESSAGE_SIZE

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

Waarde

4096

Methoden

register()

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

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

Parameters

• senderIds

  tekenreeks[]

  Een lijst met server-ID's die berichten naar de app mogen sturen. Het bestand moet minimaal 1 en maximaal 100 afzender-ID's bevatten.

Retourzendingen

• Promise<string>

  Chrome 116+ browser.* sinds Chrome 148

  Wordt opgelost als de registratie is afgerond.

send()

browser.gcm.send(
  message: object,
): Promise<string>

Verstuurt een bericht op basis van de inhoud.

Parameters

• bericht

  object

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

  • gegevens

    object

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

  • destinationId

    tekenreeks

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

  • messageId

    tekenreeks

    De ID van het bericht. Deze moet uniek zijn voor elk bericht binnen het bereik van de apps. Ga naar de Cloud Messaging-documentatie voor advies over hoe je een ID kiest en verwerkt.

  • timeToLive

    number optioneel

    Time-to-live van het bericht in seconden. Als het bericht niet binnen die tijd kan worden gestuurd, wordt een onSendError-gebeurtenis geactiveerd. Een levensduur van 0 geeft aan dat het bericht onmiddellijk moet worden gestuurd 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).

Retourzendingen

• Promise<string>

  Chrome 116+ browser.* sinds Chrome 148

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

unregister()

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

Maakt de registratie van de app bij FCM ongedaan.

Retourzendingen

• Promise<void>

  Chrome 116+ browser.* sinds Chrome 148

  Wordt opgelost nadat de registratie ongedaan is gemaakt. De registratie is ongedaan gemaakt als de promise niet wordt afgewezen.

Evenementen

onMessage

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

Wordt geactiveerd als er een bericht wordt ontvangen via FCM.

Parameters

• callback

  functie

  De parameter callback ziet er zo uit:

  (message: object) => void

  • bericht

    object

    • collapseKey

      tekenreeks optioneel

      De samenvouwsleutel van een bericht. Ga naar Niet-samenvouwbare en samenvouwbare berichten voor meer informatie.

    • gegevens

      object

      De berichtgegevens.

    • van

      tekenreeks optioneel

      De afzender die het bericht heeft gestuurd.

onMessagesDeleted

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

Wordt geactiveerd als een FCM-server berichten moest verwijderen die door een app-server naar de app zijn gestuurd. Ga naar Levensduur van een bericht voor meer informatie over hoe je deze gebeurtenis afhandelt.

Parameters

• callback

  functie

  De parameter callback ziet er zo uit:

  () => void

onSendError

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

Wordt geactiveerd als het niet mogelijk is een bericht naar de FCM-server te sturen.

Parameters

• callback

  functie

  De parameter callback ziet er zo uit:

  (error: object) => void

  • fout

    object

    • details

      object

      Aanvullende informatie over de fout, indien beschikbaar.

    • errorMessage

      tekenreeks

      De foutmelding die het probleem beschrijft.

    • messageId

      tekenreeks optioneel

      De ID van het bericht met deze fout, als de fout is gerelateerd aan een specifiek bericht.