开始使用

安装

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:// URLs、Android content:// URIs、和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和以下版本中，公共保存使用清单 WRITE_EXTERNAL_STORAGE permission with 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 上

类型参考

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 继续

如果您正在使用 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-data-storage-sqlite 原生能力 @capgo/capacitor-file 为 @capgo/capacitor-file 实现细节, 和 使用 @capgo/capacitor-file 为 @capgo/capacitor-file 原生能力