メインコンテンツへスキップ
@capgo/capacitor-file ファイルとストレージ オープンソース

ファイル Capacitor プラグイン

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

インストール

bun add @capgo/capacitor-file bunx cap sync
npm、pnpm、または yarn
  • npm install @capgo/capacitor-file
  • pnpm add @capgo/capacitor-file
  • yarn add @capgo/capacitor-file

ガイド

Capacitor で File を使う方法

@capgo/capacitor-file の使い方

Capacitor File Plugin は、Cordova File plugin と同様のファイルシステム操作を実装します。

インストール

bun add @capgo/capacitor-file
bunx cap sync

bunx cap sync プラグインのネイティブcodeをネイティブプロジェクトにコピーします。プラグインをアップグレードするたびに再度実行してください。

インポート

import { CapacitorFile } from '@capgo/capacitor-file';

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 空きディスク容量をバイト単位で取得します。
checkPermissions ファイル操作の現在の権限ステータスを確認します。Androidでは外部ストレージの権限を確認します。iOSとWebでは、特別な権限が不要なため常に 'granted' を返します。
requestPermissions ファイル操作の権限をリクエストします。Androidでは、アプリのプライベートディレクトリ外のファイルにアクセスするために必要な外部ストレージ権限をリクエストします。iOSとWebでは、特別な権限が不要なため常に 'granted' を返します。

例

requestFileSystem()

ファイルシステムをリクエストします。

import { CapacitorFile, FileSystemType } from '@capgo/capacitor-file';

const result = await CapacitorFile.requestFileSystem({ type: FileSystemType.TEMPORARY });
console.log(result);

resolveLocalFileSystemURL()

ファイルURLをエントリーに解決します。

import { CapacitorFile } from '@capgo/capacitor-file';

const result = await CapacitorFile.resolveLocalFileSystemURL({ url: 'https://example.com' });
console.log(result);

getFile()

ファイルエントリーを取得します。

import { CapacitorFile } from '@capgo/capacitor-file';

const result = await CapacitorFile.getFile({ path: 'path/to/file' });
console.log(result);

getDirectory()

ディレクトリエントリを取得します。

import { CapacitorFile } from '@capgo/capacitor-file';

const result = await CapacitorFile.getDirectory({ path: 'path/to/file' });
console.log(result);

readFile()

ファイルをテキストまたはbase64として読み込みます。

import { CapacitorFile } from '@capgo/capacitor-file';

const result = await CapacitorFile.readFile({ path: 'path/to/file' });
console.log(result);

readAsDataURL()

ファイルをデータURL(MIMEタイプ接頭辞付きのbase64)として読み込みます。

import { CapacitorFile } from '@capgo/capacitor-file';

const result = await CapacitorFile.readAsDataURL({ path: 'path/to/file' });
console.log(result);

上記の表は24個のコアメソッドを一覧にしています。リスナーとバージョンのヘルパー、および各メソッドの完全な仕様は、次のドキュメントに記載されています。 GitHub リポジトリ.

イベントをリッスンする

addListener ハンドルを返します。画面がアンマウントされるときに handle.remove() 画面がアンマウントされるとき、または CapacitorFile.removeAllListeners() すべてのリスナーを解除します。

完全なリファレンス

「@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. の実装の詳細については

よくある質問

File plugin FAQ

Capacitor アプリに File プラグインをインストールするには?

"bun add @capgo/capacitor-file"(または "npm install @capgo/capacitor-file")を実行した後、"bunx cap sync" を実行して iOS および Android プロジェクトにネイティブの code を反映させてください。その後、アプリの code から "@capgo/capacitor-file" をインポートします。

@capgo/capacitor-file は React、Vue、Angular で動作しますか?

はい。File は Capacitor パッケージなので、Ionic、React、Vue、Angular、Svelte、およびプレーンな JavaScript を含む、Capacitor 内で動作するあらゆる Web フレームワークで使用できます。

@capgo/capacitor-file はどの Capacitor バージョンをサポートしていますか?

Capgo プラグインは Capacitor のメジャーバージョンに合わせています。使用している Capacitor のメジャーバージョンに一致するプラグインのメジャーバージョンを使ってください (例: Capacitor 8 ならプラグイン v8)。GitHub の README にある互換性テーブルに、メンテナンス中のバージョンが記載されています。

@capgo/capacitor-file は無料でオープンソースですか?

はい。code のソースコードは GitHub の https://github.com/Cap-go/capacitor-file/ で公開されており、パッケージは npm から無料でインストールできます。バグ報告やプルリクエストも歓迎しています。

App Store の審査なしで、File を使用している code をアップデートできますか?

プラグインのインストールやアップグレードはネイティブの code を変更するため、新しいストアビルドが必要です。その後は、プラグインを呼び出す JavaScript、HTML、CSS の変更を Capgo Live Updates で即座に配信できます。

アプリの審査を待たずに、ファイルの変更を即座に配信

プラグインをストア用ビルドに組み込めば、Capgo live updates で JavaScript、HTML、CSS の変更を数分でユーザーに配信できます

Capgo から始める