Panoramica
Sezione intitolata “Panoramica”Capacitor Plugin per file Esegue operazioni sul sistema di file simili al plugin File di Cordova.
Capacità fondamentali
Sezione intitolata “Capacità fondamentali”requestFileSystem- Richiedi un sistema di file.resolveLocalFileSystemURL- Risolvi una URL di file in un'entry.getFile- Ottieni un'entry di file.getDirectory- Ottieni un'entrata di directory.
Pubblico API
Sezione intitolata “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 di 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 directory. |
exists | Controlla se un file o directory esiste. |
getUri | Ottieni l'URI per un file. |
truncate | Tronca un file a una dimensione specificata. |
getDirectories | Ottieni tutti i directory del sistema di file noti. |
getFreeDiskSpace | Ottenere 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 | Ottenere la versione del plugin. |
checkPermissions | Controlla lo stato di permesso 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. Su iOS e web, questo restituisce sempre ‘concesso’ poiché non sono necessarie autorizzazioni speciali. |
Valori di Riferimento
Sezione intitolata “Valori di Riferimento”Usa questi valori quando scegli una posizione di archiviazione, scrivi testo codificato o gestisci gli errori di file.
Directory
Sezione intitolata “Directory”| Valore | Il utente troverà |
|---|---|
DOCUMENTS | Documenti persistenti visibili dall'utente. Su Android questo si mappa sulla directory dei file dell'applicazione. |
DATA | Dati dell'applicazione persistenti privati. |
LIBRARY | Dati dell'applicazione persistenti non visibili dall'utente. Su Android questo si mappa sulla directory dei file dell'applicazione. |
CACHE | Temporary cache data that the OS may clear. |
EXTERNAL | Radice di archiviazione esterna Android, come una scheda SD o archiviazione esterna condivisa. |
EXTERNAL_STORAGE | Directory di archiviazione dati Android. |
APPLICATION | Directory del pacchetto di applicazione o risorse lettura-solo. |
Codifiche
Sezione intitolata “Codifiche”| Valore | Utilizza |
|---|---|
utf8 | Testo UTF-8. |
ascii | Testo ASCII. |
utf16 | Testo UTF-16. |
Codici di errore del file
Sezione intitolata “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 annullata. |
NOT_READABLE_ERR | 4 | Il file o la directory non possono essere letti. |
ENCODING_ERR | 5 | Il codifica è invalido o non supportato. |
NO_MODIFICATION_ALLOWED_ERR | 6 | Il target non può essere modificato. |
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 il target. |
QUOTA_EXCEEDED_ERR | 10 | Il limite di archiviazione è stato superato. |
TYPE_MISMATCH_ERR | 11 | Il tipo di valore non corrisponde al tipo previsto. |
PATH_EXISTS_ERR | 12 | La strada del target esiste già. |
Fonte di Verità
Sezione intitolata “Fonte di Verità”Questa riferimento è sincronizzato da src/definitions.ts in capacitor-file.
Continua da @capgo/capacitor-file
Sezione intitolata “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-archiviazione-dati-sqlite per i dettagli 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 i dettagli di implementazione in @capgo/capacitor-uploader, e Utilizzando @capgo/capacitor-uploader per la capacità nativa in Utilizzando @capgo/capacitor-uploader.