Guida
Come usare File in Capacitor
Utilizzo di @capgo/capacitor-file
Il plugin Capacitor File implementa operazioni sul file system simili al plugin Cordova File.
Installa
bun add @capgo/capacitor-file
bunx cap sync
bunx cap sync copia i code nativi del plugin nei tuoi progetti nativi. Eseguilo di nuovo dopo ogni aggiornamento del plugin.
Importa
import { CapacitorFile } from '@capgo/capacitor-file';
API in breve
| Metodo | Descrizione |
|---|---|
requestFileSystem |
Richiedi l'accesso al file system. |
resolveLocalFileSystemURL |
Risolvi un URL di un file in un entry. |
getFile |
Ottieni un file entry. |
getDirectory |
Ottieni un directory entry. |
readFile |
Leggi un file come testo o base64. |
readAsDataURL |
Leggi un file come data URL (base64 con prefisso MIME). |
writeFile |
Scrivi 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 un file o una directory esiste. |
getUri |
Ottiene l'URI di un file. |
truncate |
Tronca un file a una dimensione specificata. |
getDirectories |
Ottieni tutte le directory del file system note. |
getFreeDiskSpace |
Ottieni lo spazio disco libero in byte. |
checkPermissions |
Controlla 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 fuori dalle directory private dell'app. Su iOS e web, restituisce sempre 'granted' poiché non sono necessari permessi speciali. |
Esempi
requestFileSystem()
Richiedi un file system.
import { CapacitorFile, FileSystemType } from '@capgo/capacitor-file';
const result = await CapacitorFile.requestFileSystem({ type: FileSystemType.TEMPORARY });
console.log(result);
resolveLocalFileSystemURL()
Risolve un URL di un file in un entry.
import { CapacitorFile } from '@capgo/capacitor-file';
const result = await CapacitorFile.resolveLocalFileSystemURL({ url: 'https://example.com' });
console.log(result);
getFile()
Ottieni un file entry.
import { CapacitorFile } from '@capgo/capacitor-file';
const result = await CapacitorFile.getFile({ path: 'path/to/file' });
console.log(result);
getDirectory()
Ottieni una directory entry.
import { CapacitorFile } from '@capgo/capacitor-file';
const result = await CapacitorFile.getDirectory({ path: 'path/to/file' });
console.log(result);
readFile()
Leggi un file come testo o base64.
import { CapacitorFile } from '@capgo/capacitor-file';
const result = await CapacitorFile.readFile({ path: 'path/to/file' });
console.log(result);
readAsDataURL()
Leggi un file come data URL (base64 con prefisso MIME type).
import { CapacitorFile } from '@capgo/capacitor-file';
const result = await CapacitorFile.readAsDataURL({ path: 'path/to/file' });
console.log(result);
La tabella sopra elenca i 24 metodi principali. Listener, helper di versione e il contratto completo di ogni metodo sono documentati nel repository GitHub.
Ascolta gli eventi
addListener restituisce un handle. Chiama handle.remove() quando lo schermo viene smontato, o CapacitorFile.removeAllListeners() per rimuovere ogni listener.
Riferimento completo
Continua da Using @capgo/capacitor-file
Se stai usando Utilizzo di @capgo/capacitor-file per pianificare storage e gestione file, connettilo a @capgo/capacitor-file per i dettagli di implementazione in @capgo/capacitor-file, Per iniziare per i dettagli di implementazione nella guida introduttiva, @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 capacità nativa in Utilizzo di @capgo/capacitor-data-storage-sqlite, e @capgo/capacitor-uploader per i dettagli di implementazione in @capgo/capacitor-uploader.