开始使用

安装

您可以使用我们的AI辅助设置来安装插件。使用以下命令将Capgo技能添加到您的AI工具中：

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.

如果您prefer手动设置，安装插件并运行以下命令，然后按照以下平台特定的说明：

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 字符串或类似 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);

安卓保存目录是 downloads, pictures, movies, music, 和 documents。 在安卓 10 及以上版本中，插件通过 MediaStore 写入。 在安卓 9 及以下版本中，公共保存使用清单 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 的参数传递，

类型参考

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 nor 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分享面板未完成时被dismiss。

真实来源

本页面跟踪插件的 src/definitions.ts重新同步公共API时，重新运行同步，当公共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 文件的实现细节 使用 @capgo/capacitor 文件 为在使用 @capgo/capacitor 文件中native能力