storage.sync
Représente la zone de stockage sync (pour la synchronisation). Les éléments stockés dans le stockage sync 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.
Pour Firefox, il faut au préalable avoir coché « Modules complémentaires » dans les options « Réglages de Sync » dans « about:preferences.
Notez que l'implémentation de storage.sync dans Firefox repose sur l'ID de l'extension. Si vous utilisez storage.sync, vous devez définir un ID pour votre extension à l'aide de la clé de manifeste browser_specific_settings.
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.
Quotas de stockage pour les données synchronisées
Le navigateur impose des limites sur la quantité de données que chaque extension peut stocker dans le stockage sync :
| Nom | Description | Valeur en octets |
|---|---|---|
| Taille de stockage maximale | 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é. | 102400 |
| Taille maximale d'un élément | 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é. | 8192 |
| Nombre maximal d'éléments | Le nombre maximal d'éléments que chaque extension peut stocker dans l'espace de stockage sync. | 512 |
Si une extension tente de stocker des éléments qui dépassent ces limites, l'appel à storage.sync.set() sera rejeté avec une erreur. Une extension peut utiliser storage.sync.getBytesInUse() afin de connaître le quota d'espace déjà utilisé.
Méthodes
L'objet sync implémente les méthodes définies sur le type storage.StorageArea :
storage.StorageArea.get()-
Récupère un ou plusieurs éléments de la zone de stockage.
storage.StorageArea.getBytesInUse()-
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.
storage.StorageArea.set()-
Stocke un ou plusieurs éléments dans la zone de stockage. Si l'élément existe déjà, sa valeur est mise à jour.
storage.StorageArea.remove()-
Supprime un ou plusieurs éléments de la zone de stockage.
storage.StorageArea.clear()-
Supprime tous les éléments de la zone de stockage.
Compatibilité des navigateurs
BCD tables only load in the browser
Remerciements :
Cette API est basée sur l'API Chromium chrome.storage. Cette documentation est dérivée de storage.json dans le code de Chromium.
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.