@capacitor/share

Share API は、ユーザーがインストールしている共有対応アプリでコンテンツを共有するためのメソッドを提供します。

Share API は、iOS、Android、および Web (新しい Web Share API を使用) で動作しますが、Web サポートは現在まだ不安定です。

インストール

npm install @capacitor/share
npx cap sync

Android

デフォルトでは、Capacitor アプリはキャッシュフォルダからのファイルの共有のみを許可しています。他の Android フォルダを共有可能にするには、それらを android/app/src/main/res/xml/file_paths.xml ファイルに追加する必要があります。利用可能な場所については、FileProvider ドキュメントの「Specifying Available Files」セクションを確認してください。

例

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

await Share.share({
  title: 'See cool stuff',
  text: 'Really awesome thing you need to see right meow',
  url: 'https://ionic.dokyumento.jp/',
  dialogTitle: 'Share with buddies',
});

// Share text only
await Share.share({
  text: 'Really awesome thing you need to see right meow',
});

// Share url only
await Share.share({
  url: 'https://ionic.dokyumento.jp/',
});

// Share local file using url parameter
const photo = await Camera.getPhoto(options);
await Share.share({
  url: photo.path,
});

// Share multiple files using files parameter
const { photos } = await Camera.pickImages(options);
await Share.share({
  files: photos.map(photo => photo.path!),
});

各プラットフォームは異なるフィールドセットを使用しますが、すべて提供する必要があります。

API

• canShare()
• share(...)
• インターフェース

canShare()

canShare() => Promise<CanShareResult>

共有がサポートされているかどうかを確認します。

戻り値: Promise<CanShareResult>

導入 1.1.0

---

share(...)

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

他のアプリとコンテンツを共有するための共有モーダルを表示します。

引数	型
options	ShareOptions

戻り値: Promise<ShareResult>

導入 1.0.0

---

インターフェース

CanShareResult

プロパティ	型	説明	導入
value	boolean	共有がサポートされているかどうか。	1.1.0

ShareResult

プロパティ	型	説明	導入
activityType	string	共有アクションを受信したアプリの識別子。場合によっては空の文字列になることがあります。Web では undefined になります。	1.0.0

ShareOptions

プロパティ	型	説明	導入
title	string	メッセージのタイトルを設定します。メールで共有する場合は件名になります。	1.0.0
text	string	共有するテキストを設定します。	1.0.0
url	string	共有する URL を設定します。http、https、または file:// URL を指定できます。	1.0.0
files	string[]	共有するファイルの file:// URL の配列。iOS と Android でのみサポートされています。	4.1.0
dialogTitle	string	共有モーダルのタイトルを設定します。このオプションは Android でのみサポートされています。	1.0.0