Einstieg

Installieren

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

Importieren

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

API Übersicht

addListener

Hören Sie auf den Ereignis shareReceived.

Registriert einen Listener, der aufgerufen wird, wenn Inhalte an die Anwendung von einer anderen App geteilt werden. Der Callback erhält Ereignisdaten, die Titel, Texte und Dateien enthalten.

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

Entfernen Sie alle Listener für dieses Plugin.

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

await CapacitorShareTarget.removeAllListeners();

getPluginVersion

Ermitteln Sie die native Capacitor-Pluginversion.

Gibt die aktuelle Version der native Pluginimplementierung zurück.

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

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

Typenverweis

ShareReceivedEvent

Daten des Ereignisses erhalten, wenn Inhalte auf die Anwendung geteilt werden.

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

Stellt ein Datei dar, die der Anwendung geteilt wurde.

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

Quelle der Wahrheit

Diese Seite wird aus dem Plugin generiert. src/definitions.tsRe-run die Synchronisation, wenn die öffentliche API upstream geändert wird.