Source/WebCore/Modules/fetch/FetchResponse.idl

/*
 * Copyright (C) 2016 Canon Inc.
 *
 * Redistribution and use in source and binary forms, with or without
 * modification, are permitted, provided that the following conditions
 * are required to be met:
 *
 * 1.  Redistributions of source code must retain the above copyright
 *     notice, this list of conditions and the following disclaimer.
 * 2.  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.
 * 3.  Neither the name of Canon 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 CANON INC. AND ITS 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 CANON INC. AND ITS 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.
 */

typedef (Blob or BufferSource or DOMFormData or URLSearchParams or ReadableStream or USVString) BodyInit;
typedef (sequence<sequence<ByteString>> or record<ByteString, ByteString>) HeadersInit;

enum FetchResponseType { "basic", "cors", "default", "error", "opaque", "opaqueredirect" };

dictionary FetchResponseInit {
    unsigned short status = 200;
    ByteString statusText = "";
    HeadersInit headers;
};

[
    ActiveDOMObject,
    Constructor(optional BodyInit? body = null, optional FetchResponseInit init),
    ConstructorCallWith=ScriptExecutionContext,
    ConstructorMayThrowException,
    EnabledAtRuntime=FetchAPI,
    ExportMacro=WEBCORE_EXPORT,
    Exposed=(Window,Worker),
    InterfaceName=Response,
] interface FetchResponse {
    [CallWith=ScriptExecutionContext, NewObject] static FetchResponse error();
    [CallWith=ScriptExecutionContext, MayThrowException, NewObject] static FetchResponse redirect(USVString url, optional unsigned short status = 302);

    readonly attribute FetchResponseType type;

    readonly attribute USVString url;
    readonly attribute boolean redirected;
    readonly attribute unsigned short status;
    readonly attribute boolean ok;
    readonly attribute ByteString statusText;
    readonly attribute FetchHeaders headers; // FIXME: Should be [SameObject].
    // FIXME: Add support for trailers.
    // readonly attribute Promise<Headers> trailer;

    [CallWith=ScriptExecutionContext, MayThrowException, NewObject] FetchResponse clone();
};

FetchResponse implements FetchBody;