Getting Started

Installation

Vous pouvez utiliser notre configuration assistée par l'IA pour installer le plugin. Ajoutez les Capgo compétences à votre outil IA à l'aide de la commande suivante :

npx skills add https://github.com/Cap-go/capgo-skills --skill capacitor-plugins

Ensuite, utilisez la prompt suivante :

Use the `capacitor-plugins` skill from `Cap-go/capgo-skills` to install the `@capgo/capacitor-share-target` plugin in my project.

Si vous préférez la configuration manuelle, installez le plugin en exécutant les commandes suivantes et suivez les instructions spécifiques au plateforme ci-dessous :

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

Importer

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

API Vue d'ensemble

addListener

Écoutez l'événement shareReceived.

Enregistre un écouteur qui sera appelé lorsque du contenu sera partagé vers l'application à partir d'une autre application. Le callback reçoit des données d'événement contenant le titre, les textes et les fichiers.

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

Supprimez tous les écouteurs pour ce plugin.

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

await CapacitorShareTarget.removeAllListeners();

getPluginVersion

Obtenez la version native du plugin Capacitor.

Retourne la version actuelle de la mise en œuvre native du plugin.

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

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

Type de référence

ShareReceivedEvent

Les données de l'événement reçues lors de la partage du contenu vers l'application.

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

Représente un fichier partagé vers l'application.

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;
}

Source De Vérité

Cette page est générée à partir du plugin’s src/definitions.tsRe-run the synchronisation lorsque le public API change en amont.

Continuez de la section « Getting Started »

Si vous utilisez Getting Started pour planifier le tableau de bord et les opérations API, connectez-l’avec Utilisez @capgo/capacitor-share-target pour la capacité native dans Utilisez @capgo/capacitor-share-target, Vue d'ensemble API pour les détails d'implémentation dans Vue d'ensemble API, Introduction pour les détails d'implémentation dans Introduction, API Clés pour les détails d'implémentation dans API Clés, et Appareils pour les détails d'implémentation dans Appareils.