Getting Started

Instala

Puedes utilizar nuestra configuración asistida por IA para instalar el plugin. Agrega las Capgo habilidades a tu herramienta de IA utilizando el siguiente comando:

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

Luego utiliza el siguiente prompt:

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

Si prefieres la configuración manual, instala el complemento ejecutando los siguientes comandos y sigue las instrucciones específicas de la plataforma a continuación:

bun add @capgo/capacitor-file-sharer
bunx cap sync

Importar

import { FileSharer } from '@capgo/capacitor-file-sharer';

Compartir Un Archivo Base64

import { FileSharer } from '@capgo/capacitor-file-sharer';

await FileSharer.share({
  filename: 'report.pdf',
  contentType: 'application/pdf',
  base64Data: reportBase64,
  title: 'Quarterly report',
  text: 'Attached report',
});

base64Data puede ser una cadena base64 cruda o una URL de datos como data:application/pdf;base64,....

Compartir Un Archivo Local

await FileSharer.share({
  filename: 'export.zip',
  contentType: 'application/zip',
  path: fileUri,
});

Las implementaciones nativas aceptan rutas locales, file:// URLs, Android content:// URIs, y Capacitor _capacitor_file_ URLs.

Guardar Un Archivo

const result = await FileSharer.save({
  filename: 'backup.zip',
  contentType: 'application/zip',
  base64Data: zipBase64,
  android: {
    saveDirectory: 'downloads',
    relativePath: 'Download/My App',
  },
});

console.log(result.uri);

Los directorios de guardado de Android son downloads, pictures, movies, music, y documentsEn Android 10 y posteriores, el plugin escribe a través de MediaStore. En Android 9 y anteriores, los guardados públicos utilizan el manifiesto. WRITE_EXTERNAL_STORAGE permiso con maxSdkVersion=28.

Compartir Texto Con Un Archivo

await FileSharer.share({
  filename: 'photo.jpg',
  contentType: 'image/jpeg',
  path: photoUri,
  title: 'Site photo',
  subject: 'Photo export',
  text: 'Captured during inspection.',
});

text se pasa como EXTRA_TEXT en Android y como un segundo elemento de actividad en iOS.

Tipo de Referencia

ShareFileOptions

export interface ShareFileOptions {
  filename: string;
  base64Data?: string;
  path?: string;
  contentType?: string;
  text?: string;
  title?: string;
  subject?: string;
  android?: AndroidFileSharerOptions;
}

AndroidFileSharerOptions

export interface AndroidFileSharerOptions {
  chooserTitle?: string;
  saveDirectory?: 'downloads' | 'pictures' | 'movies' | 'music' | 'documents';
  relativePath?: string;
}

SaveFileResult

export interface SaveFileResult {
  uri?: string;
}

Códigos de error

• ERR_PARAM_NO_FILENAME - filename no está presente o está en blanco.
• ERR_PARAM_NO_DATA ni base64Data ni path se proporcionó.
• ERR_PARAM_DATA_INVALID - no se pudo descodificar la entrada base64.
• ERR_LOCAL_FILE_NOT_FOUND - no se pudo abrir el camino local o la URI de contenido proporcionados.
• ERR_FILE_CACHING_FAILED - no se pudo escribir el archivo temporal nativo.
• ERR_FILE_SAVE_FAILED - Android no pudo guardar el archivo en almacenamiento público.
• ERR_ACTIVITY_NOT_FOUND - Android no pudo abrir un objetivo de compartir.
• USER_CANCELLED La hoja de compartir de iOS se despidió sin completar.

Fuente de Verdad

Esta página sigue el estado del plugin’s src/definitions.tsRe-ejecuta la sincronización cuando el API público cambie en línea.

Sigue adelante desde Inicio

Si estás utilizando Getting Started para planificar el almacenamiento y el manejo de archivos, conecta Usando @capgo/capacitor-file-sharer para la capacidad nativa en Usando @capgo/capacitor-file-sharer, @capgo/capacitor-almacenamiento-de-datos-sqlite para el detalle de implementación en @capgo/capacitor-data-storage-sqlite, Usando @capgo/capacitor-data-storage-sqlite para la capacidad nativa en Usando @capgo/capacitor-data-storage-sqlite, @capgo/capacitor-archivo para el detalle de implementación en @capgo/capacitor-file, y Usando @capgo/capacitor-archivo para la capacidad nativa en Usando @capgo/capacitor-archivo.