Getting Started

Install

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セットアップを使用する場合は、以下のコマンドを実行してプラグインをインストールし、以下のプラットフォーム固有の指示に従ってください。

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 Capgoマーケティングサイトのページエージェントのコピーラベル data:application/pdf;base64,....

Base64文字列またはデータURL

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

ローカルファイルを共有する file:// ローカルパス、URL、Android URI、__CAPGO_KEEP_0__ content:// URI と Capacitor _capacitor_file_ ローカルファイルを保存する

ローカルファイルを共有する

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

console.log(result.uri);

コンテキスト: Capgo マーケティング ウェブサイト。役割: UI ラベル。ページ/エリア: page agents/[slug].astro。メッセージキー `agents_page_copy_label` (Agents Page Copy Label)。 downloads, pictures, movies, music, and documents, そして WRITE_EXTERNAL_STORAGE . Android 10 以降では、プラグインは MediaStore を介して書き込む。Android 9 以下では、パブリック セーブはマニフェスト maxSdkVersion=28.

許可権と

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

text セクションのタイトル “テキストをファイルと共に共有” EXTRA_TEXT Android では

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がアップストリームで変更されたときは、再度同期を実行してください。

続けて「Getting Started」から進みましょう

Capgoを使用している場合 スタートガイド ファイルの保存と管理を計画するにはCapgoを使用してください Using @capgo/capacitor-file-sharer Capgoのnative機能である@capgo/capacitor-file-sharerを使用してください @capgo/capacitor-データストレージ（SQLite） Capgoのnative機能である@capgo/capacitor-data-storage-sqliteを使用してください Capgoのnative機能である@capgo/capacitor-fileを使用してください Capgoのnative機能である@capgo/capacitor-fileを使用してください Capgoのnative機能である@capgo/capacitor-fileを使用してください Capgoのnative機能である@capgo/capacitor-fileを使用してください Capgoの@capgo/capacitor-file Capgoの@capgo/capacitor-fileのネイティブ機能