Xamarin.Essentials: ファイル システム ヘルパーXamarin.Essentials: File System Helpers

FileSystem クラスには、アプリケーションのキャッシュ ディレクトリやデータ ディレクトリを検索したり、アプリ パッケージ内のファイルを開いたりする、一連のヘルパーが含まれています。The FileSystem class contains a series of helpers to find the application's cache and data directories and open files inside of the app package.

作業開始Get started

この API の使用を始めるには、Xamarin.Essentials の概要ガイドを読み、ライブラリが正しくインストールされてプロジェクトに設定されていることを確認してください。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.

FileSystem の使用Using File System Helpers

自分のクラスの Xamarin.Essentials に参照を追加します。Add a reference to Xamarin.Essentials in your class:

using Xamarin.Essentials;

キャッシュ データを格納するアプリケーションのディレクトリを取得するには、次のようにします。To get the application's directory to store cache data. キャッシュ データは、一時的なデータより長く保持する必要があるデータに対して使用できますが、正しく動作する必要のあるデータには使用できません。Cache data can be used for any data that needs to persist longer than temporary data, but should not be data that is required to properly operate.

var cacheDir = FileSystem.CacheDirectory;

ユーザー データ ファイルではないファイルに対するアプリケーションの最上位ディレクトリを取得するには、次のようにします。To get the application's top-level directory for any files that are not user data files. これらのファイルは、オペレーティング システムの同期フレームワークでバックアップされます。These files are backed up with the operating system syncing framework. 以下のプラットフォームの実装の詳細をご覧ください。See Platform Implementation Specifics below.

var mainDir = FileSystem.AppDataDirectory;

アプリケーション パッケージにバンドルされているファイルを開くには:To open a file that is bundled into the application package:

 using (var stream = await FileSystem.OpenAppPackageFileAsync(templateFileName))
 {
    using (var reader = new StreamReader(stream))
    {
        var fileContents = await reader.ReadToEndAsync();
    }
 }

プラットフォームの実装の詳細Platform Implementation Specifics

  • CacheDirectory – 現在のコンテキストの CacheDir を返します。CacheDirectory – Returns the CacheDir of the current context.
  • AppDataDirectory – 現在のコンテキストの FilesDir を返します。API 23 以降では、自動バックアップを使用してバックアップされます。AppDataDirectory – Returns the FilesDir of the current context and are backed up using Auto Backup starting on API 23 and above.

ファイルを Android プロジェクトの Assets フォルダーに追加し、OpenAppPackageFileAsync で使用されるようにビルド アクションを AndroidAsset としてマークします。Add any file into the Assets folder in the Android project and mark the Build Action as AndroidAsset to use it with OpenAppPackageFileAsync.

APIAPI