Deze pagina is vertaald door de Cloud Translation API.

chrome.gcm

Beschrijving

Gebruik chrome.gcm om apps en extensies in staat te stellen berichten te verzenden en ontvangen 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()

Belofte

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

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

Parameters

afzenderIds
snaar[]
Een lijst met server-ID's die berichten naar de toepassing mogen verzenden. Het moet minimaal één en niet meer dan 100 afzender-ID's bevatten.
Bel terug
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 aanvraag is toegewezen.

Geeft terug

Beloof<tekenreeks>
Chroom 116+
Beloften worden ondersteund in Manifest V3 en hoger, maar er zijn callbacks beschikbaar voor achterwaartse compatibiliteit. U kunt niet beide gebruiken bij dezelfde functieaanroep. De belofte wordt opgelost met hetzelfde type dat wordt doorgegeven aan de callback.

send()

Belofte

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

Verzendt een bericht op basis van de inhoud ervan.

Parameters

bericht
voorwerp
Een bericht dat via FCM naar de andere partij moet worden verzonden.
- gegevens
  voorwerp
  Berichtgegevens om naar de server te verzenden. Hoofdletterongevoelig goog. en google , evenals de hoofdlettergevoelige collapse_key zijn niet toegestaan als sleutelvoorvoegsels. De som van alle sleutel/waarde-paren mag niet groter zijn dan gcm.MAX_MESSAGE_SIZE .
- bestemmingId
  snaar
  De ID van de server waarnaar het bericht moet worden verzonden, zoals toegewezen door de Google API Console .
- berichtID
  snaar
  De ID van het bericht. Het moet uniek zijn voor elk bericht binnen het bereik van de toepassingen. Zie de Cloud Messaging-documentatie voor advies over het kiezen en verwerken van een ID.
- tijd om te leven
  nummer optioneel
  Time-to-live van het bericht in seconden. Als het niet mogelijk is om het bericht binnen die tijd te verzenden, wordt er 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 maximale waarde is 2.419.200 seconden (28 dagen).
Bel terug
functie optioneel
De callback parameter ziet er als volgt uit:
```
(messageId: string)=>void
```
- berichtID
  snaar
  De ID van het bericht waarvoor de terugbelactie is uitgevoerd.

Geeft terug

Beloof<tekenreeks>
Chroom 116+
Beloften worden ondersteund in Manifest V3 en hoger, maar er zijn callbacks beschikbaar voor achterwaartse compatibiliteit. U kunt niet beide gebruiken bij dezelfde functieaanroep. De belofte wordt opgelost met hetzelfde type dat wordt doorgegeven aan de callback.

unregister()

Belofte

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

Maakt de registratie van de toepassing bij FCM ongedaan.

Parameters

Bel terug
functie optioneel
De callback parameter ziet er als volgt uit:
```
()=>void
```

Geeft terug

Beloof <nietig>
Chroom 116+
Beloften worden ondersteund in Manifest V3 en hoger, maar er zijn callbacks beschikbaar voor achterwaartse compatibiliteit. U kunt niet beide gebruiken bij dezelfde functieaanroep. De belofte wordt opgelost met hetzelfde type dat wordt doorgegeven aan de callback.

Evenementen

onMessage

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

Wordt geactiveerd wanneer een bericht wordt ontvangen via FCM.

Parameters

Bel terug
functie
De callback parameter ziet er als volgt uit:
```
(message: object)=>void
```
- bericht
  voorwerp
  - samenvouwenSleutel
    tekenreeks optioneel
    De samenvouwsleutel van een bericht. Zie de Niet-opvouwbare en opvouwbare berichten voor meer informatie.
  - gegevens
    voorwerp
    De berichtgegevens.
  - van
    tekenreeks optioneel
    De afzender die het bericht heeft verzonden.

onMessagesDeleted

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

Wordt 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

Bel terug
functie
De callback parameter ziet er als volgt uit:
```
()=>void
```

onSendError

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

Wordt geactiveerd wanneer het niet mogelijk was een bericht naar de FCM-server te verzenden.

Parameters

Bel terug
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.
  - foutbericht
    snaar
    Het foutbericht dat het probleem beschrijft.
  - berichtID
    tekenreeks optioneel
    De ID van het bericht met deze fout, als de fout betrekking heeft op een specifiek bericht.