Skip to content

Most visited

Recently visited

navigation
Added in API level 1
Deprecated since API level 21

CookieSyncManager

public final class CookieSyncManager
extends Object implements Runnable

java.lang.Object
   ↳ android.webkit.CookieSyncManager


This class was deprecated in API level 21.
The WebView now automatically syncs cookies as necessary. You no longer need to create or use the CookieSyncManager. To manually force a sync you can use the CookieManager method flush() which is a synchronous replacement for sync().

The CookieSyncManager is used to synchronize the browser cookie store between RAM and permanent storage. To get the best performance, browser cookies are saved in RAM. A separate thread saves the cookies between, driven by a timer.

To use the CookieSyncManager, the host application has to call the following when the application starts:

CookieSyncManager.createInstance(context)

To set up for sync, the host application has to call

CookieSyncManager.getInstance().startSync()

in Activity.onResume(), and call

 CookieSyncManager.getInstance().stopSync()
 

in Activity.onPause().

To get instant sync instead of waiting for the timer to trigger, the host can call

CookieSyncManager.getInstance().sync()

The sync interval is 5 minutes, so you will want to force syncs manually anyway, for instance in onPageFinished(WebView, String). Note that even sync() happens asynchronously, so don't do it just as your activity is shutting down.

Summary

Constants

String LOGTAG

Fields

protected WebViewDatabase mDataBase

protected Handler mHandler

Public methods

static CookieSyncManager createInstance(Context context)

Create a singleton CookieSyncManager within a context

static CookieSyncManager getInstance()

Singleton access to a CookieSyncManager.

void resetSync()

This method is deprecated. Calling resetSync is no longer necessary as the WebView automatically syncs cookies.

void run()

When an object implementing interface Runnable is used to create a thread, starting the thread causes the object's run method to be called in that separately executing thread.

void startSync()

This method is deprecated. Calling startSync is no longer necessary as the WebView automatically syncs cookies.

void stopSync()

This method is deprecated. Calling stopSync is no longer useful as the WebView automatically syncs cookies.

void sync()

This method is deprecated. Use flush() instead.

Protected methods

Object clone()

Creates and returns a copy of this object.

void onSyncInit()
void syncFromRamToFlash()

This method was deprecated in API level 21. Use flush() instead.

Inherited methods

From class java.lang.Object
From interface java.lang.Runnable

Constants

LOGTAG

Added in API level 21
String LOGTAG

Constant Value: "websync"

Fields

mDataBase

Added in API level 21
WebViewDatabase mDataBase

mHandler

Added in API level 21
Handler mHandler

Public methods

createInstance

Added in API level 1
CookieSyncManager createInstance (Context context)

Create a singleton CookieSyncManager within a context

Returns
CookieSyncManager CookieSyncManager

getInstance

Added in API level 1
CookieSyncManager getInstance ()

Singleton access to a CookieSyncManager. An IllegalStateException will be thrown if createInstance(Context) is not called before.

Returns
CookieSyncManager CookieSyncManager

resetSync

Added in API level 1
void resetSync ()

This method is deprecated.
Calling resetSync is no longer necessary as the WebView automatically syncs cookies.

resetSync() resets sync manager's timer.

run

Added in API level 1
void run ()

When an object implementing interface Runnable is used to create a thread, starting the thread causes the object's run method to be called in that separately executing thread.

The general contract of the method run is that it may take any action whatsoever.

startSync

Added in API level 1
void startSync ()

This method is deprecated.
Calling startSync is no longer necessary as the WebView automatically syncs cookies.

startSync() requests sync manager to start sync.

stopSync

Added in API level 1
void stopSync ()

This method is deprecated.
Calling stopSync is no longer useful as the WebView automatically syncs cookies.

stopSync() requests sync manager to stop sync. remove any SYNC_MESSAGE in the queue to break the sync loop

sync

Added in API level 1
void sync ()

This method is deprecated.
Use flush() instead.

sync() forces sync manager to sync now

Protected methods

clone

Added in API level 1
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

onSyncInit

Added in API level 1
void onSyncInit ()

syncFromRamToFlash

Added in API level 1
void syncFromRamToFlash ()

This method was deprecated in API level 21.
Use flush() instead.

This site uses cookies to store your preferences for site-specific language and display options.

Hooray!

This class requires API level or higher

This doc is hidden because your selected API level for the documentation is . You can change the documentation API level with the selector above the left navigation.

For more information about specifying the API level your app requires, read Supporting Different Platform Versions.