开始使用

安装

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

获取本地Capacitor插件版本。

返回本地插件实现的当前版本。

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在上游发生变化时，请重新同步。