gecko/dom/webidl/Directory.webidl
Ryan VanderMeulen ebd3457021 Backed out 5 changesets (bug 910412) for intermittent crash whack-a-mole.
Backed out changeset e3eb9463b3e1 (bug 910412)
Backed out changeset d5863d302bde (bug 910412)
Backed out changeset 422b66d4b1ca (bug 910412)
Backed out changeset 3431d59d752e (bug 910412)
Backed out changeset b1c0310cdac1 (bug 910412)
2014-03-11 12:17:03 -04:00

50 lines
1.7 KiB
Plaintext

/* -*- Mode: IDL; tab-width: 2; indent-tabs-mode: nil; c-basic-offset: 2 -*- */
/* This Source Code Form is subject to the terms of the Mozilla Public
* License, v. 2.0. If a copy of the MPL was not distributed with this file,
* You can obtain one at http://mozilla.org/MPL/2.0/.
*/
interface File;
/*
* All functions on Directory that accept DOMString arguments for file or
* directory names only allow relative path to current directory itself. The
* path should be a descendent path like "path/to/file.txt" and not contain a
* segment of ".." or ".". So the paths aren't allowed to walk up the directory
* tree. For example, paths like "../foo", "..", "/foo/bar" or "foo/../bar" are
* not allowed.
*/
[NoInterfaceObject]
interface Directory {
/*
* The leaf name of the directory.
*/
readonly attribute DOMString name;
/*
* Creates a descendent directory. This method will create any intermediate
* directories specified by the path segments.
*
* @param path The relative path of the new directory to current directory.
* If path exists, createDirectory must fail.
* @return If succeeds, the promise is resolved with the new created
* Directory object. Otherwise, rejected with a DOM error.
*/
[NewObject]
// Promise<Directory>
Promise createDirectory(DOMString path);
/*
* Gets a descendent file or directory with the given path.
*
* @param path The descendent entry's relative path to current directory.
* @return If the path exists and no error occurs, the promise is resolved
* with a File or Directory object, depending on the entry's type. Otherwise,
* rejected with a DOM error.
*/
[NewObject]
// Promise<(File or Directory)>
Promise get(DOMString path);
};