blob: 91155584a19d7cd7d03268e2be2958663850429b [file] [log] [blame]
Tim Volodine28c83562016-01-20 19:23:03 +00001/*
2 * Copyright (C) 2016 The Android Open Source Project
3 *
4 * Licensed under the Apache License, Version 2.0 (the "License");
5 * you may not use this file except in compliance with the License.
6 * You may obtain a copy of the License at
7 *
8 * http://www.apache.org/licenses/LICENSE-2.0
9 *
10 * Unless required by applicable law or agreed to in writing, software
11 * distributed under the License is distributed on an "AS IS" BASIS,
12 * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
13 * See the License for the specific language governing permissions and
14 * limitations under the License.
15 */
16
17package android.webkit;
18
19import android.annotation.NonNull;
20import android.annotation.Nullable;
21
22/**
23 * Manages Service Workers used by WebView.
24 */
25public abstract class ServiceWorkerController {
26
27 /**
28 * Returns the default ServiceWorkerController instance. At present there is
29 * only one ServiceWorkerController instance for all WebView instances,
30 * however this restriction may be relaxed in the future.
31 *
32 * @return The default ServiceWorkerController instance.
33 */
34 @NonNull
35 public static ServiceWorkerController getInstance() {
36 return WebViewFactory.getProvider().getServiceWorkerController();
37 }
38
39 /**
40 * Gets the settings for all service workers.
41 *
42 * @return The current ServiceWorkerWebSettings
43 */
44 @NonNull
45 public abstract ServiceWorkerWebSettings getServiceWorkerWebSettings();
46
47 /**
48 * Sets the client to capture service worker related callbacks.
49 */
50 public abstract void setServiceWorkerClient(@Nullable ServiceWorkerClient client);
51}
52