Getting Started

Install

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

Import

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形式の文字列や data:application/pdf;base64,....

Base64形式の文字列や

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

ローカルパス、 file:// URLs、Android content:// URIs, and Capacitor _capacitor_file_ URLs.

ファイルを保存

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

真実の源

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

Getting Started から続けてください

Capacitor を使用している場合 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を参照してください。 native機能の使用にあたっては、@capgo/capacitor-data-storage-sqliteを使用します。 native機能の使用にあたっては、@capgo/capacitor-data-storage-sqliteを使用します。 @capgo/capacitor-file 実装詳細については、@capgo/capacitor-fileを参照してください。 native機能の使用にあたっては、@capgo/capacitor-fileを使用します。 native機能の使用にあたっては、@capgo/capacitor-fileを使用します。