はじめに

インストール

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 ローカルファイルを共有 data:application/pdf;base64,....

__CAPGO_KEEP_0__

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

__CAPGO_KEEP_0__のnative実装はローカルパス、 file:// URL、Android content:// URIs, and 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以下の場合、パブリックセーブはmanifestを使用します。 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 __CAPGO_KEEP_0__がAndroidで、iOSでは2番目のアクティビティアイテムとして渡されます。 EXTRA_TEXT 型参照

「型参照」セクション

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 __CAPGO_KEEP_0__が欠落しているか、空白です。
• ERR_PARAM_NO_DATA __CAPGO_KEEP_0__は、__CAPGO_KEEP_1__も__CAPGO_KEEP_2__も指定されていません。 base64Data __CAPGO_KEEP_0__は、__CAPGO_KEEP_1__も__CAPGO_KEEP_2__も指定されていません。 path __CAPGO_KEEP_0__のbase64入力がデコードできませんでした。
• ERR_PARAM_DATA_INVALID __CAPGO_KEEP_0__のローカルパスまたはコンテンツURIが開けませんでした。
• ERR_LOCAL_FILE_NOT_FOUND __CAPGO_KEEP_0__のネイティブのトemporaryファイルが書き込めませんでした。
• ERR_FILE_CACHING_FAILED __CAPGO_KEEP_0__のAndroidがパブリックストレージにファイルを保存できませんでした。
• ERR_FILE_SAVE_FAILED neither __CAPGO_KEEP_0__ nor __CAPGO_KEEP_1__ was provided.
• ERR_ACTIVITY_NOT_FOUND - Android は共有ターゲットを開くことができませんでした。
• USER_CANCELLED - iOS の共有シートは、完了する前に閉じられました。

真実の源

このページではプラグインの src/definitions.ts. upstream の公開 API が変更された場合、再度 Sync を実行してください。