Getting Started

Installazione

Puoi utilizzare la nostra configurazione assistita dall'IA per installare il plugin. Aggiungi le Capgo competenze al tuo strumento di AI utilizzando il seguente comando:

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

Poi utilizza il seguente prompt:

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

Se preferisci la configurazione manuale, installa il plugin eseguendo i seguenti comandi e segui le istruzioni specifiche del tuo sistema di sotto:

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

Importa

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

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

Condividi un File Locale

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 percorsi di salvataggio Android sono downloads, pictures, movies, music, e documentsSu Android 10 e versioni successive, il plugin scrive tramite MediaStore. Su Android 9 e versioni precedenti, le salvataggi pubblici utilizzano il manifesto. WRITE_EXTERNAL_STORAGE permesso di condivisione con maxSdkVersion=28.

Condividi il testo con un file

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 di 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 È stato fornito.
• ERR_PARAM_DATA_INVALID - l'input base64 non è stato decodificato.
• ERR_LOCAL_FILE_NOT_FOUND - il file temporaneo nativo non poteva essere scritto.
• ERR_FILE_CACHING_FAILED - Android non riusciva a salvare il file nella memoria pubblica.
• ERR_FILE_SAVE_FAILED - Android non riusciva ad aprire un bersaglio di condivisione.
• ERR_ACTIVITY_NOT_FOUND - Android could not open a share target.
• USER_CANCELLED La condivisione non è stata completata.

Fonte Di Verità

Questa pagina traccia le informazioni del plugin src/definitions.ts. Re-run the sync when the public API changes upstream.

Continua da Getting Started

Se stai utilizzando Getting Started per pianificare lo storage e il trattamento dei file, connettilo con Utilizzando @capgo/capacitor-file-sharer per la capacità nativa in Utilizzando @capgo/capacitor-file-sharer, @capgo/capacitor-archiviazione-dati-sqlite per i dettagli di implementazione in @capgo/capacitor-data-storage-sqlite, Utilizzando @capgo/capacitor-data-storage-sqlite per la capacità nativa in Utilizzando @capgo/capacitor-data-storage-sqlite, @capgo/capacitor-file per i dettagli di implementazione in @capgo/capacitor-file, e Utilizzando @capgo/capacitor-file per la capacità nativa in Utilizzando @capgo/capacitor-file.