• Home
  • Line#
  • Scopes#
  • Navigate#
  • Raw
  • Download
1 /*
2  * Copyright (C) 2017 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 android.webkit;
18 
19 /**
20  * Used to indicate an action to take when hitting a malicious URL. Instances of this class are
21  * created by the WebView and passed to {@link android.webkit.WebViewClient#onSafeBrowsingHit}. The
22  * host application must call {@link #showInterstitial(boolean)}, {@link #proceed(boolean)}, or
23  * {@link #backToSafety(boolean)} to set the WebView's response to the Safe Browsing hit.
24  *
25  * <p>
26  * If reporting is enabled, all reports will be sent according to the privacy policy referenced by
27  * {@link android.webkit.WebView#getSafeBrowsingPrivacyPolicyUrl()}.
28  */
29 public abstract class SafeBrowsingResponse {
30     /**
31      * @deprecated This class should not be constructed by applications.
32      */
33     // TODO(ntfschr): mark this as @SystemApi after a year.
34     @Deprecated
SafeBrowsingResponse()35     public SafeBrowsingResponse() {}
36 
37     /**
38      * Display the default interstitial.
39      *
40      * @param allowReporting {@code true} if the interstitial should show a reporting checkbox.
41      */
showInterstitial(boolean allowReporting)42     public abstract void showInterstitial(boolean allowReporting);
43 
44     /**
45      * Act as if the user clicked the "visit this unsafe site" button.
46      *
47      * @param report {@code true} to enable Safe Browsing reporting.
48      */
proceed(boolean report)49     public abstract void proceed(boolean report);
50 
51     /**
52      * Act as if the user clicked the "back to safety" button.
53      *
54      * @param report {@code true} to enable Safe Browsing reporting.
55      */
backToSafety(boolean report)56     public abstract void backToSafety(boolean report);
57 }
58