@capgo/capacitor-fichier

Présentation

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

Capacités Clés

• requestFileSystem - Demandez 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	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 de type MIME).
writeFile	Écrire des données dans un fichier.
appendFile	Ajoutez des données à un fichier.
deleteFile	Supprimez un fichier.
mkdir	Créez un répertoire.
rmdir	Supprimez un répertoire.
readdir	Affichez les contenus du répertoire.
stat	Obtenez des métadonnées sur un fichier ou un répertoire.
getMetadata	Obtenez des métadonnées sur un fichier ou un répertoire. Alias pour stat().
rename	Renommez ou déplacez un fichier ou un répertoire.
move	Déplacez un fichier ou un répertoire. Alias pour rename().
copy	Copiez un fichier ou un répertoire.
exists	Vérifiez si un fichier ou un répertoire existe.
getUri	Obtenez l'URI pour un fichier.
truncate	Réduire 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	Obtenir la version du plugin.
checkPermissions	Vérifier le statut 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	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 du choix d'un emplacement de stockage, de l'écriture de texte codé ou de la gestion d'erreurs de fichiers.

Dossiers

Valeur	L'utilisateur trouvera
DOCUMENTS	Fichiers persistants visibles par l'utilisateur. Sur Android, cela correspond au répertoire des fichiers de l'application.
DATA	Fichiers persistants de l'application.
LIBRARY	Données d'application persistantes non visibles par l'utilisateur. Sur Android, cela correspond au répertoire des fichiers de l'application.
CACHE	Fichiers de cache temporaires que le système peut effacer.
EXTERNAL	Répertoire 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 de fichiers de l'application ou d'actifs 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	L'opération a été bloquée par des règles ou des permissions de sécurité.
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	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 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	Le type de valeur ne correspond pas au type attendu.
PATH_EXISTS_ERR	12	Le chemin de la cible existe déjà.

Source de Vérité

Cette référence est synchronisée à partir de src/definitions.ts en 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 En utilisant @capgo/capacitor-fichier pour la capacité native dans En utilisant @capgo/capacitor-fichier, @capgo/capacitor-stockage-de-données-sqlite pour les détails d'implémentation dans @capgo/capacitor-data-storage-sqlite, En utilisant @capgo/capacitor-data-storage-sqlite pour la capacité native dans En utilisant @capgo/capacitor-data-storage-sqlite, @capgo/capacitor-téléchargeur pour les détails d'implémentation dans @capgo/capacitor-uploader, et En utilisant @capgo/capacitor-uploader pour la capacité native dans En utilisant @capgo/capacitor-uploader.