Getting Started

Instalar

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

Importar

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

API Resumen

addListener

Escuchar evento shareReceived.

Registra un oyente que se llamará cuando el contenido se comparta en la aplicación desde otra aplicación. El callback recibe datos de evento que contienen título, textos y archivos.

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

Eliminar todos los oyentes para este plugin.

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

await CapacitorShareTarget.removeAllListeners();

getPluginVersion

Obtenga la versión nativa del plugin Capacitor.

Devuelve la versión actual de la implementación del plugin nativo.

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

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

Referencia de tipos

ShareReceivedEvent

Datos de evento recibidos cuando el contenido se comparte con la aplicación.

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

Representa un archivo compartido con la aplicación.

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

Fuente de Verdad

Esta página se genera desde el plugin’s src/definitions.ts. Vuelva a ejecutar la sincronización cuando los cambios públicos API cambien en la fuente.

Siga adelante desde Getting Started

Si está utilizando Getting Started para planificar la consola y las operaciones de API, conecte con Usando @capgo/capacitor-share-target para la capacidad nativa en Usando @capgo/capacitor-share-target, Resumen de API para el detalle de implementación en API Resumen, Introducción para el detalle de implementación en Introducción, API Claves para el detalle de implementación en API Claves, y Dispositivos para el detalle de implementación en Dispositivos.