chrome.meldingen

Beschrijving

Gebruik de chrome.notifications API om uitgebreide meldingen te maken met behulp van sjablonen en deze meldingen aan gebruikers weer te geven in het systeemvak.

Toestemmingen

notifications

Soorten

NotificationBitmap

NotificationButton

Eigenschappen

  • iconUrl

    string optioneel

    Niet meer bruikbaar sinds Chrome 59.

    Knoppictogrammen zijn niet zichtbaar voor Mac OS X-gebruikers.

  • titel

    snaar

NotificationItem

Eigenschappen

  • bericht

    snaar

    Aanvullende informatie over dit artikel.

  • titel

    snaar

    Titel van een item in een lijstmelding.

NotificationOptions

Eigenschappen

  • appIconMaskUrl

    string optioneel

    Niet meer bruikbaar sinds Chrome 59.

    Het masker voor app-pictogrammen is niet zichtbaar voor Mac OS X-gebruikers.

    Een URL naar het app-pictogrammasker. URL's hebben dezelfde beperkingen als iconUrl .

    Het masker voor het app-pictogram moet in het alfakanaal staan, aangezien alleen het alfakanaal van de afbeelding in aanmerking wordt genomen.

  • knoppen

    NotificationButton [] optioneel

    Tekst en pictogrammen voor maximaal twee actieknoppen voor meldingen.

  • contextMessage

    string optioneel

    Alternatieve meldingsinhoud met een lichter lettertype.

  • eventTime

    nummer optioneel

    Een tijdstempel dat aan de melding is gekoppeld, in milliseconden na de epoch (bijv. Date.now() + n ).

  • iconUrl

    string optioneel

    Een URL naar de avatar van de afzender, het app-pictogram of een miniatuurafbeelding voor afbeeldingsmeldingen.

    URL's kunnen data-URL's, blob-URL's of URL's zijn die relatief zijn ten opzichte van een bron binnen het .crx-bestand van deze extensie.

    **Opmerking:** Deze waarde is vereist voor de methode notifications.create () .

  • imageUrl

    string optioneel

    Niet meer bruikbaar sinds Chrome 59.

    De afbeelding is niet zichtbaar voor Mac OS X-gebruikers.

    Een URL naar de miniatuurafbeelding voor meldingen van het type afbeelding. URL's hebben dezelfde beperkingen als iconUrl .

  • isKlikbaar

    boolean optioneel

    Niet meer bruikbaar sinds Chrome 67.

    Deze UI-hint wordt vanaf Chrome 67 genegeerd.

  • items

    NotificationItem [] optioneel

    Items voor meldingen met meerdere items. Gebruikers van Mac OS X zien alleen het eerste item.

  • bericht

    string optioneel

    Belangrijkste inhoud van de melding.

    **Opmerking:** Deze waarde is vereist voor de methode notifications.create () .

  • prioriteit

    nummer optioneel

    De prioriteit varieert van -2 tot 2. -2 is de laagste prioriteit, 2 de hoogste en nul de standaardprioriteit. Op platforms die geen notificatiecentrum ondersteunen (Windows, Linux en Mac) leiden -2 en -1 tot een foutmelding, omdat notificaties met deze prioriteiten helemaal niet worden weergegeven.

  • voortgang

    nummer optioneel

    De huidige voortgang varieert van 0 tot 100.

  • vereisen Interactie

    boolean optioneel

    Chrome 50+

    Geeft aan dat de melding op het scherm zichtbaar moet blijven totdat de gebruiker de melding activeert of sluit. Deze optie is standaard uitgeschakeld.

  • stil

    boolean optioneel

    Chrome 70+

    Geeft aan dat er geen geluiden of trillingen mogen worden geproduceerd wanneer de melding wordt weergegeven. Dit is standaard ingesteld op 'false'.

  • titel

    string optioneel

    Titel van de melding (bijv. naam van de afzender voor een e-mail).

    **Opmerking:** Deze waarde is vereist voor de methode notifications.create () .

  • type

    TemplateType optioneel

    Welk type melding moet worden weergegeven? Vereist voor notifications.create -methode.

PermissionLevel

Enum

"toegekend"
Geeft aan dat de gebruiker ervoor heeft gekozen om meldingen van de app of extensie weer te geven. Dit is de standaardinstelling bij installatie.

"geweigerd"
Geeft aan dat de gebruiker ervoor heeft gekozen geen meldingen van de app of extensie weer te geven.

TemplateType

Enum

"basis"
Bevat een pictogram, titel, bericht, uitgebreid bericht en maximaal twee knoppen.

"afbeelding"
Bevat een pictogram, titel, bericht, uitgebreid bericht, afbeelding en maximaal twee knoppen.

"lijst"
Bevat een pictogram, titel, bericht, items en maximaal twee knoppen. Gebruikers van Mac OS X zien alleen het eerste item.

"voortgang"
Bevat een pictogram, titel, bericht, voortgang en maximaal twee knoppen.

Methoden

clear()

Belofte
chrome.notifications.clear(
  notificationId: string,
  callback?: function,
): Promise<boolean>

Verwijdert de opgegeven melding.

Parameters

  • notificatie-ID

    snaar

    The id of the notification to be cleared. This is returned by notifications.create method.

  • terugbelverzoek

    functie optioneel

    De callback parameter ziet er als volgt uit: 

    (wasCleared: boolean) => void

    • werd gewist

      booleaans

Retourneert

  • Belofte<boolean>

    Chrome 116+

    Retourneert een Promise die wordt opgelost om aan te geven of er een overeenkomende melding bestond.

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

create()

Belofte
chrome.notifications.create(
  notificationId?: string,
  options: NotificationOptions,
  callback?: function,
): Promise<string>

Maakt en toont een melding.

Parameters

  • notificatie-ID

    string optioneel

    Identificatiecode van de melding. Indien niet ingesteld of leeg, wordt automatisch een ID gegenereerd. Als deze overeenkomt met een bestaande melding, wordt die melding eerst verwijderd voordat de aanmaakbewerking wordt uitgevoerd. De identificatiecode mag niet langer zijn dan 500 tekens.

    De parameter notificationId is vereist vóór Chrome 42.

  • Inhoud van de melding.

  • terugbelverzoek

    functie optioneel

    De callback parameter ziet er als volgt uit: 

    (notificationId: string) => void

    • notificatie-ID

      snaar

Retourneert

  • Belofte<string>

    Chrome 116+

    Retourneert een Promise die wordt opgelost met de notificatie-ID (opgegeven of gegenereerd) die de aangemaakte notificatie vertegenwoordigt.

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

getAll()

Belofte
chrome.notifications.getAll(
  callback?: function,
): Promise<object>

Haalt alle meldingen van deze app of extensie op.

Parameters

  • terugbelverzoek

    functie optioneel

    De callback parameter ziet er als volgt uit: 

    (notifications: object) => void

    • meldingen

      voorwerp

Retourneert

  • Promise<object>

    Chrome 116+

    Retourneert een Promise die wordt opgelost met de set notification_ids die momenteel in het systeem aanwezig zijn.

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

getPermissionLevel()

Belofte
chrome.notifications.getPermissionLevel(
  callback?: function,
): Promise<PermissionLevel>

Geeft aan of de gebruiker meldingen van deze app of extensie heeft ingeschakeld.

Parameters

Retourneert

  • Belofte< Toestemmingsniveau >

    Chrome 116+

    Retourneert een Promise die wordt opgelost met het huidige machtigingsniveau.

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

update()

Belofte
chrome.notifications.update(
  notificationId: string,
  options: NotificationOptions,
  callback?: function,
): Promise<boolean>

Hiermee wordt een bestaande melding bijgewerkt.

Parameters

  • notificatie-ID

    snaar

    De ID van de notificatie die moet worden bijgewerkt. Deze wordt geretourneerd door de methode notifications.create .

  • Inhoud van de melding waarnaar moet worden bijgewerkt.

  • terugbelverzoek

    functie optioneel

    De callback parameter ziet er als volgt uit: 

    (wasUpdated: boolean) => void

    • werd bijgewerkt

      booleaans

Retourneert

  • Belofte<boolean>

    Chrome 116+

    Retourneert een Promise die wordt opgelost om aan te geven of er een overeenkomende melding bestond.

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

Evenementen

onButtonClicked

chrome.notifications.onButtonClicked.addListener(
  callback: function,
)

De gebruiker heeft op een knop in de melding gedrukt.

Parameters

  • terugbelverzoek

    functie

    De callback parameter ziet er als volgt uit: 

    (notificationId: string, buttonIndex: number) => void

    • notificatie-ID

      snaar

    • knopIndex

      nummer

onClicked

chrome.notifications.onClicked.addListener(
  callback: function,
)

De gebruiker heeft op een niet-knopgedeelte van de melding geklikt.

Parameters

  • terugbelverzoek

    functie

    De callback parameter ziet er als volgt uit: 

    (notificationId: string) => void

    • notificatie-ID

      snaar

onClosed

chrome.notifications.onClosed.addListener(
  callback: function,
)

De melding is gesloten, hetzij door het systeem, hetzij door een actie van de gebruiker.

Parameters

  • terugbelverzoek

    functie

    De callback parameter ziet er als volgt uit: 

    (notificationId: string, byUser: boolean) => void

    • notificatie-ID

      snaar

    • door Gebruiker

      booleaans

onPermissionLevelChanged

chrome.notifications.onPermissionLevelChanged.addListener(
  callback: function,
)

De gebruiker wijzigt het machtigingsniveau. Vanaf Chrome 47 heeft alleen ChromeOS een gebruikersinterface die deze gebeurtenis verzendt.

Parameters

onShowSettings

Niet meer bruikbaar sinds Chrome 65.
 
chrome.notifications.onShowSettings.addListener(
  callback: function,
)

De knop voor aangepaste meldingsinstellingen wordt niet langer ondersteund.

De gebruiker klikte op een link voor de notificatie-instellingen van de app. Vanaf Chrome 47 had alleen ChromeOS een gebruikersinterface die deze gebeurtenis afhandelde. Vanaf Chrome 65 is die gebruikersinterface ook uit ChromeOS verwijderd.

Parameters

  • terugbelverzoek

    functie

    De callback parameter ziet er als volgt uit: 

    () => void