Added in API level 1
Deprecated in API level 21

Summary: Methods | Protected Methods | Inherited Methods

CookieSyncManager

Kotlin |Java

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 CookieManager.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 WebViewClient.onPageFinished(WebView, String). Note that even sync() happens asynchronously, so don't do it just as your activity is shutting down.

Summary

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 `CookieManager.flush` instead.

Protected methods
`void`	`syncFromRamToFlash()` This method is deprecated. Use `CookieManager.flush` instead.

Inherited methods

From class


        
          java.lang.Object

`Object`	`clone()` Creates and returns a copy of this object.
`boolean`	`equals(Object obj)` Indicates whether some other object is "equal to" this one.
`void`	`finalize()` Called by the garbage collector on an object when garbage collection determines that there are no more references to the object.
`final Class<?>`	`getClass()` Returns the runtime class of this `Object`.
`int`	`hashCode()` Returns a hash code value for the object.
`final void`	`notify()` Wakes up a single thread that is waiting on this object's monitor.
`final void`	`notifyAll()` Wakes up all threads that are waiting on this object's monitor.
`String`	`toString()` Returns a string representation of the object.
`final void`	`wait(long timeoutMillis, int nanos)` Causes the current thread to wait until it is awakened, typically by being notified or interrupted, or until a certain amount of real time has elapsed.
`final void`	`wait(long timeoutMillis)` Causes the current thread to wait until it is awakened, typically by being notified or interrupted, or until a certain amount of real time has elapsed.
`final void`	`wait()` Causes the current thread to wait until it is awakened, typically by being notified or interrupted.

From interface


        
          java.lang.Runnable


      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.

Public methods

createInstance

Added in API level 1

public static CookieSyncManager createInstance (Context context)

Create a singleton CookieSyncManager within a context

Returns
`CookieSyncManager`	CookieSyncManager

getInstance

Added in API level 1

public static CookieSyncManager getInstance ()

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

Returns
`CookieSyncManager`	CookieSyncManager

resetSync

Added in API level 1

public 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

public 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

public 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

public 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

public void sync ()

This method is deprecated.
Use CookieManager.flush instead.

sync() forces sync manager to sync now

Protected methods

syncFromRamToFlash

Added in API level 1

protected void syncFromRamToFlash ()

This method is deprecated.
Use CookieManager.flush instead.