third_party/WebKit/Source/core/html/FormData.idl

   1 /*
   2  * Copyright (C) 2010 Google Inc. All rights reserved.
   3  *
   4  * Redistribution and use in source and binary forms, with or without
   5  * modification, are permitted provided that the following conditions are
   6  * met:
   7  *
   8  *     * Redistributions of source code must retain the above copyright
   9  * notice, this list of conditions and the following disclaimer.
  10  *     * Redistributions in binary form must reproduce the above
  11  * copyright notice, this list of conditions and the following disclaimer
  12  * in the documentation and/or other materials provided with the
  13  * distribution.
  14  *     * Neither the name of Google Inc. nor the names of its
  15  * contributors may be used to endorse or promote products derived from
  16  * this software without specific prior written permission.
  17  *
  18  * THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS AND CONTRIBUTORS
  19  * "AS IS" AND ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT
  20  * LIMITED TO, THE IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR
  21  * A PARTICULAR PURPOSE ARE DISCLAIMED. IN NO EVENT SHALL THE COPYRIGHT
  22  * OWNER OR CONTRIBUTORS BE LIABLE FOR ANY DIRECT, INDIRECT, INCIDENTAL,
  23  * SPECIAL, EXEMPLARY, OR CONSEQUENTIAL DAMAGES (INCLUDING, BUT NOT
  24  * LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES; LOSS OF USE,
  25  * DATA, OR PROFITS; OR BUSINESS INTERRUPTION) HOWEVER CAUSED AND ON ANY
  26  * THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY, OR TORT
  27  * (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT OF THE USE
  28  * OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE.
  29  */
  30
  31 // https://xhr.spec.whatwg.org/#interface-formdata
  32
  33 // TODO(philipj): The FormDataEntryValue typedef should use Blob, not File.
  34 typedef (File or USVString) FormDataEntryValue;
  35
  36 [
  37     Constructor(optional HTMLFormElement form),
  38     Exposed=(Window,Worker),
  39     GarbageCollected,
  40 ] interface FormData {
  41     // TODO(philipj): The value argument should be FormDataEntryValue and there
  42     // should be no optional filename argument. crbug.com/498790
  43     [CallWith=ExecutionContext] void append(USVString name, Blob value, optional USVString filename);
  44     void append(USVString name, USVString value);
  45
  46     [RuntimeEnabled=FormDataNewMethods, ImplementedAs=deleteEntry] void delete(USVString name);
  47     [RuntimeEnabled=FormDataNewMethods] FormDataEntryValue? get(USVString name);
  48     [RuntimeEnabled=FormDataNewMethods] sequence<FormDataEntryValue> getAll(USVString name);
  49     [RuntimeEnabled=FormDataNewMethods] boolean has(USVString name);
  50     // TODO(philipj): The value argument should be FormDataEntryValue and there
  51     // should be no optional filename argument.
  52     [RuntimeEnabled=FormDataNewMethods] void set(USVString name, Blob value, optional USVString filename);
  53     [RuntimeEnabled=FormDataNewMethods] void set(USVString name, USVString value);
  54     [RuntimeEnabled=FormDataNewMethods] iterable<USVString, FormDataEntryValue>;
  55 };