Add [ActiveDOMObject] to IDLs of ActiveDOMObjects
[WebKit-https.git] / Source / WebCore / workers / service / ServiceWorkerContainer.idl
1 /*
2  * Copyright (C) 2017 Apple 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
6  * are met:
7  * 1. Redistributions of source code must retain the above copyright
8  *    notice, this list of conditions and the following disclaimer.
9  * 2. Redistributions in binary form must reproduce the above copyright
10  *    notice, this list of conditions and the following disclaimer in the
11  *    documentation and/or other materials provided with the distribution.
12  *
13  * THIS SOFTWARE IS PROVIDED BY APPLE INC. AND ITS CONTRIBUTORS ``AS IS''
14  * AND ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO,
15  * THE IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR
16  * PURPOSE ARE DISCLAIMED. IN NO EVENT SHALL APPLE INC. OR ITS CONTRIBUTORS
17  * BE LIABLE FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR
18  * CONSEQUENTIAL DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF
19  * SUBSTITUTE GOODS OR SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS
20  * INTERRUPTION) HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN
21  * CONTRACT, STRICT LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE)
22  * ARISING IN ANY WAY OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF
23  * THE POSSIBILITY OF SUCH DAMAGE.
24  */
25
26 // FIXME: The spec IDL exposes this on Worker in addition to Window.
27 // We don't currently support nested workers.
28
29 [
30     ActiveDOMObject,
31     SecureContext,
32     Exposed=(Window,ServiceWorker),
33     Conditional=SERVICE_WORKER,
34     EnabledAtRuntime=ServiceWorker,
35     GenerateIsReachable=ReachableFromNavigator
36 ] interface ServiceWorkerContainer : EventTarget {
37     readonly attribute ServiceWorker? controller;
38     readonly attribute Promise<ServiceWorkerRegistration> ready;
39
40     [NewObject, ImplementedAs=addRegistration] Promise<ServiceWorkerRegistration> register(USVString scriptURL, optional RegistrationOptions options);
41     [NewObject] Promise<any> getRegistration(optional USVString clientURL = "");
42     [NewObject] Promise<sequence<ServiceWorkerRegistration>> getRegistrations();
43
44     void startMessages();
45
46     // events
47     attribute EventHandler oncontrollerchange;
48     attribute EventHandler onmessage;
49     attribute EventHandler onmessageerror;
50 };
51
52 dictionary RegistrationOptions {
53     USVString scope;
54     WorkerType type = "classic";
55     ServiceWorkerUpdateViaCache updateViaCache = "imports";
56 };