Übersicht
ÜbersichtCapacitor Datei-Plugin implementiert Dateisystemoperationen ähnlich dem Cordova File Plugin.
Kernfunktionen
KernfunktionenrequestFileSystem- Eine Dateisystem anfordern.resolveLocalFileSystemURL- Eine Datei-URL auf ein Eintragsobjekt auflösen.getFile- Ein Dateieintrag erhalten.getDirectory- Ein Verzeichniseintrag erhalten.
- Öffentlich API
- Abschnitt mit dem Titel „Öffentlich API“| - Methode | - Beschreibung |
|---|---|
requestFileSystem | - Eine Dateisystem anfordern. |
resolveLocalFileSystemURL | - Eine Datei-URL auf ein Eintragsobjekt auflösen. |
getFile | - Ein Dateieintrag erhalten. |
getDirectory | - Ein Verzeichniseintrag erhalten. |
readFile | Ein Datei als Text oder Base64 lesen. |
readAsDataURL | Eine Datei als Daten-URL (Base64 mit MIME-Typ-Präfix) lesen. |
writeFile | Daten in eine Datei schreiben. |
appendFile | Daten zu einer Datei hinzufügen. |
deleteFile | Eine Datei löschen. |
mkdir | Ein Verzeichnis erstellen. |
rmdir | Ein Verzeichnis löschen. |
readdir | Inhalte eines Verzeichnisses lesen. |
stat | Metadaten über eine Datei oder ein Verzeichnis erhalten. |
getMetadata | Metadaten über eine Datei oder ein Verzeichnis erhalten. Alias für stat(). |
rename | Eine Datei oder ein Verzeichnis umbenennen oder verschieben. |
move | Eine Datei oder ein Verzeichnis verschieben. Alias für rename(). |
copy | Einen Datei- oder Verzeichnisinhalt kopieren. |
exists | Überprüfen, ob eine Datei oder ein Verzeichnis existiert. |
getUri | Ermitteln Sie die URI einer Datei. |
truncate | Eine Datei auf eine bestimmte Größe reduzieren. |
getDirectories | Alle bekannten Dateisystem-Verzeichnisse abrufen. |
getFreeDiskSpace | Die verfügbare Festplattenplatzgröße in Bytes ermitteln. |
addListener | Für Lesevorgänge auf Ereignisse lauschen. |
addListener | Für Schreibvorgänge auf Ereignisse lauschen. |
removeAllListeners | Alle Ereignis-Listener entfernen. |
getPluginVersion | Die Plugin-Version abrufen. |
checkPermissions | Überprüfen Sie den aktuellen Berechtigungsstatus für Dateibearbeitungen. Auf Android überprüft dies die externen Speicherberechtigungen. Auf iOS und Web wird immer 'erlaubt' zurückgegeben, da keine besonderen Berechtigungen erforderlich sind. |
requestPermissions | Berechtigungen für Dateibearbeitungen anfordern. Auf Android werden die externen Speicherberechtigungen angefordert, die zum Zugriff auf Dateien außerhalb der privaten Verzeichnisse des Apps erforderlich sind. Auf iOS und Web wird immer 'erlaubt' zurückgegeben, da keine besonderen Berechtigungen erforderlich sind. |
Referenzwerte
Abschnitt mit dem Titel “Referenzwerte”Wenden Sie diese Werte an, wenn Sie einen Speicherort auswählen, verschlüsseltes Text schreiben oder Datei-Fehler behandeln.
Verzeichnisse
Abschnitt mit dem Titel “Verzeichnisse”| Wert | Der Benutzer findet |
|---|---|
DOCUMENTS | Persistente, benutzersichtbare Dokumente. Auf Android entspricht dies dem Verzeichnis der Anwendungsdateien. |
DATA | Persistente private Anwendungsdaten. |
LIBRARY | Persistente Anwendungsdaten, die nicht benutzersichtbar sind. Auf Android entspricht dies dem Verzeichnis der Anwendungsdateien. |
CACHE | Temporäre Cache-Daten, die das Betriebssystem löschen kann. |
EXTERNAL | Android-externe Speicherwurzel, wie ein SD-Karte oder gemeinsam genutzter externer Speicher. |
EXTERNAL_STORAGE | Android Speicherort für externe Daten. |
APPLICATION | Lese-schreibgeschützter Anwendungs- oder Assets-Ordner. |
Codierungen
Abschnitt mit dem Titel „Codierungen“| Wert | Verwenden |
|---|---|
utf8 | UTF-8-Text. |
ascii | ASCII-Text. |
utf16 | UTF-16-Text. |
Datei-Fehlercodes
Abschnitt mit dem Titel „Datei-Fehlercodes“| Wert | Code | Bedeutung |
|---|---|---|
NOT_FOUND_ERR | 1 | Datei oder Verzeichnis wurde nicht gefunden. |
SECURITY_ERR | 2 | Die Operation wurde durch Sicherheitsregeln oder Berechtigungen blockiert. |
ABORT_ERR | 3 | Die Operation wurde abgebrochen. |
NOT_READABLE_ERR | 4 | Die Datei oder das Verzeichnis kann nicht gelesen werden. |
ENCODING_ERR | 5 | Die Kodierung ist ungültig oder wird nicht unterstützt. |
NO_MODIFICATION_ALLOWED_ERR | 6 | Das Ziel kann nicht geändert werden. |
INVALID_STATE_ERR | 7 | Das Objekt befindet sich in einem ungültigen Zustand für die Operation. |
SYNTAX_ERR | 8 | Der Pfad oder die Eingabesyntax ist ungültig. |
INVALID_MODIFICATION_ERR | 9 | Die angeforderte Änderung ist für das Ziel ungültig. |
QUOTA_EXCEEDED_ERR | 10 | Der Speicherplatz wurde überschritten. |
TYPE_MISMATCH_ERR | 11 | Typ des Wertes entspricht nicht der erwarteten Art. |
PATH_EXISTS_ERR | 12 | Zielverzeichnis existiert bereits. |
Quellwahrheit
Abschnitt mit dem Titel „Quellwahrheit“Diese Referenz wird von src/definitions.ts in capacitor-Datei.
Fortsetzen Sie von @capgo/capacitor-Datei
Abschnitt mit dem Titel „Fortsetzen Sie von @capgo/capacitor-Datei“Wenn Sie Storage und Dateimanagement mit @capgo/capacitor-Datei planen, verbinden Sie es mit Mit @capgo/capacitor-Datei für die native Fähigkeit in Mit @capgo/capacitor-Datei @capgo/capacitor-Daten-Speicher-SQLite für die Implementierungsdetails in @capgo/capacitor-Daten-Speicher-SQLite Mit @capgo/capacitor-Daten-Speicher-SQLite für die native Fähigkeit in Mit @capgo/capacitor-Daten-Speicher-SQLite @capgo/capacitor-Uploader für die Implementierungsdetails in @capgo/capacitor-Uploader und Mit @capgo/capacitor-Uploader für die native Fähigkeit in Mit @capgo/capacitor-Uploader.