@capgo/capacitor-file

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

Panoramica

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

Capacità di base

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

Pubblico API

Metodo	Descrizione
`requestFileSystem`	Richiedi un sistema di file.
`resolveLocalFileSystemURL`	Risolvi una URL di file a un'entry.
`getFile`	Ottieni un'entry di file.
`getDirectory`	Ottieni un'entry di directory.
`readFile`	Leggi un file come testo o base64.
`readAsDataURL`	Leggi un file come una 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`	Ottieni metadati su un file o directory.
`getMetadata`	Ottieni 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 una directory.
`exists`	Verifica se un file o una directory esiste.
`getUri`	Ottieni l'URI per un file.
`truncate`	Tronca un file a una dimensione specificata.
`getDirectories`	Ottieni tutte le directory del sistema di file conosciute.
`getFreeDiskSpace`	Ottieni lo spazio libero sul 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 sui 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 sui file. Su Android, questo richiede le autorizzazioni di archiviazione esterna necessarie per accedere ai file al di fuori delle directory private dell'app. Su iOS e web, questo restituisce sempre 'concesso' poiché non sono necessarie autorizzazioni speciali.

Valori di Riferimento

Usa questi valori quando scegli un'ubicazione di archiviazione, scrivi testo codificato o gestisci errori di file.

Valore	L'utente troverà
`DOCUMENTS`	Documenti persistenti visibili dall'utente. Su Android, questo si mappa sulla directory dei file dell'applicazione.
`DATA`	Dati dell'applicazione persistenti e privati.
`LIBRARY`	Dati dell'applicazione 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 di Android, ad esempio una scheda SD o un'archiviazione esterna condivisa.
`EXTERNAL_STORAGE`	Directory di archiviazione dati esterno per Android.
`APPLICATION`	Directory del bundle o degli asset dell'applicazione in sola lettura.

Codifiche

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

Codici di errore del file

Valore	Code	Significato
`NOT_FOUND_ERR`	`1`	Il file o la directory non è stato trovato.
`SECURITY_ERR`	`2`	L'operazione è stata bloccata dalle regole di sicurezza o dalle autorizzazioni.
`ABORT_ERR`	`3`	L'operazione è stata interrotta.
`NOT_READABLE_ERR`	`4`	Il file o la directory non può essere letto.
`ENCODING_ERR`	`5`	Il codifica è invalida o non supportata.
`NO_MODIFICATION_ALLOWED_ERR`	`6`	Il target non può essere modificato.
`INVALID_STATE_ERR`	`7`	L'oggetto è 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 il target.
`QUOTA_EXCEEDED_ERR`	`10`	Il limite di spazio di archiviazione è stato superato.
`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 referenza è sincronizzata da src/definitions.ts in capacitor-file.

Continua da @capgo/capacitor-file

Se stai utilizzando @capgo/capacitor-file per pianificare lo storage e la gestione dei file, connettilo con Utilizzando @capgo/capacitor-file per la capacità nativa in Utilizzando @capgo/capacitor-file, @capgo/capacitor-data-storage-sqlite per 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.