Démarrage

Prêt à coller

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

Importer

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

API Vue d'ensemble

addListener

Écouter 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 les données de l'é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

Supprimer tous les écouteurs pour ce plugin.

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

await CapacitorShareTarget.removeAllListeners();

getPluginVersion

Obtenir la version native du plugin Capacitor.

Renvoie 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);

Référence de type

ShareReceivedEvent

Données d'événement reçues lors de la partage de 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é à 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.tsRexécuter à nouveau la synchronisation lorsque le public API change en amont.

Continuer depuis Getting Started

Si vous utilisez Getting Started pour planifier le tableau de bord et les API opérations, connectez-le avec En utilisant @capgo/capacitor-cible-de-partage-native pour la capacité native dans En utilisant @capgo/capacitor-cible-de-partage-native API Vue d'ensemble pour le détail d'implémentation dans API Vue d'ensemble Introduction pour le détail d'implémentation dans Introduction API Clés pour le détail d'implémentation dans API Clés, et Appareils pour le détail d'implémentation dans Appareils.