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

Commit 8cc15366 authored by Nate Fischer's avatar Nate Fischer
Browse files

WebView: fix docs for setAllow*AccessFromFileUrls 

No change to behavior, only docs change.

The docs for setAllow(File|Universal)AccessFromFileUrls were previously
wrong. They implied that:

 * Default value is 'false' when SDK_INT > Jellybean
 * APIs were added in Jellybean (so they can't be called pre-Jellybean)
 * Therefore, setAllow*AccessFromFileUrls(false) is always a NOOP

Actually, WebView examines targetSdk, not SDK_INT. So apps should call
setAllow*AccessFromFileUrls(false) when targeting ICE_CREAM_SANDWICH_MR1
and below.

The docs previously had mixed use of ICE_CREAM_SANDWICH and
ICE_CREAM_SANDWICH_MR1. This corrects the docs to use the right one
(ICE_CREAM_SANDWICH_MR1).

Lastly, this fixes a minor grammar mistake (misplaced comma).

Test: make docs (manually verify)
Change-Id: I206dff54a8c342ae7b47bd40d69d0b01dbad3cc6
parent 6db6679a

core/java/android/webkit/WebSettings.java

+9 −9
Original line number Diff line number Diff line
@@ -931,12 +931,12 @@ public abstract class WebSettings { 
     * Note that this setting affects only JavaScript access to file scheme

     * resources. Other access to such resources, for example, from image HTML

     * elements, is unaffected. To prevent possible violation of same domain policy

     * on {@link android.os.Build.VERSION_CODES#ICE_CREAM_SANDWICH} and earlier

     * devices, you should explicitly set this value to {@code false}.

     * when targeting {@link android.os.Build.VERSION_CODES#ICE_CREAM_SANDWICH_MR1} and earlier,

     * you should explicitly set this value to {@code false}.

     * <p>

     * The default value is {@code true} for API level

     * The default value is {@code true} for apps targeting

     * {@link android.os.Build.VERSION_CODES#ICE_CREAM_SANDWICH_MR1} and below,

     * and {@code false} for API level {@link android.os.Build.VERSION_CODES#JELLY_BEAN}

     * and {@code false} when targeting {@link android.os.Build.VERSION_CODES#JELLY_BEAN}

     * and above.

     *

     * @param flag whether JavaScript running in the context of a file scheme
@@ -947,18 +947,18 @@ public abstract class WebSettings { 
    /**

     * Sets whether JavaScript running in the context of a file scheme URL

     * should be allowed to access content from other file scheme URLs. To

     * enable the most restrictive, and therefore secure policy, this setting

     * enable the most restrictive, and therefore secure, policy this setting

     * should be disabled. Note that the value of this setting is ignored if

     * the value of {@link #getAllowUniversalAccessFromFileURLs} is {@code true}.

     * Note too, that this setting affects only JavaScript access to file scheme

     * resources. Other access to such resources, for example, from image HTML

     * elements, is unaffected. To prevent possible violation of same domain policy

     * on {@link android.os.Build.VERSION_CODES#ICE_CREAM_SANDWICH} and earlier

     * devices, you should explicitly set this value to {@code false}.

     * when targeting {@link android.os.Build.VERSION_CODES#ICE_CREAM_SANDWICH_MR1} and earlier,

     * you should explicitly set this value to {@code false}.

     * <p>

     * The default value is {@code true} for API level

     * The default value is {@code true} for apps targeting

     * {@link android.os.Build.VERSION_CODES#ICE_CREAM_SANDWICH_MR1} and below,

     * and {@code false} for API level {@link android.os.Build.VERSION_CODES#JELLY_BEAN}

     * and {@code false} when targeting {@link android.os.Build.VERSION_CODES#JELLY_BEAN}

     * and above.

     *

     * @param flag whether JavaScript running in the context of a file scheme