Getting Started

インストール

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,....

Base64ファイルを共有

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

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

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);

コピー downloads, pictures, movies, musicAndroidの保存ディレクトリは 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 指定された EXTRA_TEXT AndroidではとiOSでは2番目のアクティビティアイテムとして

Type Reference

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__に基づいてデコードできませんでした。 path __CAPGO_KEEP_0__が指定されたローカルパスまたはコンテンツURIが開けませんでした。
• ERR_PARAM_DATA_INVALID __CAPGO_KEEP_0__が指定されたネイティブのテンポラリファイルを書き込めませんでした。
• ERR_LOCAL_FILE_NOT_FOUND __CAPGO_KEEP_0__がパブリックストレージにファイルを保存できませんでした。
• ERR_FILE_CACHING_FAILED -__CAPGO_KEEP_0__
• ERR_FILE_SAVE_FAILED -__CAPGO_KEEP_0__も__CAPGO_KEEP_1__も指定されていません。
• ERR_ACTIVITY_NOT_FOUND - Android は共有ターゲットを開くことができませんでした。
• USER_CANCELLED - iOS の共有シートは、完了することなく閉じられました。

ソース オブ トゥルース

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

Getting Started から続けてください

Capgo を使用している場合 Getting Started を使用してストレージとファイルハンドリングを計画する場合は、@__CAPGO_KEEP_0__/__CAPGO_KEEP_1__-file-sharer に接続してください。 Using @capgo/capacitor-file-sharer native機能の使用にあたっては、@capgo/capacitor-file-sharerを使用します。 @capgo/capacitor-data-storage-sqlite 実装詳細の場合、@capgo/capacitor-data-storage-sqliteを使用します。 @capgo/capacitor-data-storage-sqliteを使用します。 native機能の使用にあたっては、@capgo/capacitor-data-storage-sqliteを使用します。 @capgo/capacitor-file 実装詳細の場合、@capgo/capacitor-fileを使用します。 @capgo/capacitor-fileを使用します。 native機能の使用にあたっては、@capgo/capacitor-fileを使用します。