Inicio

Instalar

Puede utilizar nuestra configuración asistida por IA para instalar el plugin. Agregue las Capgo habilidades a su herramienta de IA utilizando el siguiente comando:

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

Luego utilice la siguiente solicitud:

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

Si prefiere la configuración manual, instale el plugin ejecutando los siguientes comandos y siguiendo 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:// direcciones URL, Android content:// direcciones URI, y Capacitor _capacitor_file_ direcciones URL.

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 almacenamiento de Android son downloads, pictures, movies, music, y documents. En Android 10 y posteriores, el plugin escribe a través de MediaStore. En Android 9 y debajo, los guardados públicos utilizan la manifestación 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 está vacío o en blanco.
• ERR_PARAM_NO_DATA - ni base64Data ni path fue proporcionado.
• ERR_PARAM_DATA_INVALID - no se pudo descodificar la entrada base64.
• ERR_LOCAL_FILE_NOT_FOUND - No se pudo abrir la ruta o URI local proporcionada.
• ERR_FILE_CACHING_FAILED - No se pudo escribir el archivo temporal nativo.
• ERR_FILE_SAVE_FAILED - No se pudo guardar el archivo en almacenamiento público en Android.
• ERR_ACTIVITY_NOT_FOUND - No se pudo abrir un objetivo de compartir en Android.
• USER_CANCELLED - El cuadro de diálogo de compartir de iOS se cerró sin completar.

Fuente de Verdad

Esta página sigue el estado del plugin. src/definitions.ts. Re-ejecuta la sincronización cuando los cambios públicos API cambien en la fuente.

Sigue adelante desde Inicio

Si estás utilizando Iniciación para planificar el almacenamiento y el manejo de archivos, conectarlo con Usando @capgo/capacitor-compartir-archivos para la capacidad nativa en Usando @capgo/capacitor-compartir-archivos, @capgo/capacitor-almacenamiento-de-datos-sqlite para el detalle de implementación en @capgo/capacitor-almacenamiento-de-datos-sqlite, Usando @capgo/capacitor-almacenamiento-de-datos-sqlite para la capacidad nativa en Usando @capgo/capacitor-almacenamiento-de-datos-sqlite, @capgo/capacitor-archivo para el detalle de implementación en @capgo/capacitor-archivo, y Usando @capgo/capacitor-archivo para la capacidad nativa en Usando @capgo/capacitor-archivo.