Dieses Plugin implementiert eine File-API, die Lese-/Schreibzugriff Zugriff auf Dateien, die auf dem Gerät befinden.
Dieses Plugin basiert auf mehrere Angaben, einschließlich: die HTML5-File-API http://www.w3.org/TR/FileAPI/
Die (heute nicht mehr existierenden) Verzeichnisse und System neuesten Erweiterungen: http://www.w3.org/TR/2012/WD-file-system-api-20120417/ , obwohl die meisten von den Plugin-Code wurde geschrieben, als eine frühere Spec aktuell waren: http://www.w3.org/TR/2011/WD-file-system-api-20110419/
Es implementiert auch die FileWriter Spec: http://dev.w3.org/2009/dap/file-system/file-writer.html
Verwendung finden Sie in HTML5 Rocks ausgezeichnete Dateisystem Artikel.
Finden Sie einen Überblick über andere Speicheroptionen Cordovas Speicher-Führer.
Dieses Plugin wird global cordova.file
-Objekt definiert.
Obwohl im globalen Gültigkeitsbereich, steht es nicht bis nach dem deviceready
-Ereignis.
document.addEventListener("deviceready", onDeviceReady, false);
function onDeviceReady() {
console.log(cordova.file);
}
cordova plugin add cordova-plugin-file
* These platforms do not support FileReader.readAsArrayBuffer
nor FileWriter.write(blob)
.
Stand: V1 werden URLs auf wichtige Datei-System-Verzeichnisse zur Verfügung gestellt. Jede URL in der Form file:///path/to/spot/ ist, und ein DirectoryEntry
mit window.resolveLocalFileSystemURL()
konvertiert werden können.
cordova.file.applicationDirectory
-Die schreibgeschützten Verzeichnis, in dem die Anwendung installiert ist. (iOS, Android, BlackBerry 10)
cordova.file.applicationStorageDirectory
-Root-Verzeichnis der Anwendungs-Sandbox; auf iOS ist schreibgeschützt (aber bestimmte Unterverzeichnisse [wie /Documents
] sind Lese-und Schreibzugriff). Alle enthaltene Daten ist für die app privat. ( iOS, Android, BlackBerry 10)
cordova.file.dataDirectory
-Beständige und private Datenspeicherung innerhalb der Anwendungs-Sandbox, die mit internen Speicher (auf Android, externen Speicher verwenden, verwenden Sie .externalDataDirectory
). Auf iOS, ist dieses Verzeichnis nicht mit iCloud synchronisiert (verwenden Sie .syncedDataDirectory
). (iOS, Android, BlackBerry 10)
cordova.file.cacheDirectory
-Verzeichnis der zwischengespeicherten Daten-Dateien oder Dateien, die Ihre app einfach neu erstellen können. Das Betriebssystem kann diese Dateien löschen, wenn das Gerät auf Speicher knapp wird, dennoch sollten die apps vom Betriebssystem zum Löschen von Dateien hier nicht verlassen. (iOS, Android, BlackBerry 10)
cordova.file.externalApplicationStorageDirectory
-Anwendungsraum auf externen Speicher. (Android)
cordova.file.externalDataDirectory
-Wo, app-spezifische Datendateien auf externen Speicher setzen. (Android)
cordova.file.externalCacheDirectory
-Anwendungscache auf externen Speicher. (Android)
cordova.file.externalRootDirectory
-Externer Speicher (SD-Karte) Stamm. (Android, BlackBerry 10)
cordova.file.tempDirectory
-Temp-Verzeichnis, dem das OS auf deaktivieren können wird. Verlassen Sie sich nicht auf das Betriebssystem, um dieses Verzeichnis zu löschen; Ihre Anwendung sollte immer Dateien gegebenenfalls entfernen. (iOS)
cordova.file.syncedDataDirectory
-Hält app-spezifische Dateien, die (z. B. auf iCloud) synchronisiert werden sollten. (iOS)
cordova.file.documentsDirectory
-Dateien für die app, aber privat sind sinnvoll, andere Anwendungen (z.B. Office-Dateien). (iOS)
cordova.file.sharedDirectory
-Dateien für alle Anwendungen (BlackBerry 10 weltweit verfügbar)
Obwohl technisch ein Implementierungsdetail, kann es sehr hilfreich zu wissen, wie die cordova.file.*
-Eigenschaften physikalische Pfade auf einem echten Gerät zugeordnet sein.
Gerätepfad | Cordova.file.* |
iosExtraFileSystems |
R/w? | persistent? | OS löscht | Sync | Private |
---|---|---|---|---|---|---|---|
/ Var/mobile/Applications/< UUID > / |
applicationStorageDirectory | - | r | N/A | N/A | N/A | Ja |
appname.app/ |
applicationDirectory | Bundle | r | N/A | N/A | N/A | Ja |
www/ |
- | - | r | N/A | N/A | N/A | Ja |
Documents/ |
documentsDirectory | Dokumente | R/w | Ja | Nein | Ja | Ja |
NoCloud/ |
- | Dokumente-nosync | R/w | Ja | Nein | Nein | Ja |
Library |
- | Bibliothek | R/w | Ja | Nein | Ja? | Ja |
NoCloud/ |
dataDirectory | Bibliothek-nosync | R/w | Ja | Nein | Nein | Ja |
Cloud/ |
syncedDataDirectory | - | R/w | Ja | Nein | Ja | Ja |
Caches/ |
cacheDirectory | Cache | R/w | Ja * | Ja*** | Nein | Ja |
tmp/ |
tempDirectory | - | R/w | Nein** | Ja*** | Nein | Ja |
\ * Dateien über app-Neustarts und Upgrades beibehalten, aber dieses Verzeichnis kann gelöscht werden, wenn das OS begehrt. Ihre Anwendung sollte in der Lage, alle Inhalte neu zu erstellen, die gelöscht werden können.
** -Dateien kann über app-Neustarts beizubehalten, aber verlasse dich nicht auf dieses Verhalten. Dateien sind nicht unbedingt Aktuelles beibehalten. Ihre Anwendung sollte Dateien aus diesem Verzeichnis entfernen, wenn es gilt, diese Dateien werden entfernt, da das OS nicht wann (oder auch wenn) garantiert.
**\ * The OS kann den Inhalt dieses Verzeichnisses löschen, wann immer es sich anfühlt, ist es erforderlich, aber verlassen Sie sich nicht dazu. Sie sollten dieses Verzeichnis entsprechend Ihrer Anwendung deaktivieren.
Gerätepfad | Cordova.file.* |
AndroidExtraFileSystems |
R/w? | persistent? | OS löscht | Private |
---|---|---|---|---|---|---|
file:///android_asset/ |
applicationDirectory | r | N/A | N/A | Ja | |
/ Data/Data/< app-Id > / |
applicationStorageDirectory | - | R/w | N/A | N/A | Ja |
cache |
cacheDirectory | Cache | R/w | Ja | Ja* | Ja |
files |
dataDirectory | Dateien | R/w | Ja | Nein | Ja |
Documents |
Dokumente | R/w | Ja | Nein | Ja | |
< Sdcard > / |
externalRootDirectory | sdcard | R/w | Ja | Nein | Nein |
Android/data/<app-id>/ |
externalApplicationStorageDirectory | - | R/w | Ja | Nein | Nein |
cache |
externalCacheDirectry | Cache-extern | R/w | Ja | Nein** | Nein |
files |
externalDataDirectory | Dateien-extern | R/w | Ja | Nein | Nein |
\ * OS kann regelmäßig dieses Verzeichnis zu löschen, aber verlasse dich nicht auf dieses Verhalten. Deaktivieren Sie den Inhalt dieses Verzeichnisses für Ihre Anwendung geeigneten. Ein Benutzer den Cache manuell löschen sollte, werden die Inhalte dieses Verzeichnisses entfernt.
** Der OS nicht klar dieses Verzeichnis automatisch; Sie sind verantwortlich für die Inhalte selbst verwalten. Der Benutzer den Cache manuell löschen sollte, werden der Inhalt des Verzeichnisses entfernt.
Hinweis: Wenn externe Speichergeräte nicht bereitgestellt werden kann, sind die cordova.file.external*
Eigenschaften null
.
Gerätepfad | Cordova.file.* |
R/w? | persistent? | OS löscht | Private |
---|---|---|---|---|---|
file:///Accounts/1000/APPDATA/ < app Id > / |
applicationStorageDirectory | r | N/A | N/A | Ja |
app/native |
applicationDirectory | r | N/A | N/A | Ja |
data/webviews/webfs/temporary/local__0 |
cacheDirectory | R/w | Nein | Ja | Ja |
data/webviews/webfs/persistent/local__0 |
dataDirectory | R/w | Ja | Nein | Ja |
file:///Accounts/1000/Removable/sdcard |
externalRemovableDirectory | R/w | Ja | Nein | Nein |
file:///Accounts/1000/Shared |
sharedDirectory | R/w | Ja | Nein | Nein |
Hinweis: Wenn die Anwendung bereitgestellt wird, um Perimeter zu arbeiten, alle Pfade sind relativ /accounts/1000-enterprise.
Es gibt mehrere gültige Speicherorte, persistente Dateien auf einem Android-Gerät zu speichern. Finden Sie auf dieser Seite eine ausführliche Diskussion über die verschiedenen Möglichkeiten.
Frühere Versionen des Plugins wählen würde, den Speicherort der temporären und permanenten Dateien beim Start, basierend auf, ob das Gerät behauptete, dass die SD-Karte (oder gleichwertige Speicherpartition) bereitgestellt wurde. Wenn die SD-Karte eingelegt wurde, oder wenn eine große interne Speicherpartition verfügbar war (wie auf Nexus-Geräten) und dann in die Wurzel dieses Raumes, die persistenten Dateien gespeichert werden. Dies bedeutete, dass alle Cordova apps aller verfügbaren Dateien auf der Karte sehen konnte.
Wenn die SD-Karte nicht verfügbar war, dann Vorgängerversionen Daten unter speichern würde /data/data/<packageId>
, die isoliert Anwendungen voneinander, aber möglicherweise noch Ursache Daten zwischen Benutzern freigegeben werden.
Es ist jetzt möglich, ob Sie Dateien der internen Datei-Speicherort oder unter Verwendung der bisherigen Logik, mit einer Präferenz in der Anwendung-config.xml
-Datei speichern möchten. Hierzu fügen Sie eine dieser zwei Zeilen zu "config.xml"
:
<preference name="AndroidPersistentFileLocation" value="Internal" />
<preference name="AndroidPersistentFileLocation" value="Compatibility" />
Ohne diese Zeile wird das Datei Plugin Compatibility
als Standard verwenden. Wenn ein Präferenz-Tag vorhanden ist, und nicht einen der folgenden Werte, wird die Anwendung nicht gestartet.
Wenn Ihre Anwendung für Benutzer zuvor versandt wird, mithilfe eines älteren (Pre-1.0) Version dieses Plugins und gespeicherte Dateien im permanenten Dateisystem hat, dann sollten Sie die Einstellung zur Compatibility
einstellen. Wechseln die Location auf "Internal" würde bedeuten, dass Benutzer, die aktualisieren Sie ihre Anwendung, möglicherweise nicht auf ihre zuvor gespeicherte Dateien, abhängig von ihrem Gerät zugreifen.
Wenn Ihre Anwendung neu ist, oder nie zuvor Dateien im Dateisystem persistent gespeichert hat, wird die Internal
Einstellung in der Regel empfohlen.
Auflisten von Verzeichnissen Vermögenswert ist wirklich langsam auf Android. Sie können beschleunigen, es oben aber durch src/android/build-extras.gradle
in das Stammverzeichnis von Ihrem android Projekt hinzufügen (erfordert auch cordova-android@4.0.0 oder größer).
cordova.file.applicationStorageDirectory
ist schreibgeschützt; zum Speichern von Dateien im Stammverzeichnis der Versuch schlägt fehl. Verwenden Sie eine der anderen cordova.file.*
für iOS definierten Eigenschaften (nur applicationDirectory
und applicationStorageDirectory
sind schreibgeschützt).FileReader.readAsText(blob, encoding)
encoding
Parameter wird nicht unterstützt und UTF-8-Kodierung ist immer wirksam.Es gibt zwei gültige Speicherorte persistente Dateien auf ein iOS-Gerät speichern: das Dokumenten-Verzeichnis und das Verzeichnis Library. Frühere Versionen des Plugins gespeichert immer nur persistente Dateien im Verzeichnis Dokumente. Dies hatte den Nebeneffekt einer Anwendung Dateien in iTunes, die oft unbeabsichtigte, speziell für Anwendungen, die viele kleine Dateien behandeln war, sichtbar zu machen, anstatt komplette Dokumente für den Export, die den beabsichtigten Zweck des Verzeichnisses ist zu produzieren.
Es ist jetzt möglich, ob Sie Dateien in Dokumente oder Verzeichnis Library mit einer Präferenz in der Anwendung-config.xml
-Datei speichern möchten. Hierzu fügen Sie eine dieser zwei Zeilen zu "config.xml"
:
<preference name="iosPersistentFileLocation" value="Library" />
<preference name="iosPersistentFileLocation" value="Compatibility" />
Ohne diese Zeile wird das Datei Plugin Compatibility
als Standard verwenden. Wenn ein Präferenz-Tag vorhanden ist, und nicht einen der folgenden Werte, wird die Anwendung nicht gestartet.
Wenn Ihre Anwendung für Benutzer zuvor versandt wird, mithilfe eines älteren (Pre-1.0) Version dieses Plugins und gespeicherte Dateien im permanenten Dateisystem hat, dann sollten Sie die Einstellung zur Compatibility
einstellen. Standort zur Library
wechseln würde bedeuten, dass Benutzer, die ihre Anwendung aktualisieren nicht in der Lage wäre, ihre zuvor gespeicherte Dateien zugreifen.
Wenn die Anwendung neu, oder nie zuvor Dateien im Dateisystem persistent gespeichert hat, wird die Einstellung der Library
allgemein empfohlen.
Der Datei-System-API wird von Firefox-OS nicht nativ unterstützt und wird als ein Shim auf IndexedDB implementiert.
copyTo
und moveTo
unterstützen keine VerzeichnisseDie folgenden Datenpfade werden unterstützt: * applicationDirectory
- xhr
verwendet, um lokale Dateien erhalten, die mit der app verpackt sind. *dataDirectory
- für persistente app-spezifische Daten-Dateien. *cacheDirectory
- Cache-Dateien, die app startet überleben sollte (Apps sollten nicht vom Betriebssystem zum Löschen von Dateien hier verlassen).
fs.root.getDirectory ("dir1/Ordner2 ', {create:true}, SuccessCallback, ErrorCallback)
schlägt fehl, wenn dir1 nicht existierte.Cdvfile://localhost
(lokale Ressourcen) nur. D.h. externe Ressourcen nicht über Cdvfile
unterstützt.close
-Funktion wird nicht unterstützt.FileSaver
und BlobBuilder
werden von diesem Plugin nicht unterstützt und müssen nicht geboren.RequestAllFileSystems
. Diese Funktion fehlt auch in den Spezifikationen.create: true
Flag für vorhandenes Verzeichnis.readAsDataURL
-Funktion wird unterstützt, aber die Mediatype in Chrom hängt von der Eintrag Namenerweiterung, Mediatype im IE immer leer ist (das ist dasselbe wie Text-Plain
gemäß der Spezifikation), Mediatype in Firefox ist immer Application/Octet-Stream
. Beispielsweise, wenn der Inhalt Abcdefg
gibt dann Firefox Daten: Anwendung / Octet-Stream; base64, YWJjZGVmZw ==
, IE gibt Daten:; base64, YWJjZGVmZw ==
, Chrom gibt Daten: < Mediatype je nach Erweiterung des Eintragsnamens >; base64, YWJjZGVmZw ==
.ToInternalURL
gibt den Pfad zurück, in der Form file:///persistent/path/to/entry
(Firefox, IE). Chrom gibt den Pfad zurück, in der Form cdvfile://localhost/persistent/file
.FilePluginIsReady
-Ereignis abonnieren. Beispiel:window.addEventListener('filePluginIsReady', function(){ console.log('File plugin is ready');}, false);
Window.isFilePluginReadyRaised
-Funktion können Sie überprüfen, ob Ereignis bereits ausgelöst wurde. -window.requestFileSystem temporär und PERSISTENTE Dateisystem-Quoten sind nicht begrenzt, in Chrom. -Um die dauerhafte Speicherung in Chrom zu erhöhen benötigen Sie window.initPersistentFileSystem
-Methode aufrufen. Permanenter Speicherkontingent beträgt 5 MB standardmäßig. -Chrome erforderlich --erlauben-Datei-Zugriff-aus-Files
Argument an den Support API via file:///
Protokoll führen. -Datei
-Objekt wird nicht geändert werden, wenn Sie Flag verwenden {create:true}
als einen vorhandenen Eintrag
zu erhalten. -Veranstaltungen cancelable
-Eigenschaft festgelegt ist in Chrom wahr. Dies widerspricht der Spezifikation. -toURL
-Funktion in Chrome zurück Dateisystem:
-Pfad je nach Anwendungshost vorangestellt. Z. B. filesystem:file:///persistent/somefile.txt
, Filesystem:http://localhost:8080/persistent/somefile.txt
. -toURL
Funktionsergebnis enthält keine nachgestellten Schrägstrich bei Verzeichniseintrag. Chrom löst Verzeichnisse mit Schrägstrich-gezogene Urls aber korrekt. -ResolveLocalFileSystemURL
-Methode erfordert die eingehenden Url
Dateisystem
Präfix haben. Beispielsweise sollte die Url
-Parameter für ResolveLocalFileSystemURL
in der Form filesystem:file:///persistent/somefile.txt
im Gegensatz zu der Form file:///persistent/somefile.txt
in Android. -Veraltete ToNativeURL
-Funktion wird nicht unterstützt und muss keinen Stub. -SetMetadata
-Funktion ist nicht in den Spezifikationen angegeben und nicht unterstützt. -INVALID_MODIFICATION_ERR (Code: 9) wird ausgelöst, statt SYNTAX_ERR(code: 8) auf anfordern des Dateisystems nicht existent. -INVALID_MODIFICATION_ERR (Code: 9) wird ausgelöst, anstatt PATH_EXISTS_ERR(code: 12) zu versuchen, die ausschließlich eine Datei oder ein Verzeichnis zu erstellen, die bereits vorhanden ist. -INVALID_MODIFICATION_ERR (Code: 9) wird ausgelöst, anstatt NO_MODIFICATION_ALLOWED_ERR(code: 6) zu versuchen, rufen Sie RemoveRecursively auf das Root-Dateisystem. -INVALID_MODIFICATION_ERR (Code: 9) wird ausgelöst, anstatt NOT_FOUND_ERR(code: 1) zu versuchen, MoveTo-Verzeichnis, das nicht vorhanden ist.
.
und .
werden nicht unterstützt.file:///
-Modus; nur der Modus für gehostete ist unterstützten (Http://localhost:xxxx).Size
-Parameter für RequestFileSystem
Funktion wirkt also nicht Dateisystem in Firefox und IE.ReadAsBinaryString
Funktion heißt es nicht in die Angaben und in IE nicht unterstützt und muss keinen Stub.file.Type
ist immer null.SetMetadata
-Funktion, die nicht in den Specs genannt unterstützt Feldänderung nur ModificationTime
.CopyTo
und MoveTo
-Funktionen unterstützen keine Verzeichnisse.abort
und truncate
-Funktionen werden nicht unterstützt.writer.onprogress = function() { /*commands*/ };
In v1.0.0 dieses Plugins haben die FileEntry
und DirectoryEntry
Strukturen geändert, um mehr im Einklang mit der veröffentlichten Spezifikation sein.
Vorgängerversionen (Pre-1.0.0) des Plugins den Gerät-Absolute-Dateispeicherort in der Eigenschaft fullPath
Entry
Objekte gespeichert. Diese Pfade würde in der Regel aussehen
/var/mobile/Applications/<application UUID>/Documents/path/to/file (iOS)
/storage/emulated/0/path/to/file (Android)
Diese Pfade wurden auch von der toURL()
-Methode der Entry
Objekte zurückgegeben.
Mit v1.0.0 ist das fullPath
-Attribut den Pfad zu der Datei, relativ zum Stammverzeichnis des Dateisystems HTML. Also, würde die oben genannten Wege jetzt beide durch ein FileEntry
-Objekt mit einem fullPath
von dargestellt werden
/path/to/file
Wenn Ihre Anwendung mit absoluter Gerätepfade arbeitet und Sie zuvor diese Pfade durch die Eigenschaft fullPath
Entry
Objekte abgerufen, sollten dann Sie den Code, um stattdessen entry.toURL()
verwenden aktualisieren.
Für rückwärts Kompatibilität, die resolveLocalFileSystemURL()
-Methode wird einen Absolute-Gerätepfad zu akzeptieren und kehrt ein Entry
-Objekt entspricht, solange diese Datei in den TEMPORARY
oder PERSISTENT
Dateisysteme existiert.
Dies wurde vor allem ein Problem mit dem File-Transfer-Plugin, die zuvor-Absolute-Gerätepfade verwendet (und kann damit noch einverstanden). Es wurde überarbeitet, um mit Dateisystem-URLs korrekt zu arbeiten, damit ersetzen entry.fullPath
mit entry.toURL()
immer das Plugin zum Arbeiten mit Dateien auf dem Gerät Probleme lösen sollte.
In v1.1.0 wurde der Rückgabewert von toURL()
(siehe [CB-6394] (https://issues.apache.org/jira/browse/CB-6394)) geändert, um eine absolute "file://" URL zurückgeben. wo immer möglich. Sicherstellung einer ' Cdvfile:'-URL können Sie an toInternalURL()
. Diese Methode gibt jetzt Dateisystem URLs der Form zurück.
cdvfile://localhost/persistent/path/to/file
die benutzt werden können, um die Datei eindeutig zu identifizieren.
Wenn ein Fehler ausgelöst wird, wird eines der folgenden Codes verwendet werden.
Code | Konstante |
---|---|
1 | NOT_FOUND_ERR |
2 | SECURITY_ERR |
3 | ABORT_ERR |
4 | NOT_READABLE_ERR |
5 | ENCODING_ERR |
6 | NO_MODIFICATION_ALLOWED_ERR |
7 | INVALID_STATE_ERR |
8 | SYNTAX_ERR |
9 | INVALID_MODIFICATION_ERR |
10 | QUOTA_EXCEEDED_ERR |
11 | TYPE_MISMATCH_ERR |
12 | PATH_EXISTS_ERR |
Die Menge der verfügbaren Dateisysteme kann pro Plattform konfiguriert sein. Erkennen von iOS und Android ein Tag in "config.xml"
die Namen der Dateisysteme installiert werden. Standardmäßig sind alle Datei-System-Roots aktiviert.
<preference name="iosExtraFilesystems" value="library,library-nosync,documents,documents-nosync,cache,bundle,root" />
<preference name="AndroidExtraFilesystems" value="files,files-external,documents,sdcard,cache,cache-external,root" />
files
: interne Datei-Speicher-Verzeichnis der Anwendungfiles-external
: Verzeichnis der Anwendung externe Datei Speichersdcard
: das externe Globaldatei-Speicherverzeichnis (Dies ist die Wurzel der SD-Karte, sofern installiert). Sie benötigen die Berechtigung zur Verwendung dieses android.permission.WRITE_EXTERNAL_STORAGE
.cache
: internen Cache-Verzeichnis der Anwendungcache-external
: externer Cache-Verzeichnis der Anwendungroot
: das gesamte Gerät-DateisystemAndroid unterstützt auch eine spezielle Dateisystem mit dem Namen "documents", die ein Unterverzeichnis "/Documents/" die "files" Dateisystem darstellt.
library
: Bibliothek-Verzeichnis der Anwendungdocuments
: Dokumente-Verzeichnis der Anwendungcache
: Cache-Verzeichnis der Anwendungbundle
: die Anwendung Bündel; den Speicherort der die app selbst auf dem Datenträger (schreibgeschützt)root
: das gesamte Gerät-DateisystemStandardmäßig können die Bibliothek und Dokumenten-Verzeichnisse mit iCloud synchronisiert werden. Sie können auch verlangen, zwei zusätzliche Dateisysteme, library-nosync
und documents-nosync
, die einem speziellen nicht synchronisierten Verzeichnis innerhalb darstellen der /Library
oder /Documents
-Dateisystem.