Ten plugin implementuje API pliku, dzięki czemu dostęp do odczytu i zapisu do plików znajdujących się na urządzeniu.
Ten plugin jest oparty na kilka specyfikacje, w tym: HTML5 File API http://www.w3.org/TR/FileAPI/
Katalogi (nieistniejącego już) i System Najnowsze rozszerzenia: http://www.w3.org/TR/2012/WD-file-system-api-20120417/ , chociaż większość z ten plugin kod został napisany podczas wcześniejszych specyfikacji były aktualne: http://www.w3.org/TR/2011/WD-file-system-api-20110419/
To również implementuje specyfikację FileWriter: http://dev.w3.org/2009/dap/file-system/file-writer.html
Wykorzystania, prosimy odnieść się do skały HTML5 doskonałe plików art.
Omówienie innych opcji przechowywania odnoszą się do Cordova z magazynu przewodnik.
Ten plugin określa globalne cordova.file
obiektu.
Chociaż w globalnym zasięgu, to nie dostępne dopiero po deviceready
imprezie.
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)
.
Od v1.2.0 znajdują się adresy URL do katalogów ważne systemu plików. Każdy adres URL jest w formie file:///path/to/spot/ i mogą być konwertowane na DirectoryEntry
za pomocą window.resolveLocalFileSystemURL()
.
cordova.file.applicationDirectory
-Tylko do odczytu katalogu gdzie jest zainstalowana aplikacja. (iOS, Android, BlackBerry 10)
cordova.file.applicationStorageDirectory
-Katalogu obszaru izolowanego aplikacji; na iOS to miejsce jest tylko do odczytu (ale podkatalogów określonego [jak /Documents
] są odczytu i zapisu). Wszystkie dane zawarte w jest prywatną do aplikacji. ( iOS, Android, BlackBerry 10)
cordova.file.dataDirectory
-Trwałe i prywatne dane magazynowanie w izolowanym aplikacji przy użyciu pamięci wewnętrznej (na Android, jeśli trzeba użyć zewnętrznej pamięci, należy użyć .externalDataDirectory
). Na iOS, Katalog ten nie jest zsynchronizowane z iCloud (za pomocą .syncedDataDirectory
). (iOS, Android, BlackBerry 10)
cordova.file.cacheDirectory
-Katalog dla plików buforowanych danych lub pliki, które aplikacji ponownie można łatwo tworzyć. System operacyjny może usunąć te pliki, gdy urządzenie działa niski na przechowywanie, niemniej jednak aplikacje nie powinny polegać na OS, aby usunąć pliki tutaj. (iOS, Android, BlackBerry 10)
cordova.file.externalApplicationStorageDirectory
-Stosowania przestrzeni na zewnętrznej pamięci masowej. (Android)
cordova.file.externalDataDirectory
-Gdzie umieścić pliki danych specyficznych dla aplikacji na zewnętrznej pamięci masowej. (Android)
cordova.file.externalCacheDirectory
-Pamięci podręcznej aplikacji na zewnętrznej pamięci masowej. (Android)
cordova.file.externalRootDirectory
-Korzeń zewnętrznej pamięci masowej (karty SD). (Android, BlackBerry 10)
cordova.file.tempDirectory
-Temp katalogu systemu operacyjnego można wyczyścić w będzie. Nie należy polegać na OS wobec usunąć ten katalog; aplikacji należy zawsze usunąć pliki jako obowiązujące. (iOS)
cordova.file.syncedDataDirectory
-Posiada pliki specyficzne dla aplikacji, które powinny być zsynchronizowane (np. do iCloud). (iOS)
cordova.file.documentsDirectory
-Pliki prywatne do aplikacji, ale że mają znaczenie dla innych aplikacji (np. plików pakietu Office). (iOS)
cordova.file.sharedDirectory
-Pliki dostępne na całym świecie do wszystkich aplikacji (BlackBerry 10)
Chociaż technicznie implementacyjnym, może być bardzo przydatne wiedzieć, jak cordova.file.*
właściwości mapy fizycznej ścieżki na prawdziwe urządzenie.
Ścieżka urządzenia | Cordova.File.* |
iosExtraFileSystems |
r/w? | trwałe? | Czyści OS | Synchronizacja | prywatne |
---|---|---|---|---|---|---|---|
/ var/mobile/Applications/< UUID > / |
applicationStorageDirectory | - | r | N/D! | N/D! | N/D! | Tak |
appname.app/ |
applicationDirectory | pakiet | r | N/D! | N/D! | N/D! | Tak |
www/ |
- | - | r | N/D! | N/D! | N/D! | Tak |
Documents/ |
documentsDirectory | dokumenty | r/w | Tak | Nr | Tak | Tak |
NoCloud/ |
- | dokumenty nosync | r/w | Tak | Nr | Nr | Tak |
Library |
- | Biblioteka | r/w | Tak | Nr | Tak? | Tak |
NoCloud/ |
dataDirectory | Biblioteka nosync | r/w | Tak | Nr | Nr | Tak |
Cloud/ |
syncedDataDirectory | - | r/w | Tak | Nr | Tak | Tak |
Caches/ |
cacheDirectory | pamięci podręcznej | r/w | Tak * | Yes*** | Nr | Tak |
tmp/ |
tempDirectory | - | r/w | No** | Yes*** | Nr | Tak |
\ * Pliki utrzymywały aplikacja zostanie ponownie uruchomiony i uaktualnienia, ale w tym katalogu mogą być rozliczone przy każdym OS pragnień. Aplikacji należy umożliwić odtworzenie treści, które mogą być usunięte.
** Plików może utrzymywać się po ponownym uruchomieniu aplikacji, ale nie opierają się na tym zachowaniu. Pliki nie są gwarantowane w aktualizacji. Aplikacji należy usunąć pliki z tego katalogu, gdy ma to zastosowanie, ponieważ system operacyjny nie gwarantuje Kiedy (lub nawet jeśli) te pliki zostaną usunięte.
**\ * System operacyjny może wyczyścić zawartość tego katalogu, gdy czuje, że jest to konieczne, ale nie powoływać się na to. Należy wyczyścić ten katalog jako odpowiednie dla aplikacji.
Ścieżka urządzenia | Cordova.File.* |
AndroidExtraFileSystems |
r/w? | trwałe? | Czyści OS | prywatne |
---|---|---|---|---|---|---|
file:///android_asset/ |
applicationDirectory | r | N/D! | N/D! | Tak | |
/Data/danych/< Aplikacja id > / |
applicationStorageDirectory | - | r/w | N/D! | N/D! | Tak |
cache |
cacheDirectory | pamięci podręcznej | r/w | Tak | Yes\ * | Tak |
files |
dataDirectory | pliki | r/w | Tak | Nr | Tak |
Documents |
dokumenty | r/w | Tak | Nr | Tak | |
< sdcard > / |
externalRootDirectory | sdcard | r/w | Tak | Nr | Nr |
Android/data/<app-id>/ |
externalApplicationStorageDirectory | - | r/w | Tak | Nr | Nr |
cache |
externalCacheDirectry | zewnętrznych pamięci podręcznej | r/w | Tak | No** | Nr |
files |
externalDataDirectory | zewnętrznych plików | r/w | Tak | Nr | Nr |
\ * OS może okresowo usunąć ten katalog, ale nie opierają się na tym zachowaniu. Wyczyść zawartość tego katalogu jako odpowiednie dla danej aplikacji. Należy użytkownik przeczyścić pamięć podręczną ręcznie, zawartość w tym katalogu są usuwane.
** OS nie usunąć ten katalog automatycznie; Jesteś odpowiedzialny za zarządzanie zawartość siebie. Należy użytkownik przeczyścić pamięć podręczną ręcznie, zawartość katalogu są usuwane.
Uwaga: Jeśli nie mogą być montowane pamięci masowej, właściwości cordova.file.external*
są wartości null
.
Ścieżka urządzenia | Cordova.File.* |
r/w? | trwałe? | Czyści OS | prywatne |
---|---|---|---|---|---|
file:///accounts/1000/AppData/ < id aplikacji > / |
applicationStorageDirectory | r | N/D! | N/D! | Tak |
app/native |
applicationDirectory | r | N/D! | N/D! | Tak |
data/webviews/webfs/temporary/local__0 |
cacheDirectory | r/w | Nr | Tak | Tak |
data/webviews/webfs/persistent/local__0 |
dataDirectory | r/w | Tak | Nr | Tak |
file:///accounts/1000/Removable/sdcard |
externalRemovableDirectory | r/w | Tak | Nr | Nr |
file:///accounts/1000/Shared |
sharedDirectory | r/w | Tak | Nr | Nr |
Uwaga: gdy aplikacja jest rozmieszczana do pracy obwodu, wszystkie ścieżki są względne do /accounts/1000-enterprise.
Istnieje wiele prawidłowe lokalizacje do przechowywania trwałych plików na telefonie z systemem Android. Zobacz tę stronę do szerokiej dyskusji o różnych możliwościach.
Poprzednie wersje pluginu wybrać lokalizację plików tymczasowych i trwałe podczas uruchamiania, czy urządzenie twierdził, że karta SD (lub równoważne magazynowanie podzia³) był montowany w oparciu. Czy karta SD została zamontowana, czy duży wewnętrzny magazynowanie podzia³ był dostępny (takie jak na Nexus urządzenia,) a następnie trwałe pliki będą przechowywane w katalogu głównego tego miejsca. Oznaczało to, że wszystkie aplikacje Cordova może Zobacz wszystkie pliki dostępne na karcie.
Jeśli karta SD nie był dostępny, a następnie poprzednie wersje będzie przechowywać dane w /data/data/<packageId>
, która izoluje aplikacje od siebie, ale nadal może spowodować danych, które mają być współużytkowane przez użytkowników.
Teraz jest możliwe, aby zdecydować, czy do przechowywania plików w lokalizacji magazynu plików, lub przy użyciu poprzednich logiki, z preferencją w aplikacji w pliku config.xml
. Aby to zrobić, Dodaj jedną z tych dwóch linii do pliku config.xml
:
<preference name="AndroidPersistentFileLocation" value="Internal" />
<preference name="AndroidPersistentFileLocation" value="Compatibility" />
Bez tej linii wtyczki pliku będzie używać Compatibility
jako domyślny. Jeśli znacznik preferencji jest obecny i to nie jedną z tych wartości, aplikacja nie zostanie uruchomiona.
Jeśli aplikacja wcześniej zostało wysłane do użytkowników, przy użyciu starszych (pre-1.0) wersję tego pluginu i ma zapisane na dysku pliki w trwałych plików, a następnie należy ustawić preferencje do Compatibility
. Przełączania lokalizacji do "Internal" oznacza, że istniejących użytkowników, którzy ich aplikacja może być niesłabnący wobec dostęp ich wcześniej zapisane pliki, w zależności od ich urządzenie.
Jeśli aplikacja jest nowy, lub ma nigdy wcześniej przechowywane pliki w systemie plików trwałe, ustawienie Internal
generalnie jest zalecane.
Lista katalogów aktywów jest bardzo powolny na Android. Można przyspieszyć to się jednak przez dodanie src/android/build-extras.gradle
do katalogu głównego projektu android (również wymaga cordova-android@4.0.0 lub większej).
cordova.file.applicationStorageDirectory
jest tylko do odczytu; próby przechowywania plików w katalogu głównym zakończy się niepowodzeniem. Użyj jednego z innych cordova.file.*
właściwości zdefiniowane dla iOS (tylko applicationDirectory
i applicationStorageDirectory
są tylko do odczytu).FileReader.readAsText(blob, encoding)
encoding
Parametr nie jest obsługiwana, i kodowanie UTF-8 jest zawsze w efekcie.Istnieją dwa ważne miejsca trwałe pliki na urządzenia iOS: katalogu dokumentów i katalogu biblioteki. Poprzednie wersje pluginu tylko kiedykolwiek przechowywane trwałe pliki w katalogu dokumentów. To miał ten efekt uboczny od rozpoznawalności wszystkie pliki aplikacji w iTunes, który był często niezamierzone, zwłaszcza dla aplikacji, które obsługują wiele małych plików, zamiast produkuje kompletne dokumenty do wywozu, który jest przeznaczenie katalogu.
Teraz jest możliwe, aby zdecydować, czy do przechowywania plików w dokumentach lub katalogu biblioteki, z preferencją w pliku config.xml
aplikacji. Aby to zrobić, Dodaj jedną z tych dwóch linii do pliku config.xml
:
<preference name="iosPersistentFileLocation" value="Library" />
<preference name="iosPersistentFileLocation" value="Compatibility" />
Bez tej linii wtyczki pliku będzie używać Compatibility
jako domyślny. Jeśli znacznik preferencji jest obecny i to nie jedną z tych wartości, aplikacja nie zostanie uruchomiona.
Jeśli aplikacja wcześniej zostało wysłane do użytkowników, przy użyciu starszych (pre-1.0) wersję tego pluginu i ma zapisane na dysku pliki w trwałych plików, a następnie należy ustawić preferencje do Compatibility
. Przełączania lokalizacji do Library
oznaczałoby, że istniejących użytkowników, którzy ich aplikacja będzie niesłabnący wobec dostęp ich wcześniej zapisane pliki.
Jeśli aplikacja jest nowy, lub nigdy wcześniej przechowywane pliki w trwałych plików, ustawień Library
ogólnie jest zalecane.
API systemu plików nie jest obsługiwany macierzyście przez Firefox OS i jest zaimplementowany jako podkładki na indexedDB.
copyTo
i moveTo
nie obsługuje katalogiObsługiwane są następujące ścieżki danych: * applicationDirectory
- używa xhr
, aby uzyskać lokalne pliki, które są pakowane z aplikacji. * dataDirectory
- na trwałe dane specyficzne dla aplikacji pliki. * cacheDirectory
- buforowanych plików, które powinny przetrwać ponowne uruchomienie aplikacji (aplikacje nie powinny polegać na OS, aby usunąć pliki tutaj).
fs.root.getDirectory (' dir1/dir2 ', {create:true}, successCallback, errorCallback)
zakończy się niepowodzeniem, jeśli nie istnieje dir1.cdvfile://localhost
(lokalne zasoby) tylko. Czyli zewnętrznych zasobów nie są obsługiwane przez cdvfile
.close
funkcja nie jest obsługiwana.FileSaver
i BlobBuilder
nie są obsługiwane przez ten plugin i nie ma artykułów.requestAllFileSystems
. Ta funkcja jest również brak w specyfikacji.create: true
flaga dla istniejącego katalogu.readAsDataURL
funkcja jest obsługiwana, ale mediatype w Chrome zależy od wejścia z rozszerzeniem, mediatype w IE zawsze jest pusty (który jest taki sam jak zwykły tekst
według specyfikacji), mediatype w Firefox jest zawsze aplikacji/oktet strumień
. Na przykład, jeśli treść jest abcdefg
Firefox wraca z danych: stosowanie / octet-stream, base64, YWJjZGVmZw ==
, czyli zwraca danych:; base64, YWJjZGVmZw ==
, Chrome zwraca danych: < mediatype w zależności od rozszerzenia nazwy; > base64, YWJjZGVmZw ==
.toInternalURL
zwraca ścieżkę w postaci file:///persistent/path/to/entry
(Firefox, IE). Chrom zwraca ścieżkę w postaci cdvfile://localhost/persistent/file
.filePluginIsReady
. Przykład:window.addEventListener('filePluginIsReady', function(){ console.log('File plugin is ready');}, false);
Funkcja window.isFilePluginReadyRaised
służy do sprawdzenia, czy zdarzenie już została podniesiona. -kwoty plików tymczasowych i trwałe window.requestFileSystem nie są ograniczone w Chrome. -W celu zwiększenia trwałego magazynu w Chrome, należy wywołać metodę window.initPersistentFileSystem
. Domyślnie trwałe dyskowa jest 5 MB. -Chrome wymaga --pozwalają--dostęp z plików
uruchomić argument na poparcie API za pośrednictwem protokołu file:///
. -Plik
obiekt będzie nie zmieniło jeśli flaga {create:true}
gdy już istniejący wpis
. -wydarzenia zwrotu
właściwość jest zestaw true w Chrome. Jest to sprzeczne ze specyfikacji. -Funkcja toURL
w Chrome zwraca plików:
-poprzedzona ścieżką w zależności od aplikacji hosta. Na przykład, filesystem:file:///persistent/somefile.txt
, filesystem:http://localhost:8080/persistent/somefile.txt
. -wynik funkcji toURL
nie zawierają ukośnika w wpis w katalogu. Chrom usuwa katalogi z ciąć doczepiane adresów URL poprawnie choć. -Metoda resolveLocalFileSystemURL
wymaga przychodzących url
mają prefiks plików
. Na przykład parametr adresu url
do resolveLocalFileSystemURL
powinny być w formie filesystem:file:///persistent/somefile.txt
, w przeciwieństwie do formularza file:///persistent/somefile.txt
w Android. -Przestarzałe toNativeURL
funkcja nie jest obsługiwana i nie tylko. -Funkcja setMetadata
jest nie podane w specyfikacji i nie jest obsługiwane. -INVALID_MODIFICATION_ERR (kod: 9) jest generowany zamiast SYNTAX_ERR(code: 8) na żądanie nieistniejącą plików. -INVALID_MODIFICATION_ERR (kod: 9) jest generowany zamiast PATH_EXISTS_ERR(code: 12) próbuje stworzyć wyłącznie pliku lub katalogu, który już istnieje. -INVALID_MODIFICATION_ERR (kod: 9) jest generowany zamiast NO_MODIFICATION_ALLOWED_ERR(code: 6) na próby wywołania removeRecursively w głównym systemie plików. -INVALID_MODIFICATION_ERR (kod: 9) jest generowany zamiast NOT_FOUND_ERR(code: 1) na trudny do katalogu moveTo, który nie istnieje.
.
i .
nie są obsługiwane.file:///
-tryb; tylko obsługiwane tryb jest obsługiwany (http://localhost:xxxx).rozmiar
parametru funkcja requestFileSystem
nie wpływa na system plików Firefox i IE.readAsBinaryString
funkcja nie jest określona w specyfikacji i nie obsługiwane w IE i nie tylko.File.Type
ma zawsze wartość null.setMetadata
, która nie jest określona w specyfikacji obsługuje tylko zmian pola modificationTime
.copyTo
i moveTo
funkcji nie obsługuje katalogi.abort
i truncate
funkcje nie są obsługiwane.writer.onprogress = function() { /*commands*/ };
W v1.0.0 tego pluginu struktury FileEntry
i DirectoryEntry
zmieniły się więcej zgodnie z opublikowaną specyfikacją.
Poprzednie wersje (pre-1.0.0) plugin przechowywane urządzenia bezwzględna plik lokalizacja we właściwości fullPath
wpis
obiektów. Te ścieżki zazwyczaj będzie wyglądać
/var/mobile/Applications/<application UUID>/Documents/path/to/file (iOS)
/storage/emulated/0/path/to/file (Android)
Te ścieżki były także zwracany przez metodę toURL()
Entry
obiektów.
Z v1.0.0 atrybut fullPath
jest ścieżką do pliku, względem katalogu głównego systemu plików HTML. Tak powyżej ścieżki będzie teraz zarówno być reprezentowane przez obiekt FileEntry
z fullPath
o
/path/to/file
Jeśli aplikacja działa z ścieżki bezwzględnej urządzeń, i możesz wcześniej źródło tych ścieżek przez właściwość fullPath
wpis
obiektów, należy zaktualizować kod, aby zamiast tego użyj entry.toURL()
.
Dla wstecznej kompatybilności, Metoda resolveLocalFileSystemURL()
będzie zaakceptować urządzenia ścieżka bezwzględna i zwróci obiekt Entry
odpowiadający, tak długo, jak ten plik istnieje w albo TEMPORARY
lub PERSISTENT
systemy plików.
To szczególnie został problem z pluginem transferu plików, które poprzednio używane ścieżki bezwzględnej urządzeń (i wciąż można je przyjąć). Została zaktualizowana do pracy poprawnie z adresów URL plików, więc wymiana entry.fullPath
z entry.toURL()
powinno rozwiązać wszelkie problemy dostawanie ten plugin do pracy z plików w pamięci urządzenia.
W v1.1.0 wartość zwracana przez toURL()
został zmieniony (patrz [CB-6394] (https://issues.apache.org/jira/browse/CB-6394)) zwraca adres URL absolutnej "file://". wszędzie tam, gdzie jest to możliwe. Aby zapewnić ' cdvfile:'-URL można użyć toInternalURL()
teraz. Ta metoda zwróci teraz adresy URL plików formularza
cdvfile://localhost/persistent/path/to/file
który służy do jednoznacznej identyfikacji pliku.
Gdy błąd jest generowany, jeden z następujących kodów będzie służyć.
Kod | Stała |
---|---|
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 |
Zestaw dostępnych plików może być skonfigurowany na platformie. Zarówno iOS i Android Tag w pliku config.xml
, których nazwy plików do instalacji. Domyślnie włączone są wszystkie korzenie systemu plików.
<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
: katalogu przechowywania plików aplikacjifiles-external
: katalog aplikacji zewnętrznych plikówsdcard
: katalog globalny plik zewnętrzny (to jest głównym karty SD, jeśli jedna jest zainstalowana). Musi mieć uprawnienia android.permission.WRITE_EXTERNAL_STORAGE
wobec używać ten.cache
: katalogu wewnętrznej pamięci podręcznej aplikacjicache-external
: katalogu aplikacji zewnętrznych pamięci podręcznejroot
: całe urządzenie systemu plikówAndroid obsługuje również specjalnych plików o nazwie "dokumenty", który reprezentuje podkatalog "/ dokumenty /" w ramach systemu plików "pliki".
library
: katalog biblioteki aplikacjidocuments
: dokumenty katalogu aplikacjicache
: katalogu pamięci podręcznej aplikacjibundle
: pakiet aplikacji; Lokalizacja aplikacji na dysku (tylko do odczytu)root
: całe urządzenie systemu plikówDomyślnie katalogi biblioteki i dokumenty mogą być synchronizowane iCloud. Można również zażądać dwóch dodatkowych plików, library-nosync
i documents-nosync
, które stanowią specjalny katalog nie zsynchronizowane w /Library
lub systemu plików /Documents
.