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
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
|
---
title: storage.sync
slug: Mozilla/Add-ons/WebExtensions/API/storage/sync
translation_of: Mozilla/Add-ons/WebExtensions/API/storage/sync
browser-compat: webextensions.api.storage.sync
---
<div>{{AddonSidebar()}}</div>
<p>Représente la zone de stockage <code>sync</code> (pour la synchronisation). Les éléments stockés dans le stockage <code>sync</code> sont synchronisés par le navigateur et disponibles sur toutes les instances de ce navigateur auxquelles l'utilisatrice ou l'utilisateur est connecté (par exemple via la synchronisation Firefox ou un compte Google), sur différents appareils.</p>
<p>Pour Firefox, il faut au préalable avoir coché « Modules complémentaires » dans les options « Réglages de Sync » dans « <code>about:preferences</code>.</p>
<p>Notez que l'implémentation de <code>storage.sync</code> dans Firefox repose sur l'ID de l'extension. Si vous utilisez <code>storage.sync</code>, vous devez définir un ID pour votre extension à l'aide de la clé de manifeste <code><a href="/fr/docs/Mozilla/Add-ons/WebExtensions/manifest.json/browser_specific_settings">browser_specific_settings</a></code>.</p>
<p>Le principal cas d'utilisation de cette API est de stocker les préférences concernant votre extension et de permettre à l'utilisateur de les synchroniser dans différents profils.</p>
<h2 id="quotas_de_stockage_pour_les_données_synchronisées">Quotas de stockage pour les données synchronisées</h2>
<p>Le navigateur impose des limites sur la quantité de données que chaque extension peut stocker dans le stockage sync :</p>
<table class="standard-table">
<thead>
<tr>
<th scope="col">Nom</th>
<th scope="col">Description</th>
<th scope="col">Valeur en octets</th>
</tr>
</thead>
<tbody>
<tr>
<td>Taille de stockage maximale</td>
<td>La quantité totale maximale que chaque extension peut stocker dans la zone de stockage sync, telle que mesurée par la conversion en chaîne de caractères JSON de chaque valeur avec la longueur de sa clé.</td>
<td>102400</td>
</tr>
<tr>
<td>Taille maximale d'un élément</td>
<td>La taille maximale pour un élément que l'extension peut stocker dans la zone sync, telle que mesurée par la conversion en chaîne de caractères JSON de la valeur de l'élément avec la longueur de sa clé.</td>
<td>8192</td>
</tr>
<tr>
<td>Nombre maximal d'éléments</td>
<td>Le nombre maximal d'éléments que chaque extension peut stocker dans l'espace de stockage sync.</td>
<td>
<p>512</p>
</td>
</tr>
</tbody>
</table>
<p>Si une extension tente de stocker des éléments qui dépassent ces limites, l'appel à <code><a href="/fr/docs/Mozilla/Add-ons/WebExtensions/API/storage/StorageArea/set">storage.sync.set()</a></code> sera rejeté avec une erreur. Une extension peut utiliser <code><a href="/fr/docs/Mozilla/Add-ons/WebExtensions/API/storage/StorageArea/getBytesInUse">storage.sync.getBytesInUse()</a></code> afin de connaître le quota d'espace déjà utilisé.</p>
<h2 id="Méthodes">Méthodes</h2>
<p>L'objet <code>sync</code> implémente les méthodes définies sur le type {{WebExtAPIRef("storage.StorageArea")}} :</p>
<dl>
<dt><a href="/fr/docs/Mozilla/Add-ons/WebExtensions/API/storage/StorageArea/get"><code>storage.StorageArea.get()</code></a></dt>
<dd>Récupère un ou plusieurs éléments de la zone de stockage.</dd>
<dt><a href="/fr/docs/Mozilla/Add-ons/WebExtensions/API/storage/StorageArea/getBytesInUse"><code>storage.StorageArea.getBytesInUse()</code></a></dt>
<dd>Récupère la quantité d'espace de stockage utilisée (exprimée en octets) utilisée pou un ou plusieurs éléments entreposés dans la zone de stockage.</dd>
<dt><a href="/fr/docs/Mozilla/Add-ons/WebExtensions/API/storage/StorageArea/set"><code>storage.StorageArea.set()</code></a></dt>
<dd>Stocke un ou plusieurs éléments dans la zone de stockage. Si l'élément existe déjà, sa valeur est mise à jour.</dd>
<dt><a href="/fr/docs/Mozilla/Add-ons/WebExtensions/API/storage/StorageArea/remove"><code>storage.StorageArea.remove()</code></a></dt>
<dd>Supprime un ou plusieurs éléments de la zone de stockage.</dd>
<dt><a href="/fr/docs/Mozilla/Add-ons/WebExtensions/API/storage/StorageArea/clear"><code>storage.StorageArea.clear()</code></a></dt>
<dd>Supprime tous les éléments de la zone de stockage.</dd>
</dl>
<h2 id="compatibilité_des_navigateurs">Compatibilité des navigateurs</h2>
<p>{{Compat}}</p>
<p><strong>Remerciements :</strong></p>
<p>Cette API est basée sur l'API Chromium <a href="https://developer.chrome.com/extensions/storage"><code>chrome.storage</code></a>. Cette documentation est dérivée de <a href="https://chromium.googlesource.com/chromium/src/+/master/extensions/common/api/storage.json"><code>storage.json</code></a> dans le code de Chromium.</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>
<div class="hidden">
<pre>// Copyright 2015 The Chromium Authors. All rights reserved.
//
// Redistribution and use in source and binary forms, with or without
// modification, are permitted provided that the following conditions are
// met:
//
// * Redistributions of source code must retain the above copyright
// notice, this list of conditions and the following disclaimer.
// * Redistributions in binary form must reproduce the above
// copyright notice, this list of conditions and the following disclaimer
// in the documentation and/or other materials provided with the
// distribution.
// * Neither the name of Google Inc. nor the names of its
// contributors may be used to endorse or promote products derived from
// this software without specific prior written permission.
//
// THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS AND CONTRIBUTORS
// "AS IS" AND ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT
// LIMITED TO, THE IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR
// A PARTICULAR PURPOSE ARE DISCLAIMED. IN NO EVENT SHALL THE COPYRIGHT
// OWNER OR CONTRIBUTORS BE LIABLE FOR ANY DIRECT, INDIRECT, INCIDENTAL,
// SPECIAL, EXEMPLARY, OR CONSEQUENTIAL DAMAGES (INCLUDING, BUT NOT
// LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES; LOSS OF USE,
// DATA, OR PROFITS; OR BUSINESS INTERRUPTION) HOWEVER CAUSED AND ON ANY
// THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY, OR TORT
// (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT OF THE USE
// OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE.
</pre>
</div>
|
