@capgo/capacitor-fichier

Le plugin Capacitor implémente les opérations de système de fichiers similaires au plugin Cordova File.

Aperçu

Capacitor Implémente les opérations de système de fichiers similaires au plugin Cordova File.

Capacités de base

requestFileSystem - Demande un système de fichiers.
resolveLocalFileSystemURL - Résolvez une URL de fichier en entrée.
getFile - Obtenir une entrée de fichier.
getDirectory - Obtenir une entrée de répertoire.

Public API

Méthode	Description
`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`	Obtenir une entrée de répertoire.
`readFile`	Lire un fichier en texte ou en base64.
`readAsDataURL`	Lire un fichier sous forme de URL de données (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`	Lister les contenus d'un répertoire.
`stat`	Obtenir des métadonnées sur un fichier ou un répertoire.
`getMetadata`	Obtenir des métadonnées sur un fichier ou un répertoire. Alias pour stat().
`rename`	Renommer ou déplacer un fichier ou un répertoire.
`move`	Déplacer un fichier ou un répertoire. Alias pour rename().
`copy`	Copier un fichier ou un répertoire.
`exists`	Vérifier si un fichier ou un répertoire existe.
`getUri`	Obtenez l'URI d'un fichier.
`truncate`	Tronquez un fichier jusqu'à une taille spécifiée.
`getDirectories`	Obtenez tous les répertoires de système de fichiers connus.
`getFreeDiskSpace`	Obtenez l'espace disque libre en octets.
`addListener`	Écoutez les événements de progression de lecture.
`addListener`	Écoutez les événements de progression d'écriture.
`removeAllListeners`	Supprimez tous les écouteurs d'événements.
`getPluginVersion`	Obtenez la version du plugin.
`checkPermissions`	Vérifiez l'état de permission actuel pour les opérations de fichiers. Sur Android, cela vérifie les permissions d'accès aux fichiers externes. Sur iOS et web, cela retourne toujours ‘accordé’ car aucune permission spéciale n'est nécessaire.
`requestPermissions`	Demandez les permissions pour les opérations de fichiers. Sur Android, cela demande les permissions d'accès aux fichiers externes nécessaires pour accéder aux fichiers en dehors des répertoires privés de l'application. Sur iOS et web, cela retourne toujours ‘accordé’ car aucune permission spéciale n'est nécessaire.

Valeurs de référence

Utilisez ces valeurs lors du choix d'un emplacement de stockage, de l'écriture de texte codé ou de la gestion d'erreurs de fichiers.

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 d'application privées persistantes.
`LIBRARY`	Données d'application persistantes qui ne sont pas visibles par l'utilisateur. Sur Android, cela correspond au répertoire des fichiers de l'application.
`CACHE`	Données de cache temporaires que le système peut effacer.
`EXTERNAL`	Emplacement de stockage externe Android, tel qu'une carte SD ou un stockage externe partagé.
`EXTERNAL_STORAGE`	Répertoire de données de stockage externe Android.
`APPLICATION`	Répertoire du bundle d'application ou des ressources non modifiables.

Encodages

Valeur	Utilisation
`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`	L'opération a été bloquée par les règles de sécurité ou les permissions.
`ABORT_ERR`	`3`	L'opération a été annulée.
`NOT_READABLE_ERR`	`4`	Le fichier ou le répertoire ne peut pas être lu.
`ENCODING_ERR`	`5`	Le codage 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 non valide pour l'opération.
`SYNTAX_ERR`	`8`	La voie 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`	La limite de stockage a été dépassée.
`TYPE_MISMATCH_ERR`	`11`	Le type de valeur ne correspond pas au type attendu.
`PATH_EXISTS_ERR`	`12`	La cible du chemin existe déjà.

Source Of Truth

Cette référence est synchronisée à partir de src/definitions.ts en capacitor-fichier.

Continuez de @capgo/capacitor-fichier

Si vous utilisez @capgo/capacitor-fichier pour planifier le stockage et la gestion des fichiers, connectez-le avec En utilisant @capgo/capacitor-fichier pour la capacité native dans En utilisant @capgo/capacitor-fichier, @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-téléchargeur pour le détail d'implémentation dans @capgo/capacitor-téléchargeur, et En utilisant @capgo/capacitor-téléchargeur pour la capacité native dans En utilisant @capgo/capacitor-téléchargeur.