FileSystemDirectoryEntry: Methode getDirectory()

Die Methode getDirectory() der FileSystemDirectoryEntry-Schnittstelle gibt ein FileSystemDirectoryEntry-Objekt zurück, das einem Verzeichnis entspricht, das sich irgendwo im Verzeichnisbaum befindet, der im Verzeichnis verwurzelt ist, auf dem sie aufgerufen wird.

Syntax

js
getDirectory()
getDirectory(path)
getDirectory(path, options)
getDirectory(path, options, successCallback)
getDirectory(path, options, successCallback, errorCallback)

Parameter

path Optional

Ein String, der einen absoluten Pfad oder einen relativen Pfad zu dem Verzeichnis darstellt, auf dem die Methode aufgerufen wird und das Verzeichnis beschreibt, das zurückgegeben werden soll. Aus Sicherheitsgründen können absolute Pfade möglicherweise nicht verwendet werden.

options Optional

Ein Objekt, das Ihnen ermöglicht anzugeben, ob der Eintrag erstellt werden soll, falls er fehlt, und ob es ein Fehler ist, wenn die Datei bereits existiert. Diese Optionen sind in Web-Kontexten derzeit nicht nützlich. Siehe den Abschnitt options parameter für weitere Details.

successCallback Optional

Eine Methode, die aufgerufen wird, sobald das FileSystemDirectoryEntry erstellt wurde. Die Methode erhält einen einzigen Parameter: das FileSystemDirectoryEntry-Objekt, das das betreffende Verzeichnis darstellt.

errorCallback Optional

Eine Methode, die aufgerufen wird, wenn ein Fehler auftritt. Sie erhält als einzigen Eingabeparameter ein DomException-Objekt, das den aufgetretenen Fehler beschreibt.

Parameter options

Das options-Parameterobjekt akzeptiert die folgenden Parameter:

create Optional

Wenn diese Eigenschaft true ist und das angeforderte Verzeichnis nicht existiert, sollte der Benutzeragent es erstellen. Der Standardwert ist false. Das übergeordnete Verzeichnis muss bereits existieren.

exclusive Optional

Wenn true und die create-Option ebenfalls true ist, darf das Verzeichnis vor dem Aufruf nicht existieren. Stattdessen muss es zur Aufrufzeit neu erstellt werden können. Der Standardwert ist false. Dieser Parameter wird ignoriert, wenn create false ist.

Die folgende Tabelle beschreibt das Ergebnis jeder möglichen Kombination dieser Flags, je nachdem, ob der Zielverzeichnispfad bereits existiert oder nicht.

Option create Option exclusive Pfadbedingung Ergebnis
false Ignoriert Pfad existiert und ist ein Verzeichnis Der successCallback wird mit einem FileSystemDirectoryEntry aufgerufen.
false Ignoriert Pfad existiert, ist jedoch eine Datei Der errorCallback wird mit einem entsprechenden Fehlercode aufgerufen (falls der Callback bereitgestellt wurde).
true false Pfad existiert Das vorhandene Verzeichnis wird entfernt und durch ein neues ersetzt, dann wird der successCallback mit einem FileSystemDirectoryEntry aufgerufen.
true false Pfad existiert nicht Das Verzeichnis wird erstellt, dann wird ein FileSystemDirectoryEntry an den successCallback übergeben.
true true Pfad existiert Der errorCallback wird mit einem entsprechenden Fehler, wie FileError.PATH_EXISTS_ERR, aufgerufen.
true true Pfad existiert nicht Das Verzeichnis wird erstellt, dann wird ein FileSystemDirectoryEntry an den successCallback übergeben.

Rückgabewert

Keiner (undefined).

Ausnahmen

NotFoundError DOMException

Wird ausgelöst, wenn die create-Option nicht angegeben wurde (oder als false angegeben wurde) und das Verzeichnis nicht existiert.

SecurityError DOMException

Wird ausgelöst, wenn die Anfrage, auf das Verzeichnis zuzugreifen, aus Sicherheitsgründen abgelehnt wurde.

TypeMismatchError DOMException

Wird ausgelöst, wenn der angegebene Pfad kein Verzeichnis ist; es handelt sich wahrscheinlich um eine Datei, könnte aber ein nicht unterstützter Dateizeiger wie eine Pipe sein; dies hängt bis zu einem gewissen Grad vom Benutzeragenten ab.

Beispiele

In diesem Beispiel wird eine Funktion präsentiert, deren Aufgabe es ist, innerhalb des App-Datenverzeichnisses eines Benutzers eine JSON-Datei zu finden, die ein Benutzerwörterbuch für eine bestimmte Sprache enthält, und dieses Wörterbuch dann zu laden.

js
let dictionary = null;

function loadDictionaryForLanguage(appDataDirEntry, lang) {
  dictionary = null;

  appDataDirEntry.getDirectory("Dictionaries", {}, (dirEntry) => {
    dirEntry.getFile(`${lang}-dict.json`, {}, (fileEntry) => {
      fileEntry.file((dictFile) => {
        let reader = new FileReader();

        reader.addEventListener("loadend", () => {
          dictionary = JSON.parse(reader.result);
        });

        reader.readAsText(dictFile);
      });
    });
  });
}

Die Funktion loadDictionaryForLanguage() beginnt, indem sie getDirectory() verwendet, um das FileSystemDirectoryEntry-Objekt zu erhalten, das einen Unterordner namens "Dictionaries" darstellt, der sich im angegebenen App-Datenverzeichnis befindet. Der Erfolgscallback dafür nimmt das resultierende Verzeichniseintragsobjekt und ruft getFile() auf, um ein FileSystemFileEntry-Objekt zu erhalten, das die Wörterbuchdatei darstellt; der Erfolgscallback erstellt dann einen neuen FileReader und verwendet ihn, um den Inhalt der Datei zu laden. Wenn dieser erfolgreich geladen wurde (was durch das Auslösen des loadend-Ereignisses angezeigt wird), wird der geladene Text in JSON.parse() übergeben, um ihn in ein JavaScript-Objekt umzuwandeln.

Spezifikationen

Specification
File and Directory Entries API
# dom-filesystemdirectoryentry-getdirectory

Browser-Kompatibilität

Report problems with this compatibility data on GitHub
desktopmobile
Chrome
Edge
Firefox
Opera
Safari
Chrome Android
Firefox for Android
Opera Android
Safari on iOS
Samsung Internet
WebView Android
WebView on iOS
getDirectory

Legend

Tip: you can click/tap on a cell for more information.

Full support
Full support
No support
No support
See implementation notes.

Siehe auch