Étape De Début

Installation

Vous pouvez utiliser notre configuration assistée par l'IA pour installer le plugin. Ajoutez les Capgo compétences à votre outil IA à l'aide de la commande suivante :

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

Utilisez ensuite la commande suivante :

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

Si vous préférez la mise en place manuelle, installez le plugin en exécutant les commandes suivantes et suivez les instructions spécifiques à la plateforme ci-dessous :

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

Importer

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

Partager un fichier 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 peut s'agir d'une chaîne de base64 brute ou d'une URL de données comme data:application/pdf;base64,....

Partager un fichier local

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

Les implémentations natives acceptent des chemins locaux, file:// des URLs, des Android content:// des URIs, et Capacitor _capacitor_file_ des URLs.

Enregistrer un fichier

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

console.log(result.uri);

Les répertoires de sauvegarde Android sont downloads, pictures, movies, music et documents. Sur Android 10 et versions ultérieures, le plugin écrit à travers MediaStore. Sur Android 9 et versions antérieures, les sauvegardes publiques utilisent la déclaration de WRITE_EXTERNAL_STORAGE permission avec maxSdkVersion=28.

Partager du texte avec un fichier

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

text est passé en EXTRA_TEXT sur Android et comme deuxième élément d'activité sur iOS.

Type de référence

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

Codes d'erreur

• ERR_PARAM_NO_FILENAME - filename est manquant ou vide.
• ERR_PARAM_NO_DATA ni base64Data ni path n'a pas été fourni.
• ERR_PARAM_DATA_INVALID l'entrée base64 n'a pas pu être décodée.
• ERR_LOCAL_FILE_NOT_FOUND - le chemin local fourni ou l'URI de contenu ne pouvait pas être ouvert.
• ERR_FILE_CACHING_FAILED - le fichier temporaire natif ne pouvait pas être écrit.
• ERR_FILE_SAVE_FAILED - Android n'a pas pu enregistrer le fichier dans le stockage public.
• ERR_ACTIVITY_NOT_FOUND - Android n'a pas pu ouvrir une cible de partage.
• USER_CANCELLED - la feuille de partage iOS a été fermée sans être terminée.

Source Of Truth

Cette page suit les plugins’ src/definitions.ts. Re-run the sync when the public API changes upstream.

Continuez de Getting Started

Si vous utilisez Démarrage pour planifier le stockage et la gestion des fichiers, connectez-le à En utilisant @capgo/capacitor-partageur-de-fichiers pour la capacité native dans En utilisant @capgo/capacitor-partageur-de-fichiers, @capgo/capacitor-stockage-de-données-sqlite pour le détail d'implémentation dans @capgo/capacitor-stockage-de-données-sqlite, En utilisant @capgo/capacitor-stockage-de-données-sqlite pour la capacité native dans En utilisant @capgo/capacitor-stockage-de-données-sqlite, @capgo/capacitor-fichier pour le détail d'implémentation dans @capgo/capacitor-fichier, et En utilisant @capgo/capacitor-fichier pour la capacité native dans En utilisant @capgo/capacitor-fichier.