Xamarin.Essentials:Préférences
La classe Preferences permet de stocker les préférences d’application dans un magasin de clés/valeurs.
Bien démarrer
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 dans 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 case activée 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 acceptent un paramètre facultatif string appelé sharedName. Ce paramètre est utilisé pour créer des conteneurs supplémentaires pour les préférences, ce qui est utile dans certains cas d’usage. Un cas d’usage est lorsque votre application doit partager des préférences entre des extensions ou avec une application watch. 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 aux 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 et les exemples de la plateforme pour l’intégrer à la plateforme :
- Apple : Implémentation d’un bundle de paramètres iOS
- Exemple de préférences d’application iOS
- WatchOS Settings
- Android : Prise en main avec les écrans de paramètres
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 aucun n’est sharedName spécifié, 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.