Xamarin.EssentialsPréférences :

  • Article

La classe Preferences permet de stocker les préférences d’application dans un magasin de clés/valeurs.

Démarrage

Pour commencer à utiliser cette API, lisez le guide de prise en main pour Xamarin.Essentials vous assurer que la bibliothèque est correctement installée et configurée dans vos projets.

Utilisation des préférences

Ajoutez une référence à Xamarin.Essentials votre classe :

using Xamarin.Essentials;

Pour enregistrer la valeur d’une clé donnée dans les préférences :

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 :

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

Pour vérifier si une clé donnée existe dans les préférences :

bool hasKey = Preferences.ContainsKey("my_key");

Pour supprimer la clé des préférences :

Preferences.Remove("my_key");

Pour supprimer toutes les préférences :

Preferences.Clear();

Conseil

Les méthodes ci-dessus prennent un paramètre facultatif string appelé sharedName. Ce paramètre est utilisé pour créer des conteneurs supplémentaires pour les préférences qui sont utiles dans certains cas d’usage. L’un des cas d’usage est le cas où votre application doit partager des préférences entre les extensions ou une application espion. Lisez les détails de l’implémentation de la plateforme ci-dessous.

Types de données pris en charge

Les types de données suivants sont pris en charge dans Preferences :

  • bool
  • double
  • int
  • float
  • long
  • string
  • DateTime

Intégrer avec les paramètres système

Les préférences sont stockées en mode natif, ce qui vous permet d’intégrer vos paramètres dans les paramètres système natifs. Suivez la documentation de la plateforme et les exemples à intégrer à la plateforme :

Informations d’implémentation

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 sert à encoder la valeur de DateTime, alors que la méthode FromBinary sert à décoder la valeur. 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é).

Caractéristiques de mise en œuvre de la plateforme

Toutes les données sont stockées dans les Préférences partagées. Si aucune valeur n’est sharedName spécifiée, les préférences partagées par défaut sont utilisées, sinon le nom est utilisé pour obtenir des préférences partagées privées avec le nom spécifié.

Persistance

La désinstallation de l’application entraîne la suppression de toutes les préférences, à l’exception des applications qui ciblent et s’exécutent sur Android 6.0 (niveau d’API 23) ou version ultérieure qui utilisent la sauvegarde automatique. 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. Vous pouvez désactiver cette fonctionnalité en suivant la documentation de Google.

Limites

Quand vous stockez une chaîne, cette API permet de stocker de petites quantités de texte. Les performances risquent d’être médiocres si vous essayez de l’utiliser pour stocker de grandes quantités de texte.

API

Retrouvez d’autres vidéos Xamarin sur Channel 9 et YouTube.