1/*
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.Nullable;
20
21/**
22 * Base class for clients to capture Service Worker related callbacks,
23 * see {@link ServiceWorkerController} for usage example.
24 */
25public class ServiceWorkerClient {
26
27    /**
28     * Notify the host application of a resource request and allow the
29     * application to return the data. If the return value is {@code null}, the
30     * Service Worker will continue to load the resource as usual.
31     * Otherwise, the return response and data will be used.
32     *
33     * <p class="note"><b>Note:</b> This method is called on a thread other than the UI thread so
34     * clients should exercise caution when accessing private data or the view system.
35     *
36     * @param request Object containing the details of the request.
37     * @return A {@link android.webkit.WebResourceResponse} containing the
38     *         response information or {@code null} if the WebView should load the
39     *         resource itself.
40     * @see WebViewClient#shouldInterceptRequest(WebView, WebResourceRequest)
41     */
42    @Nullable
43    public WebResourceResponse shouldInterceptRequest(WebResourceRequest request) {
44        return null;
45    }
46}
47
48