はじめに

インストール

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

インポート

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 を再度同步してください。