1 /*
2  * Copyright 2018 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 
17 package androidx.webkit;
18 
19 import android.webkit.WebResourceRequest;
20 import android.webkit.WebResourceResponse;
21 
22 import androidx.annotation.NonNull;
23 
24 /**
25  * Base class for clients to capture Service Worker related callbacks,
26  * see {@link ServiceWorkerControllerCompat} for usage example.
27  */
28 public abstract class ServiceWorkerClientCompat {
29     /**
30      *
31      * Notify the host application of a resource request and allow the
32      * application to return the data. If the return value is {@code null}, the
33      * Service Worker will continue to load the resource as usual.
34      * Otherwise, the return response and data will be used.
35      *
36      * <p class="note"><b>Note:</b> This method is called on a thread other than the UI thread so
37      * clients should exercise caution when accessing private data or the view system.
38      *
39      * @param request Object containing the details of the request.
40      * @return A {@link android.webkit.WebResourceResponse} containing the
41      * response information or {@code null} if the WebView should load the
42      * resource itself.
43      * @see android.webkit.WebViewClient#shouldInterceptRequest(android.webkit.WebView,
44      * WebResourceRequest)
45      *
46      * This method is called only if
47      * {@link WebViewFeature#SERVICE_WORKER_SHOULD_INTERCEPT_REQUEST} is supported. You can check
48      * whether that flag is supported using {@link WebViewFeature#isFeatureSupported(String)}.
49      *
50      */
shouldInterceptRequest(@onNull WebResourceRequest request)51     public abstract WebResourceResponse shouldInterceptRequest(@NonNull WebResourceRequest request);
52 }
53