跳到主要内容
版本:v4

@capacitor/share

分享 API 提供了在用户已安装的支持分享的应用中分享内容的方法。

分享 API 适用于 iOS、Android 和 Web(使用新的 Web Share API),不过 Web 支持目前还不完善。

安装

npm install @capacitor/share
npx cap sync

Android

默认情况下,Capacitor 应用只允许从 caches 文件夹分享文件。要使其他 Android 文件夹可分享,必须将它们添加到 android/app/src/main/res/xml/file_paths.xml 文件中。请查阅 FileProvider 文档中的指定可用文件部分,了解可用的位置。

示例

import { Share } from '@capacitor/share';

await Share.share({
title: '看酷炫的东西',
text: '你现在就需要看到这个非常棒的东西',
url: 'http://ionicframework.com/',
dialogTitle: '与朋友分享',
});

每个平台使用不同的字段集,但您应该全部提供。

API

canShare()

canShare() => Promise<CanShareResult>

检查是否支持分享功能。

返回:

Promise<CanShareResult>

起始版本: 1.1.0


share(...)

share(options: ShareOptions) => Promise<ShareResult>

显示分享模态框以与其他应用分享内容。

参数类型
options
ShareOptions

返回:

Promise<ShareResult>

起始版本: 1.0.0


接口

CanShareResult

属性类型描述起始版本
valueboolean是否支持分享功能。1.1.0

ShareResult

属性类型描述起始版本
activityTypestring接收分享操作的应用的标识符。某些情况下可能为空字符串。在 web 上将为 undefined。1.0.0

ShareOptions

属性类型描述起始版本
titlestring为任何消息设置标题。如果分享到电子邮件,这将是主题。1.0.0
textstring设置要分享的一些文本。1.0.0
urlstring设置要分享的 URL,可以是 http、https 或 file:// URL。1.0.0
filesstring[]要分享的文件的 file:// URL 数组。仅支持 iOS 和 Android。4.1.0
dialogTitlestring设置分享模态框的标题。此选项仅在 Android 上受支持。1.0.0