Guide
Comment utiliser File dans Capacitor
Utiliser @capgo/capacitor-file
Le plugin Capacitor File implémente des opérations de système de fichiers similaires au plugin Cordova File.
Installer
bun add @capgo/capacitor-file
bunx cap sync
bunx cap sync copie le code natif du plugin dans vos projets natifs. Relancez-l’après chaque mise à jour du plugin.
Importer
import { CapacitorFile } from '@capgo/capacitor-file';
Aperçu de API
| Méthode | Description |
|---|---|
requestFileSystem |
Accéder au système de fichiers. |
resolveLocalFileSystemURL |
Résoudre une URL de fichier en une entrée. |
getFile |
Récupérer une entrée de fichier. |
getDirectory |
Récupérer une entrée de répertoire. |
readFile |
Lire un fichier en texte ou en base64. |
readAsDataURL |
Lire un fichier sous forme de data URL (base64 avec préfixe MIME). |
writeFile |
Écrire des données dans un fichier. |
appendFile |
Ajouter des données à un fichier. |
deleteFile |
Supprimer un fichier. |
mkdir |
Créer un répertoire. |
rmdir |
Supprimer un répertoire. |
readdir |
Lire le contenu d'un répertoire. |
stat |
Récupérer les métadonnées d'un fichier ou d'un répertoire. |
getMetadata |
Récupérer les métadonnées d'un fichier ou d'un répertoire. Alias de stat(). |
rename |
Renommer ou déplacer un fichier ou un répertoire. |
move |
Déplacer un fichier ou un répertoire. Alias de rename(). |
copy |
Copier un fichier ou un répertoire. |
exists |
Vérifier si un fichier ou un répertoire existe. |
getUri |
Récupérer l'URI d'un fichier. |
truncate |
Tronquer un fichier à une taille spécifiée. |
getDirectories |
Get all known file system directories. |
getFreeDiskSpace |
Obtenir l'espace disque libre en octets. |
checkPermissions |
Vérifier l'état actuel des permissions pour les opérations de fichiers. Sur Android, cela vérifie les permissions de stockage externe. Sur iOS et le web, cela retourne toujours 'granted' car aucune permission spéciale n'est requise. |
requestPermissions |
Demander les permissions pour les opérations de fichiers. Sur Android, cela demande les permissions de stockage externe nécessaires pour accéder aux fichiers hors des répertoires privés de l'app. Sur iOS et le web, cela retourne toujours 'granted' car aucune permission spéciale n'est requise. |
Exemples
requestFileSystem()
Demander un système de fichiers.
import { CapacitorFile, FileSystemType } from '@capgo/capacitor-file';
const result = await CapacitorFile.requestFileSystem({ type: FileSystemType.TEMPORARY });
console.log(result);
resolveLocalFileSystemURL()
Résoudre une URL de fichier en une entrée.
import { CapacitorFile } from '@capgo/capacitor-file';
const result = await CapacitorFile.resolveLocalFileSystemURL({ url: 'https://example.com' });
console.log(result);
getFile()
Obtenir une entrée de fichier.
import { CapacitorFile } from '@capgo/capacitor-file';
const result = await CapacitorFile.getFile({ path: 'path/to/file' });
console.log(result);
getDirectory()
Obtenir une entrée de répertoire.
import { CapacitorFile } from '@capgo/capacitor-file';
const result = await CapacitorFile.getDirectory({ path: 'path/to/file' });
console.log(result);
readFile()
Lire un fichier en texte ou en base64.
import { CapacitorFile } from '@capgo/capacitor-file';
const result = await CapacitorFile.readFile({ path: 'path/to/file' });
console.log(result);
readAsDataURL()
Lire un fichier sous forme de data URL (base64 avec préfixe MIME).
import { CapacitorFile } from '@capgo/capacitor-file';
const result = await CapacitorFile.readAsDataURL({ path: 'path/to/file' });
console.log(result);
Le tableau ci-dessus liste les 24 méthodes principales. Les helpers de version et de listener, ainsi que le contrat complet de chaque méthode, sont documentés dans la dépôt GitHub.
Écouter les événements
addListener renvoie un handle. Appelez handle.remove() lors du démontage de l'écran, ou CapacitorFile.removeAllListeners() pour supprimer tous les listeners.
Référence complète
Continuez avec l'utilisation de @capgo/capacitor-file
Si vous utilisez Utiliser @capgo/capacitor-file pour planifier le stockage et la gestion de fichiers, connectez-l’à @capgo/capacitor-file pour les détails d'implémentation dans @capgo/capacitor-file, Prise en main pour les détails d'implémentation dans Getting Started @capgo/capacitor-data-storage-sqlite pour les détails d'implémentation dans @capgo/capacitor-data-storage-sqlite, Utiliser @capgo/capacitor-data-storage-sqlite pour la capacité native dans l'utilisation de @capgo/capacitor-data-storage-sqlite, et @capgo/capacitor-uploader pour les détails d'implémentation dans @capgo/capacitor-uploader.