Donate to e Foundation | Murena handsets with /e/OS | Own a part of Murena! Learn more

Commit 5a6ae8c7 authored by Nate Fischer's avatar Nate Fischer
Browse files

WebView: fix docs for setSafeBrowsingWhitelist

No change to logic, documentation change only.

This changes "URL" to "host" everywhere in this API documentation.
This API never accepted a list of URLs, it only ever accepted a list of
hosts (e.g. "www.google.com" is ok, "http://www.google.com/" is not).
The original documentation was misleading.

Test: make docs (manually verify)
Change-Id: I3b57a2a160ff00ba8f92b30f6e3b4399e55f2ea0
parent e7e42ceb
Loading
Loading
Loading
Loading
+11 −8
Original line number Diff line number Diff line
@@ -1689,8 +1689,8 @@ public class WebView extends AbsoluteLayout
    }

    /**
     * Sets the list of domains that are exempt from SafeBrowsing checks. The list is
     * global for all the WebViews.
     * Sets the list of hosts (domain names/IP addresses) that are exempt from SafeBrowsing checks.
     * The list is global for all the WebViews.
     * <p>
     * Each rule should take one of these:
     * <table>
@@ -1702,15 +1702,18 @@ public class WebView extends AbsoluteLayout
     * </table>
     * <p>
     * All other rules, including wildcards, are invalid.
     * <p>
     * The correct syntax for hosts is defined by <a
     * href="https://tools.ietf.org/html/rfc3986#section-3.2.2">RFC 3986</a>.
     *
     * @param urls the list of URLs
     * @param callback will be called with {@code true} if URLs are successfully added to the
     * whitelist. It will be called with {@code false} if any URLs are malformed. The callback will
     * be run on the UI thread
     * @param hosts the list of hosts
     * @param callback will be called with {@code true} if hosts are successfully added to the
     * whitelist. It will be called with {@code false} if any hosts are malformed. The callback
     * will be run on the UI thread
     */
    public static void setSafeBrowsingWhitelist(@NonNull List<String> urls,
    public static void setSafeBrowsingWhitelist(@NonNull List<String> hosts,
            @Nullable ValueCallback<Boolean> callback) {
        getFactory().getStatics().setSafeBrowsingWhitelist(urls, callback);
        getFactory().getStatics().setSafeBrowsingWhitelist(hosts, callback);
    }

    /**
+1 −1
Original line number Diff line number Diff line
@@ -89,7 +89,7 @@ public interface WebViewFactoryProvider {
        * {@link android.webkit.WebView#setSafeBrowsingWhitelist(List<String>,
        * ValueCallback<Boolean>)}
        */
        void setSafeBrowsingWhitelist(List<String> urls, ValueCallback<Boolean> callback);
        void setSafeBrowsingWhitelist(List<String> hosts, ValueCallback<Boolean> callback);

        /**
         * Implement the API method