@capgo/capacitor-file

概要

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

基本機能

• requestFileSystem - ファイルシステムを要求します。
• resolveLocalFileSystemURL - ファイルURLをエントリに解決します。
• getFile - ファイルエントリを取得します。
• 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	ユーザーが見ることができない永続的なアプリケーションデータ。
DATA	ユーザーが見ることができない永続的なアプリケーションデータ。Androidでは、app files directoryにマップされます。
LIBRARY	OSによってクリアされる可能性のある一時キャッシュデータ。
CACHE	Androidの外部ストレージのルート、例えばSDカードまたは共有外部ストレージ
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 で capacitor-ファイル.

capgoから続けて@capacitor/capgo-ファイル

あなたが使用している場合 @capgo/capacitor-ファイル ファイルとストレージの計画に使用する場合、@__CAPGO_KEEP_0__/__CAPGO_KEEP_1__-ファイルを接続してください Using @capgo/capacitor-file for the native capability in Using @capgo/capacitor-file, @capgo/capacitor-data-storage-sqlite for the implementation detail in @capgo/capacitor-data-storage-sqlite, Using @capgo/capacitor-data-storage-sqlite for the native capability in Using @capgo/capacitor-data-storage-sqlite, @capgo/capacitor-uploader for the implementation detail in @capgo/capacitor-uploader, and Using @capgo/capacitor-uploader for the native capability in Using @capgo/capacitor-uploader.