third_party/blink/renderer/modules/filesystem/entry.idl

/*
 * Copyright (C) 2010 Google Inc. All rights reserved.
 *
 * Redistribution and use in source and binary forms, with or without
 * modification, are permitted provided that the following conditions are
 * met:
 *
 *     * Redistributions of source code must retain the above copyright
 * notice, this list of conditions and the following disclaimer.
 *     * Redistributions in binary form must reproduce the above
 * copyright notice, this list of conditions and the following disclaimer
 * in the documentation and/or other materials provided with the
 * distribution.
 *     * Neither the name of Google Inc. nor the names of its
 * contributors may be used to endorse or promote products derived from
 * this software without specific prior written permission.
 *
 * THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS AND CONTRIBUTORS
 * "AS IS" AND ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT
 * LIMITED TO, THE IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR
 * A PARTICULAR PURPOSE ARE DISCLAIMED. IN NO EVENT SHALL THE COPYRIGHT
 * OWNER OR CONTRIBUTORS BE LIABLE FOR ANY DIRECT, INDIRECT, INCIDENTAL,
 * SPECIAL, EXEMPLARY, OR CONSEQUENTIAL DAMAGES (INCLUDING, BUT NOT
 * LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES; LOSS OF USE,
 * DATA, OR PROFITS; OR BUSINESS INTERRUPTION) HOWEVER CAUSED AND ON ANY
 * THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY, OR TORT
 * (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT OF THE USE
 * OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE.
 */

// https://www.w3.org/TR/2012/WD-file-system-api-20120417/#idl-def-Entry
[
    NoInterfaceObject
] interface Entry {
    readonly attribute boolean isFile;
    readonly attribute boolean isDirectory;
    readonly attribute DOMString name;
    readonly attribute DOMString fullPath;
    [CallWith=ScriptState] readonly attribute DOMFileSystem filesystem;

    // TODO(crbug.com/841185): |errorCallback| is not nullable in the spec.
    [CallWith=ScriptState] void getMetadata(MetadataCallback successCallback, optional ErrorCallback? errorCallback);
    // TODO(crbug.com/841185): |successCallback| and |errorCallback| are not
    // nullable in the spec.
    [CallWith=ScriptState] void moveTo(DirectoryEntry parent, optional DOMString? name, optional EntryCallback? successCallback, optional ErrorCallback? errorCallback);
    // TODO(crbug.com/841185): |successCallback| and |errorCallback| are not
    // nullable in the spec.
    [CallWith=ScriptState] void copyTo(DirectoryEntry parent, optional DOMString? name, optional EntryCallback? successCallback, optional ErrorCallback? errorCallback);
    [CallWith=ScriptState] DOMString toURL();
    // TODO(crbug.com/841185): |errorCallback| is not nullable in the spec.
    [CallWith=ScriptState] void remove(VoidCallback successCallback, optional ErrorCallback? errorCallback);
    // TODO(crbug.com/841185): |successCallback| and |errorCallback| are not
    // nullable in the spec.
    [CallWith=ScriptState] void getParent(optional EntryCallback? successCallback, optional ErrorCallback? errorCallback);

    // Primarily exposed for testing, to give script some way of getting new
    // style handles.
    // TODO(mek): Remove this method once API to get new-style file handles
    // directly has been implemented.
    [RuntimeEnabled=WritableFiles]
    FileSystemBaseHandle asFileSystemHandle();
};