@capgo/capacitor-fichier

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

Vue d'ensemble

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 - Obtenez une entrée de fichier.
getDirectory - Obtenez une entrée de répertoire.

Public API

Méthode	Description
`requestFileSystem`	Demande un système de fichiers.
`resolveLocalFileSystemURL`	Résolvez une URL de fichier en entrée.
`getFile`	Obtenez une entrée de fichier.
`getDirectory`	Obtenez 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 de type 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 les contenus d'un répertoire.
`stat`	Obtenir les métadonnées sur un fichier ou un répertoire.
`getMetadata`	Obtenir les 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`	Obtenir l'URI d'un fichier.
`truncate`	Tronquer un fichier jusqu'à une taille spécifiée.
`getDirectories`	Obtenir tous les répertoires du système de fichiers connus.
`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`	Obtenir la version du plugin.
`checkPermissions`	Vérifier l'état actuel des permissions 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`	Demander 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 de la sélection d'un emplacement de stockage, de l'écriture de texte codé ou de la gestion d'erreurs de fichiers.

Répertoires

Valeur	Les utilisateurs trouveront
`DOCUMENTS`	Documents persistants visibles par l'utilisateur. Sur Android, cela correspond au répertoire des fichiers de l'application.
`DATA`	Données privées de l'application persistantes.
`LIBRARY`	Données d'application persistantes non 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`	Racine de stockage externe Android, comme une carte SD ou un stockage externe partagé.
`EXTERNAL_STORAGE`	Répertoire de données de stockage externe Android.
`APPLICATION`	Répertoire du bundle ou des assets de l'application en lecture seule.

Encodages

Valeur	Utilisation
`utf8`	Texte UTF-8.
`ascii`	Texte ASCII.
`utf16`	Texte UTF-16.

Codes d'erreurs 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`	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`	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 à partir de src/definitions.ts dans capacitor-fichier.

Continuez à partir de @capgo/capacitor-fichier

Si vous utilisez @capgo/capacitor-fichier pour planifier le stockage et la gestion des fichiers, connectez-l’avec Utilisation de @capgo/capacitor-fichier pour la capacité native dans Utilisation de @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, Utilisation de @capgo/capacitor-stockage-de-données-sqlite pour la capacité native dans Utilisation de @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 Utilisation de @capgo/capacitor-téléchargeur pour la capacité native dans Utilisation de @capgo/capacitor-téléchargeur.