@capgo/capacitor-file

Aperçu

Plugin de système de fichiers complet pour lire, écrire et gérer fichiers et répertoires

Commencez par requestFileSystem() et les autres méthodes principales listées ci-dessous.

Support des plateformes

Plateforme	Support	Notes
iOS	Oui	Natif
Android	Oui	Natif
Le Web	Oui	API de stockage du navigateur

Fonctionnalités clés

• requestFileSystem - Demander un système de fichiers.
• resolveLocalFileSystemURL - Résoudre une URL de fichier en entrée.
• getFile - Obtenir une entrée de fichier.
• getDirectory - Récupérer une entrée de répertoire.

API public

Méthode	Description
requestFileSystem	Demander un système de fichiers.
resolveLocalFileSystemURL	Résoudre une URL de fichier vers une entrée.
getFile	Récupérer une entrée de fichier.
getDirectory	Obtenir 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.
addListener	Écouter les événements de progression de lecture.
addListener	Écouter les événements de progression d'écriture.
removeAllListeners	Supprimer tous les écouteurs d'événements.
getPluginVersion	Récupérer la version du plugin.
checkPermissions	Vérifier l'état actuel des autorisations pour les opérations de fichiers. Sur Android, cela vérifie les autorisations de stockage externe. Sur iOS et le web, cela renvoie toujours « granted » car aucune autorisation spéciale n'est requise.
requestPermissions	Demander les autorisations pour les opérations de fichiers. Sur Android, cela demande les autorisations de stockage externe nécessaires pour accéder aux fichiers hors des répertoires privés de l'application. Sur iOS et le web, cela renvoie toujours « granted » car aucune autorisation spéciale n'est requise.

Valeurs de référence

Utilisez ces valeurs pour choisir un emplacement de stockage, écrire du texte encodé ou gérer les erreurs de fichier.

Répertoires

Valeur	L'utilisateur trouvera
DOCUMENTS	Documents persistants visibles par l’utilisateur. Sur Android, cela correspond au répertoire des fichiers de l’application.
DATA	Données privées persistantes de l’application.
LIBRARY	Persistent app data that is not user-visible. On Android this maps to the app files directory.
CACHE	Temporary cache data that the OS may clear.
EXTERNAL	Racine du stockage externe Android, comme une carte SD ou un stockage externe partagé.
EXTERNAL_STORAGE	Répertoire de données du stockage externe Android.
APPLICATION	Dossier de bundle d’application ou d’assets en lecture seule.

Encodages

Valeur	Utiliser
utf8	Texte UTF-8.
ascii	Texte ASCII.
utf16	Texte UTF-16.

Codes d'erreur de fichier

Valeur	Code	Signification
NOT_FOUND_ERR	1	Le fichier ou le répertoire n'a pas été trouvé.
SECURITY_ERR	2	Opération bloquée par les règles de sécurité ou les autorisations.
ABORT_ERR	3	L'opération a été annulée.
NOT_READABLE_ERR	4	Impossible de lire le fichier ou le répertoire.
ENCODING_ERR	5	L'encodage est invalide ou non pris en charge.
NO_MODIFICATION_ALLOWED_ERR	6	La cible ne peut pas être modifiée.
INVALID_STATE_ERR	7	L'objet est dans un état invalide pour l'opération.
SYNTAX_ERR	8	Le chemin ou la syntaxe d'entrée est invalide.
INVALID_MODIFICATION_ERR	9	La modification demandée est invalide pour la cible.
QUOTA_EXCEEDED_ERR	10	Le quota de stockage a été dépassé.
TYPE_MISMATCH_ERR	11	Le type de valeur ne correspond pas au type attendu.
PATH_EXISTS_ERR	12	Le chemin cible existe déjà.

Source de vérité

Cette référence est synchronisée depuis src/definitions.ts dans capacitor-file.

Continuer depuis @capgo/capacitor-file

Si vous utilisez @capgo/capacitor-file pour planifier le stockage et la gestion des fichiers, connectez-l’à Utiliser @capgo/capacitor-file pour la fonctionnalité native de « Utiliser @capgo/capacitor-file », @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 Utiliser @capgo/capacitor-data-storage-sqlite @capgo/capacitor-uploader pour les détails d'implémentation dans @capgo/capacitor-uploader, et Utiliser @capgo/capacitor-uploader pour la fonctionnalité native dans « Utiliser @capgo/capacitor-uploader. »