@capgo/capacitor-file

Plugin completo per il file system per leggere, scrivere e gestire file e directory

Panoramica

Plugin completo per il file system per leggere, scrivere e gestire file e directory

Inizia con requestFileSystem() e gli altri metodi principali elencati qui sotto.

Supporto piattaforme

Piattaforma	Supporto	Note
iOS	Sì	Nativo
Android	Sì	Nativo
Web	Sì	API di storage del browser

Funzionalità principali

requestFileSystem - Richiedi un file system.
resolveLocalFileSystemURL - Risolvi l'URL di un file in una entry.
getFile - Ottieni una entry di file.
getDirectory - Ottieni un'entry di directory.

Pubblico API

Metodo	Descrizione
`requestFileSystem`	Richiedi un file system.
`resolveLocalFileSystemURL`	Risolvi un URL di file in un'entry.
`getFile`	Ottieni un'entry di file.
`getDirectory`	Ottieni una entry di directory.
`readFile`	Leggi un file come testo o base64.
`readAsDataURL`	Leggi un file come data URL (base64 con prefisso del tipo MIME).
`writeFile`	Scrivi dei dati in un file.
`appendFile`	Aggiunge dati a un file.
`deleteFile`	Elimina un file.
`mkdir`	Crea una directory.
`rmdir`	Elimina una directory.
`readdir`	Legge il contenuto di una directory.
`stat`	Ottiene i metadati di un file o di una directory.
`getMetadata`	Ottiene i metadati di un file o di una directory. Alias di stat().
`rename`	Rinomina o sposta un file o una directory.
`move`	Sposta un file o una directory. Alias di rename().
`copy`	Copia un file o una directory.
`exists`	Verifica se esiste un file o una directory.
`getUri`	Ottiene l'URI di un file.
`truncate`	Tronca un file alla dimensione specificata.
`getDirectories`	Ottieni tutte le directory conosciute del file system.
`getFreeDiskSpace`	Ottieni lo spazio libero su disco in byte.
`addListener`	Ascolta gli eventi di avanzamento della lettura.
`addListener`	Listen for write progress events.
`removeAllListeners`	Rimuovi tutti gli event listener.
`getPluginVersion`	Ottieni la versione del plugin.
`checkPermissions`	Verifica lo stato attuale dei permessi per le operazioni sui file. Su Android, verifica i permessi per lo storage esterno. Su iOS e web, restituisce sempre 'granted' poiché non sono necessari permessi speciali.
`requestPermissions`	Richiedi i permessi per le operazioni sui file. Su Android, richiede i permessi per lo storage esterno necessari per accedere ai file al di fuori delle directory private dell'app. Su iOS e web, restituisce sempre 'granted' poiché non sono necessari permessi speciali.

Valori di riferimento

Usa questi valori quando scegli una posizione di archiviazione, scrivi testo codificato o gestisci errori dei file.

Valore	L'utente troverà
`DOCUMENTS`	Documenti persistenti visibili all'utente. Su Android corrisponde alla directory dei file dell'app.
`DATA`	Dati privati persistenti dell'app.
`LIBRARY`	Dati persistenti dell'app non visibili all'utente. Su Android corrisponde alla directory dei file dell'app.
`CACHE`	Temporary cache data that the OS may clear.
`EXTERNAL`	Radice dello storage esterno di Android, come una scheda SD o lo storage esterno condiviso.
`EXTERNAL_STORAGE`	Directory dei dati dello storage esterno di Android.
`APPLICATION`	Directory di bundle o asset dell'applicazione in sola lettura.

Codifiche

Valore	Usa
`utf8`	Testo UTF-8.
`ascii`	Testo ASCII.
`utf16`	Testo UTF-16.

Codici di errore file

Valore	Code	Significato
`NOT_FOUND_ERR`	`1`	File o directory non trovati.
`SECURITY_ERR`	`2`	Operazione bloccata da regole di sicurezza o permessi.
`ABORT_ERR`	`3`	Operazione interrotta.
`NOT_READABLE_ERR`	`4`	Impossibile leggere il file o la directory.
`ENCODING_ERR`	`5`	Codifica non valida o non supportata.
`NO_MODIFICATION_ALLOWED_ERR`	`6`	L'oggetto di destinazione non può essere modificato.
`INVALID_STATE_ERR`	`7`	L'oggetto è in uno stato non valido per l'operazione.
`SYNTAX_ERR`	`8`	Path o sintassi di input non validi.
`INVALID_MODIFICATION_ERR`	`9`	La modifica richiesta non è valida per il target.
`QUOTA_EXCEEDED_ERR`	`10`	Quota di archiviazione superata.
`TYPE_MISMATCH_ERR`	`11`	Il tipo di valore non corrisponde al tipo atteso.
`PATH_EXISTS_ERR`	`12`	Il percorso di destinazione esiste già.

Fonte di verità

Questo riferimento è sincronizzato da src/definitions.ts nella capacitor-file.

Continua da @capgo/capacitor-file

Se stai usando @capgo/capacitor-file per pianificare lo storage e la gestione dei file, collegalo a Utilizzo di @capgo/capacitor-file per la funzionalità nativa in Using @capgo/capacitor-file, @capgo/capacitor-data-storage-sqlite per i dettagli di implementazione in @capgo/capacitor-data-storage-sqlite, Utilizzo di @capgo/capacitor-data-storage-sqlite per la funzionalità nativa in Utilizzo di @capgo/capacitor-data-storage-sqlite, @capgo/capacitor-uploader per i dettagli di implementazione in @capgo/capacitor-uploader, e Utilizzo di @capgo/capacitor-uploader per la funzionalità nativa in Using @capgo/capacitor-uploader.