Xamarin.Essentials: Helpers du système de fichiers

La classe FileSystem contient une série de composants d’assistance qui permettent de rechercher les répertoires de cache et de données de l’application, ainsi que d’ouvrir des fichiers contenus dans le paquet d’application.

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 composants d’assistance de système de fichiers

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

using Xamarin.Essentials;

Permet au répertoire de l’application de stocker les données du cache. Vous pouvez utiliser les données de cache pour toutes les données à conserver plus longtemps que les données temporaires, car le système d’exploitation dicte le moment où le stockage est effacé.

var cacheDir = FileSystem.CacheDirectory;

Permet d’obtenir le répertoire de niveau supérieur de l’application pour tous les fichiers qui ne sont pas des fichiers de données utilisateur. Ces fichiers sont sauvegardés avec le framework de synchronisation du système d’exploitation. Consultez les spécificités d’implémentation en fonction de la plateforme, ci-dessous.

var mainDir = FileSystem.AppDataDirectory;

Si vous souhaitez ouvrir un fichier qui a été regroupé dans le package d’application, vous pouvez utiliser la OpenAppPackageFileAsync méthode pour lire le contenu. Dans l’exemple ci-dessous, un fichier nommé mybundledfile.txt a été ajouté à chaque plateforme. Pour plus d’informations, consultez la section Spécificités de l’implémentation de la plateforme.

 var fileName = "mybundledfile.txt";
 using (var stream = await FileSystem.OpenAppPackageFileAsync(fileName))
 {
    using (var reader = new StreamReader(stream))
    {
        var fileContents = await reader.ReadToEndAsync();
    }
 }

Caractéristiques de mise en œuvre de la plateforme

Android

• CacheDirectory - Retourne le CacheDir du contexte actuel.
• AppDataDirectory - Retourne le FilesDir du contexte actuel, qui est sauvegardé via la sauvegarde automatique à partir du niveau d’API 23.

Ajoutez un fichier au dossier Composants du projet Android, et marquez l’action de génération en tant qu’AndroidAsset pour pouvoir l’utiliser avec OpenAppPackageFileAsync.

iOS

• CacheDirectory - Retourne le répertoire Library/Caches.
• AppDataDirectory - Retourne le répertoire Library sauvegardé par iTunes et iCloud.

Important

Dans le simulateur iOS, l’ID d’application (qui fait partie du nom du répertoire) change à chaque build, de sorte que vous devez récupérer l’ID correct chaque fois que vous générez votre application pour le simulateur.

Ajoutez un fichier au dossier Ressources du projet iOS, et marquez l’action de génération en tant que BundledResource pour pouvoir l’utiliser avec OpenAppPackageFileAsync.

UWP

• CacheDirectory - Retourne le répertoire LocalCacheFolder.
• AppDataDirectory - Retourne le répertoire LocalFolder sauvegardé dans le cloud.

Ajoutez un fichier à la racine du projet UWP, et marquez l’action de génération en tant que Content pour pouvoir l’utiliser avec OpenAppPackageFileAsync.

API

• Code source de la fonctionnalité des composants d’assistance de système de fichiers
• Documentation sur l’API de système de fichiers

Vidéo associée

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