FileSystemDirectoryEntry: getDirectory() Methode

Syntax

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 Pfad relativ zu dem Verzeichnis darstellt, auf dem die Methode aufgerufen wird und welches Verzeichniseintrag zurückgegeben werden soll. Aus Sicherheitsgründen können absolute Pfade möglicherweise nicht verwendet werden.

options Optional

Ein Objekt, das Ihnen erlaubt, anzugeben, ob der Eintrag erstellt werden soll, wenn er fehlt und ob es ein Fehler ist, wenn die Datei bereits existiert. Diese Optionen sind derzeit in Web-Kontexten 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 einzelnen 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.

options Parameter

Das options Parameter-Objekt akzeptiert folgende Parameter:

create Optional

Wenn diese Eigenschaft true ist und das angeforderte Verzeichnis nicht existiert, sollte der User-Agent 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 existiert haben. Stattdessen muss es möglich sein, es neu zur Aufrufzeit zu erstellen. Der Standardwert ist false. Dieser Parameter wird ignoriert, wenn create false ist.

Die folgende Tabelle beschreibt das Ergebnis jeder möglichen Kombination dieser Flags, abhängig davon, ob der Zielverzeichnispfad bereits existiert oder nicht.

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 der Zugriff auf das Verzeichnis aus Sicherheitsgründen verweigert wurde.

TypeMismatchError DOMException

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

Beispiele

In diesem Beispiel wird eine Funktion vorgestellt, deren Aufgabe es ist, innerhalb des App-Datenverzeichnisses eines Benutzers eine JSON-Datei mit einem Benutzerdictionary für eine bestimmte Sprache zu finden und dieses Dictionary dann zu laden.

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 Verzeichniseintrag-Objekt und ruft getFile() auf, um ein FileSystemFileEntry-Objekt zu erhalten, das die Dictionary-Datei darstellt; der Erfolgscallback dafür wiederum erstellt einen neuen FileReader und verwendet ihn, um den Inhalt der Datei zu laden. Wenn dieser erfolgreich geladen wurde (wie durch das Auftreten des loadend-Ereignisses angezeigt), wird der geladene Text in JSON.parse() übergeben, um in ein JavaScript-Objekt umgewandelt zu werden.

Spezifikationen

Browser-Kompatibilität

Siehe auch

• File and Directory Entries API
• FileSystemDirectoryEntry