来源:https://developer.android.com/reference/android/webkit/CookieManager
CookieManager
public abstract class CookieManager
extends Object
java.lang.Object | |
↳ | android.webkit.CookieManager |
Manages the cookies used by an application's WebView
instances. Cookies are manipulated according to RFC2109.
Summary
Public constructors |
|
---|---|
CookieManager() |
Public methods |
|
---|---|
abstract boolean |
acceptCookie() Gets whether the application's |
abstract boolean |
acceptThirdPartyCookies(WebView webview) Gets whether the |
static boolean |
allowFileSchemeCookies() Gets whether the application's |
abstract void |
flush() Ensures all cookies currently accessible through the getCookie API are written to persistent storage. |
abstract String |
getCookie(String url) Gets the cookies for the given URL. |
static CookieManager |
getInstance() Gets the singleton CookieManager instance. |
abstract boolean |
hasCookies() Gets whether there are stored cookies. |
abstract void |
removeAllCookie() This method was deprecated in API level 21. Use |
abstract void |
removeAllCookies(ValueCallback<Boolean> callback) Removes all cookies. |
abstract void |
removeExpiredCookie() This method was deprecated in API level 21. The WebView handles removing expired cookies automatically. |
abstract void |
removeSessionCookie() This method was deprecated in API level 21. use |
abstract void |
removeSessionCookies(ValueCallback<Boolean> callback) Removes all session cookies, which are cookies without an expiration date. |
abstract void |
setAcceptCookie(boolean accept) Sets whether the application's |
static void |
setAcceptFileSchemeCookies(boolean accept) Sets whether the application's |
abstract void |
setAcceptThirdPartyCookies(WebView webview, boolean accept) Sets whether the |
abstract void |
setCookie(String url, String value, ValueCallback<Boolean> callback) Sets a cookie for the given URL. |
abstract void |
setCookie(String url, String value) Sets a cookie for the given URL. |
Protected methods |
|
---|---|
Object |
clone() Creates and returns a copy of this object. |
Inherited methods |
|
---|---|
From class |
Public constructors
CookieManager
added in API level 22
public CookieManager ()
Public methods
acceptCookie
added in API level 1
public abstract boolean acceptCookie ()
Gets whether the application's WebView
instances send and accept cookies.
Returns | |
---|---|
boolean |
true if WebView instances send and accept cookies |
acceptThirdPartyCookies
added in API level 21
public abstract boolean acceptThirdPartyCookies (WebView webview)
Gets whether the WebView
should allow third party cookies to be set.
Parameters | |
---|---|
webview |
WebView : the WebView instance to get the cookie policy for |
Returns | |
---|---|
boolean |
true if the WebView accepts third party cookies |
allowFileSchemeCookies
added in API level 12
public static boolean allowFileSchemeCookies ()
Gets whether the application's WebView
instances send and accept cookies for file scheme URLs.
Returns | |
---|---|
boolean |
true if WebView instances send and accept cookies for file scheme URLs |
flush
added in API level 21
public abstract void flush ()
Ensures all cookies currently accessible through the getCookie API are written to persistent storage. This call will block the caller until it is done and may perform I/O.
getCookie
added in API level 1
public abstract String getCookie (String url)
Gets the cookies for the given URL.
Parameters | |
---|---|
url |
String : the URL for which the cookies are requested |
Returns | |
---|---|
String |
value the cookies as a string, using the format of the 'Cookie' HTTP request header |
getInstance
added in API level 1
public static CookieManager getInstance ()
Gets the singleton CookieManager instance.
Returns | |
---|---|
CookieManager |
the singleton CookieManager instance |
hasCookies
added in API level 1
public abstract boolean hasCookies ()
Gets whether there are stored cookies.
Returns | |
---|---|
boolean |
true if there are stored cookies |
removeAllCookie
added in API level 1
public abstract void removeAllCookie ()
This method was deprecated in API level 21.
Use removeAllCookies(ValueCallback)
instead.
Removes all cookies.
removeAllCookies
added in API level 21
public abstract void removeAllCookies (ValueCallback<Boolean> callback)
Removes all cookies.
This method is asynchronous. If a ValueCallback
is provided, onReceiveValue()
will be called on the current thread's Looper
once the operation is complete. The value provided to the callback indicates whether any cookies were removed. You can pass null
as the callback if you don't need to know when the operation completes or whether any cookies were removed, and in this case it is safe to call the method from a thread without a Looper.
Parameters | |
---|---|
callback |
ValueCallback : a callback which is executed when the cookies have been removed This value may be |
removeExpiredCookie
added in API level 1
public abstract void removeExpiredCookie ()
This method was deprecated in API level 21.
The WebView handles removing expired cookies automatically.
Removes all expired cookies.
removeSessionCookie
added in API level 1
public abstract void removeSessionCookie ()
This method was deprecated in API level 21.
use removeSessionCookies(ValueCallback)
instead.
Removes all session cookies, which are cookies without an expiration date.
removeSessionCookies
added in API level 21
public abstract void removeSessionCookies (ValueCallback<Boolean> callback)
Removes all session cookies, which are cookies without an expiration date.
This method is asynchronous. If a ValueCallback
is provided, onReceiveValue()
will be called on the current thread's Looper
once the operation is complete. The value provided to the callback indicates whether any cookies were removed. You can pass null
as the callback if you don't need to know when the operation completes or whether any cookie were removed, and in this case it is safe to call the method from a thread without a Looper.
Parameters | |
---|---|
callback |
ValueCallback : a callback which is executed when the session cookies have been removed This value may be |
setAcceptCookie
added in API level 1
public abstract void setAcceptCookie (boolean accept)
Sets whether the application's WebView
instances should send and accept cookies. By default this is set to true
and the WebView accepts cookies.
When this is true
setAcceptThirdPartyCookies
and setAcceptFileSchemeCookies
can be used to control the policy for those specific types of cookie.
Parameters | |
---|---|
accept |
boolean : whether WebView instances should send and accept cookies |
setAcceptFileSchemeCookies
added in API level 12
public static void setAcceptFileSchemeCookies (boolean accept)
Sets whether the application's WebView
instances should send and accept cookies for file scheme URLs. Use of cookies with file scheme URLs is potentially insecure and turned off by default. Do not use this feature unless you can be sure that no unintentional sharing of cookie data can take place.
Note that calls to this method will have no effect if made after a WebView
or CookieManager instance has been created.
Parameters | |
---|---|
accept |
boolean |
setAcceptThirdPartyCookies
added in API level 21
public abstract void setAcceptThirdPartyCookies (WebView webview, boolean accept)
Sets whether the WebView
should allow third party cookies to be set. Allowing third party cookies is a per WebView policy and can be set differently on different WebView instances.
Apps that target Build.VERSION_CODES.KITKAT
or below default to allowing third party cookies. Apps targetingBuild.VERSION_CODES.LOLLIPOP
or later default to disallowing third party cookies.
Parameters | |
---|---|
webview |
WebView : the WebView instance to set the cookie policy on |
accept |
boolean : whether the WebView instance should accept third party cookies |
setCookie
added in API level 21
public abstract void setCookie (String url, String value, ValueCallback<Boolean> callback)
Sets a cookie for the given URL. Any existing cookie with the same host, path and name will be replaced with the new cookie. The cookie being set will be ignored if it is expired.
This method is asynchronous. If a ValueCallback
is provided, onReceiveValue()
will be called on the current thread's Looper
once the operation is complete. The value provided to the callback indicates whether the cookie was set successfully. You can pass null
as the callback if you don't need to know when the operation completes or whether it succeeded, and in this case it is safe to call the method from a thread without a Looper.
Parameters | |
---|---|
url |
String : the URL for which the cookie is to be set |
value |
String : the cookie as a string, using the format of the 'Set-Cookie' HTTP response header |
callback |
ValueCallback : a callback to be executed when the cookie has been set This value may be |
setCookie
added in API level 1
public abstract void setCookie (String url, String value)
Sets a cookie for the given URL. Any existing cookie with the same host, path and name will be replaced with the new cookie. The cookie being set will be ignored if it is expired.
Parameters | |
---|---|
url |
String : the URL for which the cookie is to be set |
value |
String : the cookie as a string, using the format of the 'Set-Cookie' HTTP response header |
Protected methods
clone
added in API level 1
protected Object clone ()
Creates and returns a copy of this object. The precise meaning of "copy" may depend on the class of the object. The general intent is that, for any object x
, the expression:
x.clone() != x
will be true, and that the expression:
x.clone().getClass() == x.getClass()
will be true
, but these are not absolute requirements. While it is typically the case that:
x.clone().equals(x)
will be true
, this is not an absolute requirement.
By convention, the returned object should be obtained by calling super.clone
. If a class and all of its superclasses (except Object
) obey this convention, it will be the case that x.clone().getClass() == x.getClass()
.
By convention, the object returned by this method should be independent of this object (which is being cloned). To achieve this independence, it may be necessary to modify one or more fields of the object returned by super.clone
before returning it. Typically, this means copying any mutable objects that comprise the internal "deep structure" of the object being cloned and replacing the references to these objects with references to the copies. If a class contains only primitive fields or references to immutable objects, then it is usually the case that no fields in the object returned by super.clone
need to be modified.
The method clone
for class Object
performs a specific cloning operation. First, if the class of this object does not implement the interface Cloneable
, then a CloneNotSupportedException
is thrown. Note that all arrays are considered to implement the interface Cloneable
and that the return type of the clone
method of an array type T[]
is T[]
where T is any reference or primitive type. Otherwise, this method creates a new instance of the class of this object and initializes all its fields with exactly the contents of the corresponding fields of this object, as if by assignment; the contents of the fields are not themselves cloned. Thus, this method performs a "shallow copy" of this object, not a "deep copy" operation.
The class Object
does not itself implement the interface Cloneable
, so calling the clone
method on an object whose class is Object
will result in throwing an exception at run time.
Returns | |
---|---|
Object |
a clone of this instance. |
Throws | |
---|---|
CloneNotSupportedException |