@capgo/capacitorファイル

概要

Capacitorファイルプラグイン

主な機能

• requestFileSystem URLからエントリを解決する
• resolveLocalFileSystemURL ファイルエントリを取得する
• getFile __CAPGO_KEEP_0__
• getDirectory - ディレクトリエントリを取得します。

Public 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では常に許可が付与されているため、常に‘許可’を返します。
requestPermissions	Androidでは外部ストレージの許可を要求します。iOSおよびWebでは常に許可が付与されているため、常に‘許可’を返します。

参照値

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

ディレクトリ

値	ユーザーは
DOCUMENTS	Androidではアプリファイルディレクトリに相当する永続的ユーザー表示ドキュメントを発見します。
DATA	永続的プライベートアプリデータ。
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	ターゲットパスはすでに存在します。

ソースオブトゥルス

This reference is synced from __CAPGO_KEEP_0__ src/definitions.ts in capacitor-file.

Section titled “@capgo/capacitor-fileから続ける”

__CAPGO_KEEP_0__/__CAPGO_KEEP_1__-fileを使用して Using @capgo/capacitor-file ファイルとストレージの管理を計画するには、接続する capgo/capacitor-fileを使用して capgo/capacitor-file capgo/capacitor-fileの設定 @capgo/capacitorデータストレージSQLite @capgo/capacitorデータストレージ（SQLite） Capgoのネイティブ機能のために@capgo/capacitor-data-storage-sqliteを使用します。 @capgo/capacitor-ファイルアップローダ for the @capgo/capacitor-uploader の実装詳細について、 @capgo/capacitor-ファイルアップローダ Capgoのネイティブ機能のために@capgo/capacitorアップローダーを使用します。