@capgo/capacitor-file

ファイルやディレクトリの読み書き、管理を行うフル機能のファイルシステムプラグイン

概要

ファイルやディレクトリの読み書き、管理を行うフル機能のファイルシステムプラグイン

まずは requestFileSystem() および以下に示すその他のコアメソッド。

プラットフォーム対応

プラットフォーム	サポート	備考
iOSと	はい	ネイティブ
Androidでは	はい	ネイティブ
Web	はい	ブラウザのストレージ API

コア機能

requestFileSystem - ファイルシステムをリクエストします。
resolveLocalFileSystemURL - ファイル URL をエントリに解決します。
getFile - ファイルエントリを取得します。
getDirectory - ディレクトリエントリを取得します。

公開 API

メソッド	説明
`requestFileSystem`	ファイルシステムをリクエストします。
`resolveLocalFileSystemURL`	ファイルURLをエントリーに解決します。
`getFile`	ファイルエントリーを取得します。
`getDirectory`	ディレクトリエントリを取得します。
`readFile`	ファイルをテキストまたはbase64として読み込みます。
`readAsDataURL`	ファイルをData URL（MIMEタイプのプレフィックス付きbase64）として読み込みます。
`writeFile`	ファイルにデータを書き込みます。
`appendFile`	ファイルにデータを追記します。
`deleteFile`	ファイルを削除します。
`mkdir`	ディレクトリを作成します。
`rmdir`	ディレクトリを削除します。
`readdir`	ディレクトリの内容を読み取ります。
`stat`	ファイルまたはディレクトリのメタデータを取得します。
`getMetadata`	ファイルまたはディレクトリのメタデータを取得します。stat() のエイリアスです。
`rename`	ファイルまたはディレクトリの名前を変更または移動します。
`move`	ファイルまたはディレクトリを移動します。rename() のエイリアスです。
`copy`	ファイルまたはディレクトリをコピーします。
`exists`	ファイルまたはディレクトリが存在するか確認します。
`getUri`	ファイルのURIを取得します。
`truncate`	ファイルを指定したサイズに切り詰めます。
`getDirectories`	既知のファイルシステムディレクトリをすべて取得します。
`getFreeDiskSpace`	空きディスク容量をバイト単位で取得します。
`addListener`	読み取り進捗イベントを監視します。
`addListener`	書き込み進捗イベントを監視します。
`removeAllListeners`	すべてのイベントリスナーを削除します。
`getPluginVersion`	プラグインのバージョンを取得します。
`checkPermissions`	ファイル操作の現在の権限ステータスを確認します。Android では外部ストレージの権限を確認します。iOS と Web では、特別な権限が不要なため常に 'granted' を返します。
`requestPermissions`	ファイル操作の権限を要求します。Android では、アプリのプライベートディレクトリ外のファイルにアクセスするために必要な外部ストレージの権限を要求します。iOS と Web では、特別な権限が不要なため常に 'granted' を返します。

リファレンス値

ストレージ場所の選択、エンコードされたテキストの書き込み、またはファイルエラーの処理時にこれらの値を使用します。

ディレクトリ

値	ユーザーは以下を確認できます：
`DOCUMENTS`	永続的なユーザー表示ドキュメント。Android ではアプリのファイルディレクトリにマッピングされます。
`DATA`	永続的なアプリのプライベートデータ。
`LIBRARY`	ユーザーに表示されない永続的なアプリデータ。Android ではアプリのファイルディレクトリにマッピングされます。
`CACHE`	OS がクリアする可能性のある一時キャッシュデータ。
`EXTERNAL`	SD カードや共有外部ストレージなどの Android 外部ストレージルート。
`EXTERNAL_STORAGE`	Android 外部ストレージのデータディレクトリ。
`APPLICATION`	読み取り専用のアプリケーションバンドルまたはアセットディレクトリ。

エンコーディング

値	使用する
`utf8`	UTF-8 テキスト。
`ascii`	ASCII テキスト。
`utf16`	UTF-16 テキスト。

ファイルエラーコード

値	Code	意味
`NOT_FOUND_ERR`	`1`	ファイルまたはディレクトリが見つかりませんでした。
`SECURITY_ERR`	`2`	セキュリティルールまたは権限により操作がブロックされました。
`ABORT_ERR`	`3`	操作が中止されました。
`NOT_READABLE_ERR`	`4`	ファイルまたはディレクトリを読み取れません。
`ENCODING_ERR`	`5`	エンコーディングが無効、またはサポートされていません。
`NO_MODIFICATION_ALLOWED_ERR`	`6`	対象を変更できません。
`INVALID_STATE_ERR`	`7`	オブジェクトが操作に適さない状態です。
`SYNTAX_ERR`	`8`	パスまたは入力の構文が無効です。
`INVALID_MODIFICATION_ERR`	`9`	要求された変更は対象に対して無効です。
`QUOTA_EXCEEDED_ERR`	`10`	ストレージのクォータを超えました。
`TYPE_MISMATCH_ERR`	`11`	値の型が期待される型と一致しません。
`PATH_EXISTS_ERR`	`12`	対象のパスは既に存在します。

Source of Truth

このリファレンスは以下から同期されています： src/definitions.ts における capacitor-file.

@capgo/capacitor-fileから続ける

使用している場合 @capgo/capacitor-file ストレージとファイル処理を計画するには、以下と連携してください： @capgo/capacitor-file の使い方「@capgo/capacitor-fileの使用」のネイティブ機能について @capgo/capacitor-data-storage-sqlite @capgo/capacitor-data-storage-sqlite の実装の詳細については、 @capgo/capacitor-data-storage-sqlite の使い方「@capgo/capacitor-data-storage-sqliteの使用方法」におけるネイティブ機能について、 @capgo/capacitor-uploader @capgo/capacitor-uploader の実装詳細については、 @capgo/capacitor-uploader の使用方法 @capgo/capacitor-uploader. を使用したネイティブ機能については