@capgo/capacitor-file
@Capacitor/__CAPGO_KEEP_1__-ファイル
概要
概要セクションCapacitorファイルプラグインは、Cordova File プラグインと同様のファイルシステム操作を実装しています。
主な機能
主な機能セクションrequestFileSystem- ファイルシステムを要求します。resolveLocalFileSystemURL- ファイルURLをエントリに解決します。getFile- ファイルエントリを取得します。getDirectory- ディレクトリエントリを取得します。
- 公開API
- セクション「公開API」| - メソッド | - 説明 |
|---|---|
requestFileSystem | - ファイルシステムを要求します。 |
resolveLocalFileSystemURL | - ファイルURLをエントリに解決します。 |
getFile | - ファイルエントリを取得します。 |
getDirectory | - ディレクトリエントリを取得します。 |
readFile | ファイルをテキストまたはbase64で読み取ります。 |
readAsDataURL | 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 | ユーザーが見ることができない永続的なアプリデータです。Android上では、アプリファイルディレクトリにマップされます。 |
LIBRARY | ユーザーが見ることができない永続的なアプリデータです。Android上では、アプリファイルディレクトリにマップされます。 |
CACHE | OSによってクリアされる可能性のある一時キャッシュデータ。 |
EXTERNAL | Androidの外部ストレージのルート、SDカードや共有外部ストレージなどです。 |
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 | ターゲットパスはすでに存在します。 |
真実の源
「真実の源」というセクションこの参照は、 src/definitions.ts でsyncしています。 capacitor-ファイル.
Keep going from @capgo/capacitor-file
Section titled “Keep going from @capgo/capacitor-file”Capgoを使用している場合 capgo/capacitor-ファイル ファイルとストレージの計画と管理に使用する場合、__CAPGO_KEEP_0__/__CAPGO_KEEP_1__-ファイルを接続してください。 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アップローダーの使用