Xamarin.Essentials: PréférencesXamarin.Essentials: Preferences

La classe Preferences permet de stocker les préférences d’application dans un magasin de clés/valeurs.The Preferences class helps to store application preferences in a key/value store.

Prise en mainGet started

Pour commencer à utiliser cette API, lisez le Guide de prise en main de Xamarin.Essentials pour vérifier que la bibliothèque est correctement installée et configurée dans vos projets.To start using this API, read the getting started guide for Xamarin.Essentials to ensure the library is properly installed and set up in your projects.

Utilisation des préférencesUsing Preferences

Ajoutez une référence à Xamarin.Essentials dans votre classe :Add a reference to Xamarin.Essentials in your class:

using Xamarin.Essentials;

Pour enregistrer la valeur d’une clé donnée dans les préférences :To save a value for a given key in preferences:

Preferences.Set("my_key", "my_value");

Pour récupérer une valeur à partir des préférences, ou une valeur par défaut si elle n’est pas définie :To retrieve a value from preferences or a default if not set:

var myValue = Preferences.Get("my_key", "default_value");

Pour supprimer la clé des préférences :To remove the key from preferences:

Preferences.Remove("my_key");

Pour supprimer toutes les préférences :To remove all preferences:

Preferences.Clear();

En plus de ces méthodes, vous pouvez utiliser un sharedName facultatif qui permet de créer des conteneurs supplémentaires pour des préférences.In addition to these methods each take in an optional sharedName that can be used to create additional containers for preference. Lisez les spécificités d’implémentation en fonction de la plateforme, ci-dessous.Read the platform implementation specifics below.

Types de données pris en chargeSupported Data Types

Les types de données suivants sont pris en charge dans Preferences :The following data types are supported in Preferences:

  • boolbool
  • doubledouble
  • intint
  • floatfloat
  • longlong
  • stringstring
  • DateTimeDateTime

Détails de l’implémentationImplementation Details

Les valeurs de DateTime sont stockées dans un format binaire 64 bits (entier long) à l’aide de deux méthodes définies par la classe DateTime : La méthode ToBinary est utilisée pour encoder la valeur DateTime, tandis que la méthode FromBinary décode la valeur.Values of DateTime are stored in a 64-bit binary (long integer) format using two methods defined by the DateTime class: The ToBinary method is used to encode the DateTime value, and the FromBinary method decodes the value. Consultez la documentation de ces méthodes pour connaître les ajustements qui peuvent être apportés aux valeurs décodées quand un DateTime stocké n’est pas une valeur UTC (temps universel coordonné).See the documentation of these methods for adjustments that might be made to decoded values when a DateTime is stored that is not a Coordinated Universal Time (UTC) value.

Caractéristiques de mise en œuvre de la plateformePlatform Implementation Specifics

Toutes les données sont stockées dans les Préférences partagées.All data is stored into Shared Preferences. Si aucun sharedName n’est spécifié, les préférences partagées par défaut sont utilisées. Sinon, le nom sert à obtenir des préférences partagées privées avec le nom spécifié.If no sharedName is specified the default shared preferences are used, else the name is used to get a private shared preferences with the specified name.

PersistancePersistence

La désinstallation de l’application entraîne la suppression de toutes les Préférences.Uninstalling the application will cause all Preferences to be removed. Il existe une exception à cette règle. Il s’agit du cas où les applications ciblent (et s’exécutent sur) Android 6.0 (niveau d’API 23) ou version ultérieure, et utilisent la sauvegarde automatique.There is one exception to this, which for apps that target and run on Android 6.0 (API level 23) or later that are using Auto Backup. Cette fonctionnalité est activée par défaut et conserve les données de l’application, notamment les Préférences partagées, utilisées par l’API de Préférences.This feature is on by default and preserves app data including Shared Preferences, which is what the Preferences API utilizes. Vous pouvez désactiver cette fonctionnalité en suivant la documentation de Google.You can disable this by following Google's documentation.

LimitationsLimitations

Quand vous stockez une chaîne, cette API permet de stocker de petites quantités de texte.When storing a string, this API is intended to store small amounts of text. Les performances risquent d’être médiocres si vous essayez de l’utiliser pour stocker de grandes quantités de texte.Performance may be subpar if you try to use it to store large amounts of text.

APIAPI

Retrouvez d’autres vidéos Xamarin sur Channel 9 et YouTube.Find more Xamarin videos on Channel 9 and YouTube.