aboutsummaryrefslogtreecommitdiff
path: root/files/fr/mozilla/add-ons/webextensions/api/notifications/notificationoptions/index.html
blob: 4202939183901a2c67d11c2e2e848189fe42ca54 (plain)
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
---
title: notifications.NotificationOptions
slug: Mozilla/Add-ons/WebExtensions/API/notifications/NotificationOptions
tags:
  - AP
  - Add-ons
  - Extensions
  - Non-standard
  - NotificationOptions
  - Refere
  - Type
  - WebExtensions
translation_of: Mozilla/Add-ons/WebExtensions/API/notifications/NotificationOptions
---
<div>{{AddonSidebar()}}</div>

<p>Ce type contient les données nécessaires pour :</p>

<ul>
 <li>créer une notification avec {{WebExtAPIRef("notifications.create()")}},</li>
 <li>mettre à jour une notification avec {{WebExtAPIRef("notifications.update()")}}.</li>
</ul>

<h2 id="Type">Type</h2>

<p>Les valeurs de ce type sont des objets qui contiennent les propriétés listées ci-dessous.</p>

<p>Les trois premières propriétés - <code>type</code>, <code>title</code>, <code>message</code> - sont obligatoires pour {{WebExtAPIRef("notifications.create()")}}, mais pas avec {{WebExtAPIRef("notifications.update()")}}. Firefox ne supporte que les propriétés <code>type</code>, <code>title</code>, <code>message</code>, et <code>iconUrl</code> pour le moment, et le seul <code>type</code> disponible est <code>'basic'</code>.</p>

<dl>
 <dt><code>type</code></dt>
 <dd>{{WebExtAPIRef("notifications.TemplateType")}}. Le type de notification que vous voulez. Selon votre choix ici, certaines propriétés seront soit nécéssaires, soit interdites.</dd>
 <dt><code>message</code></dt>
 <dd><code>string</code>. Le contenu de la notification</dd>
 <dt><code>title</code></dt>
 <dd><code>string</code>. Le titre de la notification</dd>
 <dt><code>iconUrl</code>{{optional_inline}}</dt>
 <dd><code>string</code>. Une URL correspondant vers une icône à afficher dans la notification. Ça peut être une URL de donnée, une URL blob, une URL http ou https, ou une <a href="/fr/Add-ons/WebExtensions/Chrome_incompatibilities#Relative_URLs">l'URL relative</a> d'un fichier de l'extension.</dd>
 <dt><code>contextMessage</code>{{optional_inline}}</dt>
 <dd><code>string</code>. Du texte supplémentaire à afficher.</dd>
 <dt><code>priority</code>{{optional_inline}}</dt>
 <dd><code>number</code>. La priorité de cette notification. Ça peut être 0, 1, or 2. La valeur par défaut est 0.</dd>
 <dt><code>eventTime</code>{{optional_inline}}</dt>
 <dd><code>number</code>. Un timestamp en millisecondes pour cette notification <a href="https://fr.wikipedia.org/wiki/Temps_Unix">depuis le timestamp 0</a>.</dd>
 <dt><code>buttons</code>{{optional_inline}}</dt>
 <dd><p><code>array</code> de <code>button</code>. Un tableau pouvant contenir jusqu'à deux boutons à afficher dans la notification. Vous pouvez réagir aux clics sur ces boutons grâce à {{WebExtAPIRef("notifications.onButtonClicked")}}. Chaque bouton est un objet avec ces propriétés :</p>
 <dl>
  <dt><code>title</code></dt>
  <dd><code>string</code>. Le texte du bouton.</dd>
  <dt><code>iconUrl</code>{{optional_inline}}</dt>
  <dd><code>string</code>. Une URL pointant vers l'icône de ce bouton.</dd>
 </dl>
 </dd>
 <dt><code>imageUrl</code></dt>
 <dd>
 <p><code>string</code>. Une URL pointant vers une image à utiliser dans la notification. Ça peut être une URL de donnée, une URL blob, une URL http ou https, ou une <a href="/fr/Add-ons/WebExtensions/Chrome_incompatibilities#Relative_URLs">l'URL relative</a> d'un fichier de l'extension.</p>

 <p><em>Cette propriété est utilisable seuleument si le <code>type</code> de la notification est <code>'image'</code>. Dans ce cas, cette propriété sera obligatoire si l'objet <code>NotificationOptions</code> est utilisé avec {{WebExtAPIRef("notifications.create()")}}, mais optionel avec </em><em>{{WebExtAPIRef("notifications.update()")}}.</em></p>
 </dd>
 <dt><code>items</code></dt>
 <dd><p><code>array</code> of <code>item</code>. Un tableau d'éléments à inclure dans la notification. Selon les paramètres de notification du système d'exploitation, certains éléments que vous souhaitez afficher pourraient ne pas l'être. Chaque élément est un objet avec les propriétés suivantes :</p>
 <dl>
  <dt><code>title</code></dt>
  <dd><code>string</code>. Le titre de cet élément.</dd>
  <dt><code>message</code></dt>
  <dd><code>string</code>. Le message à afficher pour cet élément.</dd>
 </dl>
 <p><em>Cette propriété est utilisable seuleument si le <code>type</code> de la notification est <code>'list'</code>. Dans ce cas, cette propriété sera obligatoire si l'objet <code>NotificationOptions</code> est utilisé avec {{WebExtAPIRef("notifications.create()")}}, mais optionel avec </em><em>{{WebExtAPIRef("notifications.update()")}}.</em></p></dd>
 <dt><code>progress</code></dt>
 <dd><code>integer</code>. Une valeur entre 0 et 100, qui représente l'avancée actuelle d'un indicateur de progression. <em>Cette propriété est utilisable seuleument si le <code>type</code> de la notification est <code>'progress'</code>. Dans ce cas, cette propriété sera obligatoire si l'objet <code>NotificationOptions</code> est utilisé avec {{WebExtAPIRef("notifications.create()")}}, mais optionel avec </em><em>{{WebExtAPIRef("notifications.update()")}}.</em></dd>
</dl>

<p>Notez que les propriétés <code>appIconMaskUrl</code> et <code>isClickable</code> ne sont pas supportées.</p>

<h2 id="Compatibilité_du_navigateur">Compatibilité du navigateur</h2>

<p>{{Compat("webextensions.api.notifications.NotificationOptions")}}</p>

<p>{{WebExtExamples}}</p>

<div class="note"><p><strong>Note :</strong></p>

<p>Cette API est basée sur l'API chromium <a href="https://developer.chrome.com/extensions/notifications"><code>chrome.notifications</code></a>.</p>

<p>Les données de compatibilité relatives à Microsoft Edge sont fournies par Microsoft Corporation et incluses ici sous la licence Creative Commons Attribution 3.0 pour les États-Unis.</p>
</div>