Getting Started

安装

您可以使用我们的 AI 助手来安装插件。使用以下命令将 Capgo 技能添加到您的 AI 工具中：

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.

如果您更喜欢手动设置，请运行以下命令安装插件，并按照以下平台特定的说明进行操作：

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 上游更改时，请重新运行同步。

继续从开始

如果您正在使用 开始 来规划仪表板和 API 操作，请将其连接 使用 @capgo/capacitor-share-target 使用 @capgo/capacitor-share-target API 简介 查看 API 简介 介绍 查看 介绍 API 密钥 查看 API 密钥 设备 查看 设备