Démarrage

Installer

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 être une chaîne base64 brute ou 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:// URLs, Android content:// URIs, et Capacitor _capacitor_file_ URLs.

Sauvegarder 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. Sur Android 10 et versions ultérieures, le plugin écrit à travers MediaStore. Sur Android 9 et versions antérieures, les sauvegardes publiques utilisent le manifeste. documentsCopy to clipboard 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 transmis sous la forme EXTRA_TEXT sur Android et sous la forme d'un deuxième élément d'activité sur iOS.

Référence de type

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 fourni ou la 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 sauvegarder le fichier dans le stockage public.
• ERR_ACTIVITY_NOT_FOUND - L'Android ne peut pas ouvrir une cible de partage.
• USER_CANCELLED - Le feuillet de partage iOS a été fermé sans être terminé.

Source Of Truth

Cette page suit les plugins’ src/definitions.ts. Re-run la synchronisation lorsque le public API change en amont.

Continuez de Getting Started

Si vous utilisez Getting Started pour planifier le stockage et la gestion de fichiers, connectez-le avec Utiliser @capgo/capacitor-file-sharer pour la capacité native dans l'utilisation de @capgo/capacitor-file-sharer, @capgo/capacitor-data-storage-sqlite pour le détail d'implémentation dans @capgo/capacitor-data-storage-sqlite, En utilisant @capgo/capacitor-data-storage-sqlite pour la capacité native dans l'utilisation de @capgo/capacitor-data-storage-sqlite, @capgo/capacitor-file pour le détail d'implémentation dans @capgo/capacitor-file, et En utilisant @capgo/capacitor-file pour la capacité native dans l'utilisation de @capgo/capacitor-file.