Getting Started

インストール

Capgo の AI アシスト セットアップを使用してプラグインをインストールできます。AI ツールに Capgo スキルを追加するには、以下のコマンドを実行してください。

npx skills add https://github.com/Cap-go/capgo-skills --skill capacitor-plugins

次に、以下のプロンプトを使用してください:

Use the `capacitor-plugins` skill from `Cap-go/capgo-skills` to install the `@capgo/capacitor-file-sharer` plugin in my project.

Manual Setupを使用する場合は、以下のコマンドを実行してプラグインをインストールし、以下のプラットフォーム固有の指示に従ってください:

bun add @capgo/capacitor-file-sharer
bunx cap sync

インポート

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

Base64ファイルを共有

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

await FileSharer.share({
  filename: 'report.pdf',
  contentType: 'application/pdf',
  base64Data: reportBase64,
  title: 'Quarterly report',
  text: 'Attached report',
});

base64Data base64の文字列またはデータURLであることができます data:application/pdf;base64,....

ローカルファイルを共有

await FileSharer.share({
  filename: 'export.zip',
  contentType: 'application/zip',
  path: fileUri,
});

ネイティブ実装ではローカルパス、 file:// URL、Android content:// URI、Capacitor _capacitor_file_ URL。

ファイルを保存

const result = await FileSharer.save({
  filename: 'backup.zip',
  contentType: 'application/zip',
  base64Data: zipBase64,
  android: {
    saveDirectory: 'downloads',
    relativePath: 'Download/My App',
  },
});

console.log(result.uri);

Androidの保存ディレクトリは downloads, pictures, movies, music、および documents. Android 10 以降では、プラグインは MediaStore を介して書き込まれます。 Android 9 以下では、パブリック セーブはマニフェスト WRITE_EXTERNAL_STORAGE パーミッションと共に maxSdkVersion=28.

テキストをファイルと共に共有

await FileSharer.share({
  filename: 'photo.jpg',
  contentType: 'image/jpeg',
  path: photoUri,
  title: 'Site photo',
  subject: 'Photo export',
  text: 'Captured during inspection.',
});

text はAndroidでは EXTRA_TEXT iOSでは2番目のアクティビティアイテムとして渡されます。

型参照

ShareFileOptions

export interface ShareFileOptions {
  filename: string;
  base64Data?: string;
  path?: string;
  contentType?: string;
  text?: string;
  title?: string;
  subject?: string;
  android?: AndroidFileSharerOptions;
}

AndroidFileSharerOptions

export interface AndroidFileSharerOptions {
  chooserTitle?: string;
  saveDirectory?: 'downloads' | 'pictures' | 'movies' | 'music' | 'documents';
  relativePath?: string;
}

SaveFileResult

export interface SaveFileResult {
  uri?: string;
}

エラーコード

• ERR_PARAM_NO_FILENAME - filename 指定された値が欠落しているか、空白です。
• ERR_PARAM_NO_DATA どちらも base64Data どちらも path 指定された値が取得できませんでした。
• ERR_PARAM_DATA_INVALID base64形式の入力データのデコードに失敗しました。
• ERR_LOCAL_FILE_NOT_FOUND - 提供されたローカルパスまたはコンテンツURIが開けませんでした。
• ERR_FILE_CACHING_FAILED - ネイティブのテンポラリファイルが書き込めませんでした。
• ERR_FILE_SAVE_FAILED - Androidはパブリックストレージにファイルを保存できませんでした。
• ERR_ACTIVITY_NOT_FOUND - Androidは共有ターゲットを開けませんでした。
• USER_CANCELLED - iOSの共有シートは完了せずに閉じられました。

真実の源

このページではプラグインの src/definitions.tsパブリックAPIがアップストリームで変更された場合に再度Syncを実行してください。

Getting Startedから続けてください

あなたが使用している はじめに を計画し、ファイルの取り扱いと接続する @capgo/capacitor-file-sharerを使用する @capgo/capacitor-file-sharerのネイティブ機能を使用する @capgo/capacitor-data-storage-sqliteを使用する @capgo/capacitor-data-storage-sqliteの実装詳細を参照する @capgo/capacitor-data-storage-sqliteのネイティブ機能を使用する @capgo/capacitor-fileを使用する @capgo/capacitor-fileの実装詳細を参照する @capgo/capacitor-fileのネイティブ機能を使用する @capgo/capacitor-file @capgo/capacitor-file