browser.notifications

Beschrijving

Gebruik de chrome.notifications API om uitgebreide meldingen te maken met templates en deze meldingen aan gebruikers te tonen in het systeemvak.

Rechten

notifications

Typen

NotificationBitmap

NotificationButton

Eigenschappen

  • iconUrl

    tekenreeks optioneel

    Beëindigd sinds Chrome 59

    Knoppen zijn niet zichtbaar voor Mac OS X-gebruikers.

  • titel

    tekenreeks

NotificationItem

Eigenschappen

  • bericht

    tekenreeks

    Aanvullende informatie over dit item.

  • titel

    tekenreeks

    Titel van één item van een lijstmelding.

NotificationOptions

Eigenschappen

  • appIconMaskUrl

    tekenreeks optioneel

    Beëindigd sinds Chrome 59

    Het masker van het app-icoon is niet zichtbaar voor Mac OS X-gebruikers.

    Een URL naar het masker van het app-icoon. URL's hebben dezelfde beperkingen als iconUrl.

    Het masker van het app-icoon moet zich in het alfakanaal bevinden, omdat alleen het alfakanaal van de afbeelding wordt overwogen.

  • knoppen

    NotificationButton[] optioneel

    Tekst en iconen voor maximaal 2 actieknoppen voor meldingen.

  • contextMessage

    tekenreeks optioneel

    Alternatieve meldingscontent met een lichter lettertype.

  • eventTime

    number optioneel

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

  • iconUrl

    tekenreeks optioneel

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

    URL's kunnen een gegevens-URL, een blob-URL of een URL zijn die is gerelateerd aan een bron in het .crx-bestand van deze extensie

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

  • imageUrl

    tekenreeks optioneel

    Beëindigd sinds Chrome 59

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

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

  • isClickable

    booleaans optioneel

    Beëindigd sinds Chrome 67

    Deze UI-hint wordt genegeerd vanaf Chrome 67

  • items

    NotificationItem[] optioneel

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

  • bericht

    tekenreeks optioneel

    Hoofdcontent van melding.

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

  • prioriteit

    number optioneel

    De prioriteit varieert van -2 tot 2. -2 is de laagste prioriteit. 2 is het hoogst. De standaardwaarde is 0. Op platforms die geen meldingencentrum ondersteunen (Windows, Linux en Mac), leiden -2 en -1 tot een fout, omdat meldingen met die prioriteiten helemaal niet worden getoond.

  • voortgang

    number optioneel

    De huidige voortgang varieert van 0 tot 100.

  • requireInteraction

    booleaans optioneel

    Chrome 50+ browser.* sinds Chrome 148

    Geeft aan dat de melding zichtbaar moet blijven op het scherm totdat de gebruiker de melding activeert of sluit. De standaardwaarde is onwaar.

  • stil

    booleaans optioneel

    Chrome 70+ browser.* sinds Chrome 148

    Geeft aan dat er geen geluiden of trillingen mogen worden gemaakt als de melding wordt getoond. De standaardwaarde is onwaar.

  • titel

    tekenreeks optioneel

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

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

  • type

    TemplateType optioneel

    Welk type melding moet worden getoond. Vereist voor de methode notifications.create.

PermissionLevel

Enum

granted
Geeft aan dat de gebruiker heeft gekozen om meldingen van de app of extensie te tonen. Dit is de standaardinstelling bij de installatie.

denied
Geeft aan dat de gebruiker heeft gekozen om geen meldingen van de app of extensie te tonen.

TemplateType

Enum

"basic"
Bevat een icoon, titel, bericht, expandedMessage en maximaal 2 knoppen.

"image"
Bevat een icoon, titel, bericht, expandedMessage, afbeelding en maximaal 2 knoppen.

"list"
Bevat een icoon, titel, bericht, items en maximaal 2 knoppen. Gebruikers van Mac OS X zien alleen het eerste item.

"progress"
Bevat een icoon, titel, bericht, voortgang en maximaal 2 knoppen.

Methoden

clear()

browser.notifications.clear(
  notificationId: string,
): Promise<boolean>

Wist de aangegeven melding.

Parameters

  • notificationId

    tekenreeks

    De ID van de melding die moet worden gewist. Dit wordt geretourneerd door de methode notifications.create.

Retourzendingen

  • Promise<boolean>

    Chrome 116+ browser.* sinds Chrome 148

    Retourneert een Promise die wordt omgezet om aan te geven of er een overeenkomende melding was.

create()

browser.notifications.create(
  notificationId?: string,
  options: NotificationOptions,
): Promise<string>

Maakt een melding en geeft deze weer.

Parameters

  • notificationId

    tekenreeks optioneel

    ID van de melding. Als u geen ID instelt of het veld leeg laat, wordt er automatisch een ID gegenereerd. Als de melding overeenkomt met een bestaande melding, wist deze methode eerst die melding voordat de maakbewerking wordt uitgevoerd. De ID mag niet langer zijn dan 500 tekens.

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

  • Content van de melding.

Retourzendingen

  • Promise<string>

    Chrome 116+ browser.* sinds Chrome 148

    Retourneert een Promise die wordt omgezet met de meldings-ID (geleverd of gegenereerd) die de gemaakte melding vertegenwoordigt.

getAll()

browser.notifications.getAll(): Promise<object>

Haalt alle meldingen van deze app of extensie op.

Retourzendingen

  • Promise<object>

    Chrome 116+ browser.* sinds Chrome 148

    Retourneert een Promise die wordt omgezet met de set notification_ids die zich op dat moment in het systeem bevinden.

getPermissionLevel()

browser.notifications.getPermissionLevel(): Promise<PermissionLevel>

Haalt op of de gebruiker meldingen van deze app of extensie heeft aangezet.

Retourzendingen

  • Promise<PermissionLevel>

    Chrome 116+ browser.* sinds Chrome 148

    Retourneert een Promise die wordt omgezet met het huidige rechtenniveau.

update()

browser.notifications.update(
  notificationId: string,
  options: NotificationOptions,
): Promise<boolean>

Updatet een bestaande melding.

Parameters

  • notificationId

    tekenreeks

    De ID van de melding die moet worden geüpdatet. Dit wordt geretourneerd door de methode notifications.create.

  • Inhoud van de melding waarnaar je wilt updaten.

Retourzendingen

  • Promise<boolean>

    Chrome 116+ browser.* sinds Chrome 148

    Retourneert een Promise die wordt omgezet om aan te geven of er een overeenkomende melding was.

Evenementen

onButtonClicked

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

De gebruiker heeft op een knop in de melding gedrukt.

Parameters

  • callback

    functie

    De parameter callback ziet er zo uit: 

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

    • notificationId

      tekenreeks

    • buttonIndex

      getal

onClicked

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

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

Parameters

  • callback

    functie

    De parameter callback ziet er zo uit: 

    (notificationId: string) => void

    • notificationId

      tekenreeks

onClosed

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

De melding is gesloten door het systeem of door een gebruikersactie.

Parameters

  • callback

    functie

    De parameter callback ziet er zo uit: 

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

    • notificationId

      tekenreeks

    • byUser

      booleaans

onPermissionLevelChanged

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

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

Parameters

onShowSettings

Beëindigd sinds Chrome 65
browser.notifications.onShowSettings.addListener(
  callback: function,
)

De knop voor aangepaste instellingen voor meldingen wordt niet meer ondersteund.

De gebruiker heeft op een link voor de instellingen voor meldingen van de app geklikt. Vanaf Chrome 47 heeft alleen ChromeOS een UI die deze gebeurtenis verzendt. Vanaf Chrome 65 is die UI ook verwijderd uit ChromeOS.

Parameters

  • callback

    functie

    De parameter callback ziet er zo uit: 

    () => void