@capgo/capacitor-file
Übersicht
Abschnitt mit dem Titel „Übersicht“Capacitor Datei-Plugin implementiert Dateisystemoperationen ähnlich dem Cordova File Plugin.
Kernfunktionen
Abschnitt mit dem Titel „Kernfunktionen“requestFileSystem- Einen Dateisystem anfordern.resolveLocalFileSystemURL- Eine Datei-URL auf ein Eintrag auflösen.getFile- Ein Dateieintrag erhalten.getDirectory- Ein Verzeichniseintrag erhalten.
- Öffentlich API
- Abschnitt mit dem Titel „Öffentlich API“| - Methode | - Beschreibung |
|---|---|
requestFileSystem | - Ein Dateisystem anfordern. |
resolveLocalFileSystemURL | - Eine Datei-URL auf ein Eintrag auflösen. |
getFile | - Ein Dateieintrag erhalten. |
getDirectory | - Ein Verzeichniseintrag erhalten. |
readFile | - Eine Datei als Text oder Base64 lesen. |
readAsDataURL | Ein Datei als Daten-URL (Base64 mit MIME-Typ-Präfix) lesen. |
writeFile | Daten in eine Datei schreiben. |
appendFile | Daten zu einer Datei anhängen. |
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 | Eine Datei oder ein Verzeichnis kopieren. |
exists | Überprüfen Sie, ob ein Datei- oder Verzeichnis existiert. |
getUri | Rufen Sie die URI einer Datei ab. |
truncate | Einschränken Sie eine Datei auf eine bestimmte Größe. |
getDirectories | Rufen Sie alle bekannten Dateisystem-Verzeichnisse ab. |
getFreeDiskSpace | Rufen Sie die verfügbare Festplattenplatz in Bytes ab. |
addListener | Hören Sie auf Leseprozessereignisse. |
addListener | Hören Sie auf Schreibeprozessereignisse. |
removeAllListeners | Löschen Sie alle Ereignis-Listener. |
getPluginVersion | Rufen Sie die Plugin-Version ab. |
checkPermissions | Überprüfen Sie den aktuellen Berechtigungsstatus für Dateibearbeitungen. Auf Android überprüft dies die externen Speicherberechtigungen. Auf iOS und Web wird immer ‘erteilt’ zurückgegeben, da keine besonderen Berechtigungen erforderlich sind. |
requestPermissions | Berechtigungen für Dateibearbeitungen anfordern. Auf Android werden die externen Speicherberechtigungen erforderlich, um auf Dateien außerhalb der privaten Verzeichnisse des Apps zuzugreifen. Auf iOS und Web wird immer ‘erteilt’ zurückgegeben, da keine besonderen Berechtigungen erforderlich sind. |
Wertebereiche
Abschnitt mit dem Titel „Referenzwerte“Wenden Sie diese Werte an, wenn Sie einen Speicherort auswählen, verschlüsseltes Text schreiben oder Dateifehler behandeln.
Verzeichnisse
Abschnitt mit dem Titel „Verzeichnisse“| Wert | Der Benutzer findet |
|---|---|
DOCUMENTS | Persistente, benutzersichtbare Dokumente. Auf Android entspricht dies dem Verzeichnis der App-Dateien. |
DATA | Persistente private App-Daten. |
LIBRARY | Persistente App-Daten, die nicht benutzersichtbar sind. Auf Android entspricht dies dem Verzeichnis der App-Dateien. |
CACHE | Temporäre Cache-Daten, die das Betriebssystem löschen kann. |
EXTERNAL | Android-externe Speicherwurzel, wie ein SD-Karte oder ein gemeinsam genutzter externer Speicher. |
EXTERNAL_STORAGE | Android-externe Speicherdatenverzeichnis. |
APPLICATION | Leserechtliche Anwendungsdatei oder Assets-Verzeichnis. |
Codierungen
Abschnitt mit dem Titel „Codierungen“| Wert | Verwenden |
|---|---|
utf8 | UTF-8-Text. |
ascii | ASCII-Text. |
utf16 | UTF-16-Text. |
Fehlercodes für Dateien
Abschnitt mit dem Titel „Fehlercodes für Dateien“| 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 | Der Werttyp entspricht nicht dem erwarteten Typ. |
PATH_EXISTS_ERR | 12 | Zielpfad existiert bereits. |
Quelle der Wahrheit
Abschnitt mit dem Titel „Quelle der Wahrheit“Diese Referenz wird von src/definitions.ts in capacitor-Datei.
Weitergehen von @capgo/capacitor-Datei
Abschnitt mit dem Titel „Weitergehen von @capgo/capacitor-Datei“Wenn Sie Storage und Dateihandling mit @capgo/capacitor-Datei planen, verbinden Sie sie mit Mit @capgo/capacitor-Datei für die native Fähigkeit in @capgo/capacitor-Datei @capgo/capacitor-Daten-Speicher-SQLite für die Implementierungsdetail 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 Implementierungsdetail in @capgo/capacitor-Uploader und Mit @capgo/capacitor-Uploader für die native Fähigkeit in Mit @capgo/capacitor-Uploader