Anleitung
So verwendest du File in Capacitor
@capgo/capacitor-file verwenden
Das Capacitor File Plugin implementiert Dateisystem-Operationen, ähnlich wie das Cordova File Plugin.
Installieren
bun add @capgo/capacitor-file
bunx cap sync
bunx cap sync kopiert den nativen code des Plugins in deine nativen Projekte. Nach jedem Plugin-Upgrade erneut ausführen.
Importieren
import { CapacitorFile } from '@capgo/capacitor-file';
API auf einen Blick
| Methode | Beschreibung |
|---|---|
requestFileSystem |
Dateisystem anfordern. |
resolveLocalFileSystemURL |
Eine Datei-URL in einen Eintrag auflösen. |
getFile |
Ein Dateieintrag abrufen. |
getDirectory |
Ein Verzeichniseintrag abrufen. |
readFile |
Eine Datei als Text oder base64 lesen. |
readAsDataURL |
Datei als Data-URL lesen (base64 mit MIME-Typ-Präfix). |
writeFile |
Daten in eine Datei schreiben. |
appendFile |
Daten an eine Datei anhängen. |
deleteFile |
Eine Datei löschen. |
mkdir |
Ein Verzeichnis erstellen. |
rmdir |
Ein Verzeichnis löschen. |
readdir |
Verzeichnisinhalt lesen. |
stat |
Metadaten einer Datei oder eines Verzeichnisses abrufen. |
getMetadata |
Metadaten einer Datei oder eines Verzeichnisses abrufen. Alias für stat(). |
rename |
Datei oder Verzeichnis umbenennen oder verschieben. |
move |
Eine Datei oder ein Verzeichnis verschieben. Alias für rename(). |
copy |
Datei oder Verzeichnis kopieren. |
exists |
Prüfen, ob eine Datei oder ein Verzeichnis existiert. |
getUri |
Die URI einer Datei abrufen. |
truncate |
Eine Datei auf eine bestimmte Größe kürzen. |
getDirectories |
Alle bekannten Dateisystem-Verzeichnisse abrufen. |
getFreeDiskSpace |
Den freien Speicherplatz in Bytes abrufen. |
checkPermissions |
Prüft den aktuellen Berechtigungsstatus für Dateioperationen. Auf Android werden die Berechtigungen für externen Speicher geprüft. Auf iOS und Web wird immer 'granted' zurückgegeben, da keine speziellen Berechtigungen erforderlich sind. |
requestPermissions |
Fordert Berechtigungen für Dateioperationen an. Auf Android werden die Berechtigungen für externen Speicher angefordert, die für den Zugriff auf Dateien außerhalb der privaten Verzeichnisse der App benötigt werden. Auf iOS und Web wird immer 'granted' zurückgegeben, da keine speziellen Berechtigungen erforderlich sind. |
Beispiele
requestFileSystem()
Dateisystem anfordern.
import { CapacitorFile, FileSystemType } from '@capgo/capacitor-file';
const result = await CapacitorFile.requestFileSystem({ type: FileSystemType.TEMPORARY });
console.log(result);
resolveLocalFileSystemURL()
Eine Datei-URL in einen Eintrag auflösen.
import { CapacitorFile } from '@capgo/capacitor-file';
const result = await CapacitorFile.resolveLocalFileSystemURL({ url: 'https://example.com' });
console.log(result);
getFile()
Ein Dateieintrag abrufen.
import { CapacitorFile } from '@capgo/capacitor-file';
const result = await CapacitorFile.getFile({ path: 'path/to/file' });
console.log(result);
getDirectory()
Ein Verzeichniseintrag abrufen.
import { CapacitorFile } from '@capgo/capacitor-file';
const result = await CapacitorFile.getDirectory({ path: 'path/to/file' });
console.log(result);
readFile()
Eine Datei als Text oder base64 lesen.
import { CapacitorFile } from '@capgo/capacitor-file';
const result = await CapacitorFile.readFile({ path: 'path/to/file' });
console.log(result);
readAsDataURL()
Datei als Data-URL lesen (base64 mit MIME-Typ-Präfix).
import { CapacitorFile } from '@capgo/capacitor-file';
const result = await CapacitorFile.readAsDataURL({ path: 'path/to/file' });
console.log(result);
Die obige Tabelle listet die 24 Kernmethoden auf. Listener- und Versions-Helper sowie der vollständige Contract jeder Methode sind in der GitHub Repository.
Events abonnieren
addListener gibt ein Handle zurück. Rufe handle.remove() auf, wenn der Screen unmountet, oder CapacitorFile.removeAllListeners() auf, um alle Listener zu entfernen.
Vollständige Referenz
Weiter geht's mit Using @capgo/capacitor-file
Wenn du es nutzt @capgo/capacitor-file verwenden um Speicher- und Dateiverwaltung zu planen, verbinde es mit @capgo/capacitor-file für das Implementierungsdetail in @capgo/capacitor-file, Erste Schritte für die Implementierungsdetails in Erste Schritte, @capgo/capacitor-data-storage-sqlite für die Implementierungsdetails in @capgo/capacitor-data-storage-sqlite, Mit @capgo/capacitor-data-storage-sqlite für die native Funktion bei der Nutzung von @capgo/capacitor-data-storage-sqlite und @capgo/capacitor-uploader für das Implementierungsdetail in @capgo/capacitor-uploader.