Rename ExceptionCode-based exception handling to "legacy"
[WebKit-https.git] / Source / WebCore / Modules / fetch / FetchResponse.idl
1 /*
2  * Copyright (C) 2016 Canon Inc.
3  *
4  * Redistribution and use in source and binary forms, with or without
5  * modification, are permitted, provided that the following conditions
6  * are required to be met:
7  *
8  * 1.  Redistributions of source code must retain the above copyright
9  *     notice, this list of conditions and the following disclaimer.
10  * 2.  Redistributions in binary form must reproduce the above copyright
11  *     notice, this list of conditions and the following disclaimer in the
12  *     documentation and/or other materials provided with the distribution.
13  * 3.  Neither the name of Canon Inc. nor the names of
14  *     its contributors may be used to endorse or promote products derived
15  *     from this software without specific prior written permission.
16  *
17  * THIS SOFTWARE IS PROVIDED BY CANON INC. AND ITS CONTRIBUTORS "AS IS" AND ANY
18  * EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE IMPLIED
19  * WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE ARE
20  * DISCLAIMED. IN NO EVENT SHALL CANON INC. AND ITS CONTRIBUTORS BE LIABLE FOR
21  * ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL
22  * DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR
23  * SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION) HOWEVER
24  * CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY,
25  * OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT OF THE USE
26  * OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE.
27  */
28 enum ResponseType { "basic", "cors", "default", "error", "opaque", "opaqueredirect" };
29
30 [
31     ActiveDOMObject,
32     Conditional=FETCH_API,
33     EnabledAtRuntime=FetchAPI,
34     ConstructorCallWith=ScriptExecutionContext,
35     Exposed=(Window,Worker),
36     InterfaceName=Response,
37     JSBuiltinConstructor,
38     PrivateIdentifier,
39     PublicIdentifier
40 ]
41 interface FetchResponse {
42     [NewObject, CallWith=ScriptExecutionContext] static FetchResponse error();
43     [NewObject, CallWith=ScriptExecutionContext, MayThrowLegacyException] static FetchResponse redirect(DOMString url, optional unsigned short status = 302);
44
45     readonly attribute ResponseType type;
46
47     readonly attribute DOMString url;
48     readonly attribute boolean redirected;
49     readonly attribute unsigned short status;
50     readonly attribute boolean ok;
51     readonly attribute DOMString statusText;
52     // FIXME: Add support for SameObject keyword for headers
53     readonly attribute FetchHeaders headers;
54     [JSBuiltin] readonly attribute ReadableStream? body;
55
56     // Copy of FetchBody IDL as we want to implement some of these as built-ins.
57     [JSBuiltin] readonly attribute boolean bodyUsed;
58     [JSBuiltin] Promise arrayBuffer();
59     [JSBuiltin] Promise blob();
60     [JSBuiltin] Promise formData();
61     [JSBuiltin] Promise json();
62     [JSBuiltin] Promise text();
63
64     [JSBuiltin] FetchResponse clone();
65
66     [PrivateIdentifier, NewObject] FetchResponse cloneForJS();
67
68     [Conditional=READABLE_STREAM_API, PrivateIdentifier] void startConsumingStream(unsigned short type);
69     [Conditional=READABLE_STREAM_API, PrivateIdentifier] void consumeChunk(Uint8Array chunk);
70     [Conditional=READABLE_STREAM_API, PrivateIdentifier] Promise finishConsumingStream();
71
72     [PrivateIdentifier] Promise consume(unsigned short type);
73     [PrivateIdentifier] boolean isLoading();
74     [PrivateIdentifier, MayThrowLegacyException] void setStatus(unsigned short status, DOMString statusText);
75     [CallWith=ScriptState, PrivateIdentifier] void initializeWith(any body);
76     [PrivateIdentifier, NewObject] ReadableStreamSource createReadableStreamSource();
77     [PrivateIdentifier] boolean isDisturbed();
78 };