Démarrage

Copiez un prompt de configuration avec les étapes d'installation et la guide markdown complète pour ce 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.

Installation

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

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

Ensuite, utilisez la prompt 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 configuration manuelle, installez le plugin en exécutant les commandes suivantes et suivez les instructions spécifiques au plateforme ci-dessous :

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

Importer

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 peut être une chaîne base64 brute ou une URL de données comme data:application/pdf;base64,....

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

The implementations natives accept des chemins locaux, file:// URLs, Android content:// URIs, et Capacitor _capacitor_file_ 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 ultérieur, le plugin écrit à travers MediaStore. Sur Android 9 et en dessous, les sauvegardes publiques utilisent la permission du manifeste avec WRITE_EXTERNAL_STORAGE Partager Du Texte Avec Un Fichier maxSdkVersion=28.

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

text est transmis sous la forme de EXTRA_TEXT sur Android et sous la forme d'un 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 été fourni.
ERR_PARAM_DATA_INVALID - l'entrée base64 ne pouvait pas être décodée.
ERR_LOCAL_FILE_NOT_FOUND - le chemin local ou la URI de contenu fournis ne pouvait pas être ouvert.
ERR_FILE_CACHING_FAILED - le fichier temporaire natif ne pouvait pas être écrit.
ERR_FILE_SAVE_FAILED - l'Android n'a pas pu sauvegarder le fichier dans le stockage public.
ERR_ACTIVITY_NOT_FOUND - l'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.tsRe-faites la synchronisation lorsque les données publiques API changent en amont.

Continuez de l'étape de démarrage

Si vous utilisez Démarrage pour planifier le stockage et la gestion des fichiers, connectez-le avec Utilisez @capgo/capacitor-file-sharer pour la capacité native dans Utilisez @capgo/capacitor-file-sharer, @capgo/capacitor-data-storage-sqlite pour les détails d'implémentation dans @capgo/capacitor-data-storage-sqlite, En utilisant @capgo/capacitor-data-storage-sqlite pour la capacité native dans En utilisant @capgo/capacitor-data-storage-sqlite, @capgo/capacitor-file pour les détails d'implémentation dans @capgo/capacitor-file, et En utilisant @capgo/capacitor-file pour la capacité native dans En utilisant @capgo/capacitor-file.

Démarrage

Installation

Importer

Partager un fichier Base64

Partager un fichier local

Enregistrer Un Fichier

Partager du texte avec un fichier