@capgo/capacitor-file

Capacitorファイルプラグイン

概要

Capacitorファイルプラグインは、Cordova File プラグインと同様のファイルシステム操作を実装しています。

基本機能

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

Public API

メソッド	説明
`requestFileSystem`	ファイルシステムを要求します。
`resolveLocalFileSystemURL`	ファイル URL をエントリに解決します。
`getFile`	ファイルエントリを取得します。
`getDirectory`	ディレクトリエントリを取得します。
`readFile`	ファイルをテキストまたはbase64で読み込む。
`readAsDataURL`	ファイルをbase64で読み込む (MIMEタイププレフィックス付き)。
`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では、特別な許可が必要ないため、常に「許可」が返されます。
`requestPermissions`	ファイル操作の許可を要求します。Androidでは、外部ストレージの許可が必要なファイルをアプリのプライベートディレクトリ外でアクセスするために必要です。iOSとWebでは、特別な許可が必要ないため、常に「許可」が返されます。

リファレンス値

保存場所を選択するとき、エンコードされたテキストを書き込むとき、またはファイルエラーを処理するときに、これらの値を使用してください。

ディレクトリ

値	ユーザーは次のファイルを見つけることができます。
`DOCUMENTS`	Android上では、ユーザーが見ることができない永続的なアプリケーションデータです。
`DATA`	ユーザーが見ることができない永続的なアプリケーションデータです。Android上では、アプリケーションファイルディレクトリにマップされます。
`LIBRARY`	OSがクリアする可能性がある一時的なキャッシュデータ。
`CACHE`	Androidの外部ストレージのルート、例えばSDカードまたは共有外部ストレージです。
`EXTERNAL`	__CAPGO_KEEP_0__
`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`	ターゲットパスはすでに存在します。

ソース・オブ・トゥルース

この参照は、@__CAPGO_KEEP_0__/__CAPGO_KEEP_1__-fileからsyncされています。 src/definitions.ts in capacitor-ファイル.

capgoから始めて@capgo/capacitor-file

あなたが使用している場合 @capgo/capacitor-file ファイルのストレージとハンドリングを計画するために使用している場合、@__CAPGO_KEEP_0__/__CAPGO_KEEP_1__-fileを接続してください Capgoの@capgo/capacitorファイル Capgoの@capgo/capacitorファイルの使用 Capgoの@capgo/capacitorデータストレージのSQLite Capgoの@capgo/capacitorデータストレージのSQLiteの実装 Capgoの@capgo/capacitorデータストレージのSQLiteの使用 Capgoの@capgo/capacitorデータストレージのSQLiteの実装 Capgoの@capgo/capacitorアップローダー Capgoの@capgo/capacitorアップローダーの実装 Capgoの@capgo/capacitorアップローダーの使用 Capgoの@capgo/capacitorアップローダーの実装