Iniziato

Copia un prompt di configurazione con i passaggi di installazione e la guida markdown completa per questo plugin.

        Set up this Capacitor plugin in the project.

Use the package manager already used by the project.
Install these package(s): `@capgo/capacitor-file-sharer`
Run the required Capacitor sync/update step after installation.
Read this markdown guide for the full setup steps: https://raw.githubusercontent.com/Cap-go/website/refs/heads/main/apps/docs/src/content/docs/docs/plugins/file-sharer/getting-started.mdx
Use that guide for platform-specific steps, native file edits, permissions, config changes, imports, and usage setup.
If that guide references other docs pages, read them too.

Sezione intitolata “Installa”

You can use our AI-Assisted Setup to install the plugin. Add the Capgo skills to your AI tool using the following command:

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

Usa poi la seguente richiesta:

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

Se preferisci l'installazione manuale, installa il plugin eseguendo i seguenti comandi e segui le istruzioni specifiche per la piattaforma riportate di seguito:

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

Importa

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

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 può essere una stringa base64 cruda o una URL di dati come data:application/pdf;base64,....

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

Le implementazioni native accettano percorsi locali, file:// URL, Android content:// URI, e Capacitor _capacitor_file_ URL.

Salva un file

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

console.log(result.uri);

I directory di salvataggio Android sono downloads, pictures, movies, musice documents. Su Android 10 e versioni successive, il plugin scrive tramite MediaStore. Su Android 9 e versioni precedenti, i salvataggi pubblici utilizzano la manifestazione WRITE_EXTERNAL_STORAGE con maxSdkVersion=28.

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

text viene passato come EXTRA_TEXT su Android e come secondo elemento di attività su iOS.

Riferimento al tipo

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

Codici di Errore

ERR_PARAM_NO_FILENAME - filename è mancante o vuoto.
ERR_PARAM_NO_DATA - né base64Data né path non è stato fornito.
ERR_PARAM_DATA_INVALID - l'input base64 non è stato decodificato.
ERR_LOCAL_FILE_NOT_FOUND - non è stato possibile aprire il percorso o l'URI locale fornito.
ERR_FILE_CACHING_FAILED - non è stato possibile scrivere il file temporaneo nativo.
ERR_FILE_SAVE_FAILED - Android non è stato in grado di salvare il file nella memoria pubblica.
ERR_ACTIVITY_NOT_FOUND - Android non è stato in grado di aprire un obiettivo di condivisione.
USER_CANCELLED - la scheda di condivisione di iOS è stata chiusa senza completare.

Fonte di Verità

Questa pagina traccia le informazioni del plugin. src/definitions.tsRiepiloga la sincronizzazione quando le informazioni pubbliche API cambiano in modo upstream.

Continua da Iniziare

Se stai utilizzando Inizia con la guida per pianificare lo storage e il trattamento dei file, connettilo con Utilizza @capgo/capacitor-file-condivisore per la capacità nativa in Utilizza @capgo/capacitor-file-condivisore, @capgo/capacitor-storage-dati-sqlite per la dettaglio di implementazione in @capgo/capacitor-storage-dati-sqlite, Utilizza @capgo/capacitor-storage-dati-sqlite per la capacità nativa in Utilizza @capgo/capacitor-storage-dati-sqlite, @capgo/capacitor-file per il dettaglio di implementazione in @capgo/capacitor-file, e Utilizza @capgo/capacitor-file per la capacità nativa in Utilizza @capgo/capacitor-file.

Iniziato

Sezione intitolata “Installa”

Importa

Condividi un file Base64

Condividi un file locale

Salva un file

Condividi testo con un file