Getting Started

インストール

AI-Assisted セットアップを使用してプラグインをインストールできます。AI ツールに Capgo スキルを追加するには、以下のコマンドを実行してください。

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-share-target` plugin in my project.

Manual Setupを使用する場合は、以下のコマンドを実行してください。プラットフォーム固有の指示は下記を参照してください。

bun add @capgo/capacitor-share-target
bunx cap sync

Import

import { CapacitorShareTarget } from '@capgo/capacitor-share-target';

APIの概要

addListener

イベントリスナーを設定してください。

他のアプリからアプリにコンテンツを共有したときに呼び出されるリスナーを登録します。このコールバックでは、タイトル、テキスト、ファイルを含むイベントデータを受け取ります。

import { CapacitorShareTarget } from '@capgo/capacitor-share-target';

const listener = await CapacitorShareTarget.addListener('shareReceived', (event) => {
  console.log('Title:', event.title);
  console.log('Texts:', event.texts);
  event.files?.forEach(file => {
    console.log(`File: ${file.name} (${file.mimeType})`);
  });
});

// To remove the listener:
await listener.remove();

removeAllListeners

このプラグインのすべてのリスナーを削除します。

import { CapacitorShareTarget } from '@capgo/capacitor-share-target';

await CapacitorShareTarget.removeAllListeners();

getPluginVersion

Get the native Capacitor plugin version.

ネイティブプラグイン実装の現在のバージョンを返します。

import { CapacitorShareTarget } from '@capgo/capacitor-share-target';

const { version} = await CapacitorShareTarget.getPluginVersion();
console.log('Plugin version:', version);

型リファレンス

ShareReceivedEvent

コンテンツがアプリケーションに共有されたときに受信されるイベントデータ。

export interface ShareReceivedEvent {
  /**
   * The title of the shared content.
   *
   * @since 0.1.0
   */
  title: string;

  /**
   * Array of text content shared to the application.
   *
   * @since 0.1.0
   */
  texts: string[];

  /**
   * Array of files shared to the application.
   *
   * @since 0.2.0
   */
  files: SharedFile[];
}

SharedFile

アプリケーションに共有されたファイルを表します。

export interface SharedFile {
  /**
   * The URI of the shared file. On Android/iOS this will be a file path or data URL.
   * On web this will be a cached URL accessible via fetch.
   *
   * @since 0.1.0
   */
  uri: string;

  /**
   * The name of the shared file, with or without extension.
   *
   * @since 0.1.0
   */
  name: string;

  /**
   * The MIME type of the shared file.
   *
   * @since 0.1.0
   */
  mimeType: string;
}

ソース・オブ・トゥルース

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

続けてGetting Started

Capgoを使用している場合 Getting Started ダッシュボードとAPIの作業を計画するには、APIに接続してください Using @capgo/capacitor-share-target for the native capability in Using @capgo/capacitor-share-target, CapgoのAPI-share-targetの実装詳細について CapgoのAPI-share-targetの実装詳細について Capgoの__CAPGO_KEEP_0__-share-targetのキーについて Capgoの__CAPGO_KEEP_0__-share-targetの実装詳細について、そして API Keys for the implementation detail in API Keys, and Getting Started デバイスの実装詳細について。