@capgo/capacitor-file

Il plugin Capacitor esegue operazioni sul file system simili a quelle del plugin Cordova File.

Panoramica

Capacitor Plugin del File Esegue operazioni sul sistema di file simili al plugin del sistema di file di Cordova.

Capacità di base

requestFileSystem - Richiedi un sistema di file.
resolveLocalFileSystemURL - Risolvi una URL di file in un'entry.
getFile - Ottieni un'entry del file.
getDirectory - Ottieni un'entrata di directory.

Pubblico API

Metodo	Descrizione
`requestFileSystem`	Richiedi un sistema di file.
`resolveLocalFileSystemURL`	Risolve un URL di file in un'entrata.
`getFile`	Ottieni un'entrata di file.
`getDirectory`	Ottieni un'entrata di directory.
`readFile`	Leggi un file come testo o base64.
`readAsDataURL`	Leggi un file come un URL dei dati (base64 con prefisso MIME).
`writeFile`	Scrivi dati in un file.
`appendFile`	Aggiungi dati a un file.
`deleteFile`	Elimina un file.
`mkdir`	Crea una directory.
`rmdir`	Elimina una directory.
`readdir`	Leggi i contenuti della directory.
`stat`	Otteni metadati su un file o directory.
`getMetadata`	Otteni metadati su un file o directory. Alias per stat().
`rename`	Rinomina o sposta un file o directory.
`move`	Sposta un file o directory. Alias per rename().
`copy`	Copia un file o directory.
`exists`	Controlla se un file o directory esiste.
`getUri`	Otteni l'URI per un file.
`truncate`	Trasforma un file in una dimensione specificata.
`getDirectories`	Ottieni tutti i directory del sistema di file conosciuti.
`getFreeDiskSpace`	Ottieni lo spazio libero del disco in byte.
`addListener`	Ascolta gli eventi di progresso di lettura.
`addListener`	Ascolta gli eventi di progresso di scrittura.
`removeAllListeners`	Elimina tutti gli ascoltatori di eventi.
`getPluginVersion`	Ottieni la versione del plugin.
`checkPermissions`	Verifica lo stato di autorizzazione corrente per le operazioni di file. Su Android, questo controlla le autorizzazioni di archiviazione esterna. Su iOS e web, questo restituisce sempre ‘concesso’ poiché non sono necessarie autorizzazioni speciali.
`requestPermissions`	Richiedi le autorizzazioni per le operazioni di file. Su Android, questo richiede le autorizzazioni di archiviazione esterna necessarie per accedere ai file al di fuori dei directory privati dell'app.

Valori di Riferimento

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

Direttori

Valore	L'utente troverà
`DOCUMENTS`	Dati persistenti visibili dall'utente. Su Android, questo si mappa sulla directory dei file dell'applicazione.
`DATA`	Dati app app privati persistenti.
`LIBRARY`	Dati app persistenti non visibili dall'utente. Su Android, questo si mappa sulla directory dei file dell'applicazione.
`CACHE`	Dati di cache temporanei che il sistema operativo può cancellare.
`EXTERNAL`	Radice di archiviazione esterna Android, come una scheda SD o archiviazione esterna condivisa.
`EXTERNAL_STORAGE`	Directory di archiviazione esterna Android dei dati.
`APPLICATION`	Directory del pacchetto di applicazione o risorse lettura-solo.

Tipi di codifica

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

Errori di file

Valore	Code	Significato
`NOT_FOUND_ERR`	`1`	File o directory non trovati.
`SECURITY_ERR`	`2`	L'operazione è stata bloccata dalle regole di sicurezza o dalle autorizzazioni.
`ABORT_ERR`	`3`	L'operazione è stata annullata.
`NOT_READABLE_ERR`	`4`	Il file o la directory non possono essere letti.
`ENCODING_ERR`	`5`	L'encoding è invalido o non supportato.
`NO_MODIFICATION_ALLOWED_ERR`	`6`	La destinazione non può essere modificata.
`INVALID_STATE_ERR`	`7`	L'oggetto si trova in uno stato non valido per l'operazione.
`SYNTAX_ERR`	`8`	La strada o la sintassi di input è invalida.
`INVALID_MODIFICATION_ERR`	`9`	La richiesta di modifica è invalida per la destinazione.
`QUOTA_EXCEEDED_ERR`	`10`	È stato superato il limite di quota di archiviazione.
`TYPE_MISMATCH_ERR`	`11`	Il tipo di valore non corrisponde al tipo previsto.
`PATH_EXISTS_ERR`	`12`	La destinazione del percorso esiste già.

Fonte di Verità

Questa riferimento è sincronizzato da src/definitions.ts in capacitor-file.

Continua da @capgo/capacitor-file

Se stai utilizzando @capgo/capacitor-file per pianificare lo storage e il trattamento dei file, connettilo con Utilizzando @capgo/capacitor-file per la capacità nativa in Utilizzando @capgo/capacitor-file, @capgo/capacitor-data-storage-sqlite For il dettaglio di implementazione in @capgo/capacitor-data-storage-sqlite, Utilizzando @capgo/capacitor-data-storage-sqlite Per la capacità nativa in Utilizzando @capgo/capacitor-data-storage-sqlite, @capgo/capacitor-uploader Per il dettaglio di implementazione in @capgo/capacitor-uploader, e Utilizzando @capgo/capacitor-uploader Per la capacità nativa in Utilizzando @capgo/capacitor-uploader.