@capgo/capacitor-file

Umfassendes Filesystem-Plugin zum Lesen, Schreiben und Verwalten von Dateien und Verzeichnissen

Übersicht

Umfassendes Filesystem-Plugin zum Lesen, Schreiben und Verwalten von Dateien und Verzeichnissen

Starte mit requestFileSystem() und den anderen unten aufgeführten Core-Methoden.

Plattformunterstützung

Plattform	Support	Notizen
iOS	Ja	Native
Android	Ja	Native
Web	Ja	Browser-Storage-APIs

Kernfunktionen

requestFileSystem - Dateisystem anfordern.
resolveLocalFileSystemURL - Datei-URL in einen Eintrag auflösen.
getFile - Dateieintrag abrufen.
getDirectory - Ein Verzeichniseintrag abrufen.

Öffentliches API

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`	Datei auf eine bestimmte Größe kürzen.
`getDirectories`	Alle bekannten Dateisystemverzeichnisse abrufen.
`getFreeDiskSpace`	Freien Speicherplatz in Bytes abrufen.
`addListener`	Auf Lese-Fortschrittsereignisse lauschen.
`addListener`	Auf Schreib-Fortschrittsereignisse lauschen.
`removeAllListeners`	Alle Event-Listener entfernen.
`getPluginVersion`	Plugin-Version abrufen.
`checkPermissions`	Aktuellen Berechtigungsstatus für Dateioperationen prüfen. Auf Android werden die Berechtigungen für externen Speicher geprüft. Auf iOS und Web wird immer „gewährt“ zurückgegeben, da keine besonderen Berechtigungen erforderlich sind.
`requestPermissions`	Berechtigungen für Dateioperationen anfordern. Auf Android werden die Berechtigungen für externen Speicher angefordert, die für den Zugriff auf Dateien außerhalb der privaten App-Verzeichnisse benötigt werden. Auf iOS und Web wird immer „gewährt“ zurückgegeben, da keine besonderen Berechtigungen erforderlich sind.

Referenzwerte

Verwenden Sie diese Werte, wenn Sie einen Speicherort auswählen, kodierten Text schreiben oder Dateifehler behandeln.

Verzeichnisse

Wert	Der Benutzer findet
`DOCUMENTS`	Dauerhafte, für den Nutzer sichtbare Dokumente. Auf Android entspricht dies dem App-Dateiverzeichnis.
`DATA`	Dauerhafte, private App-Daten.
`LIBRARY`	Dauerhafte App-Daten, die nicht für den Nutzer sichtbar sind. Auf Android entspricht dies dem App-Dateiverzeichnis.
`CACHE`	Temporäre Cache-Daten, die das Betriebssystem löschen kann.
`EXTERNAL`	Android-Externer Speicherort, z. B. eine SD-Karte oder der gemeinsame externe Speicher.
`EXTERNAL_STORAGE`	Android-externes Speicher-Datenverzeichnis.
`APPLICATION`	Nur-lesbares Application-Bundle- oder Assets-Verzeichnis.

Encodings

Wert	Nutzt
`utf8`	UTF-8-Text.
`ascii`	ASCII-Text.
`utf16`	UTF-16-Text.

Datei-Fehlercodes

Wert	Code	Bedeutung
`NOT_FOUND_ERR`	`1`	Datei oder Verzeichnis wurde nicht gefunden.
`SECURITY_ERR`	`2`	Vorgang wurde durch Sicherheitsregeln oder Berechtigungen blockiert.
`ABORT_ERR`	`3`	Vorgang wurde abgebrochen.
`NOT_READABLE_ERR`	`4`	Datei oder Verzeichnis kann nicht gelesen werden.
`ENCODING_ERR`	`5`	Codierung ist ungültig oder nicht unterstützt.
`NO_MODIFICATION_ALLOWED_ERR`	`6`	Ziel kann nicht geändert werden.
`INVALID_STATE_ERR`	`7`	Objekt befindet sich in einem ungültigen Zustand für den Vorgang.
`SYNTAX_ERR`	`8`	Pfad oder Eingabesyntax ist ungültig.
`INVALID_MODIFICATION_ERR`	`9`	Angeforderte Änderung ist für das Ziel ungültig.
`QUOTA_EXCEEDED_ERR`	`10`	Speicherquote wurde überschritten.
`TYPE_MISMATCH_ERR`	`11`	Werttyp entspricht nicht dem erwarteten Typ.
`PATH_EXISTS_ERR`	`12`	Zielpfad existiert bereits.

Source of Truth

Diese Referenz wird synchronisiert von src/definitions.ts in einem capacitor-file.

Weiter von @capgo/capacitor-file

Wenn du es nutzt @capgo/capacitor-file um Speicher- und Dateiverwaltung zu planen, verbinde es mit @capgo/capacitor-file verwenden für die native Funktion in „Verwendung von @capgo/capacitor-file“, @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 Funktionalität in „@capgo/capacitor-data-storage-sqlite verwenden“, @capgo/capacitor-uploader für die Implementierungsdetails in @capgo/capacitor-uploader und Mit @capgo/capacitor-uploader für die native Funktion in Using @capgo/capacitor-uploader.