CookieSyncManager
classCookieSyncManager: Runnable
kotlin.Any | |
↳ | android.webkit.CookieSyncManager |
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 android.webkit.WebViewClient#onPageFinished
. 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! |
Singleton access to a |
Unit |
resetSync() resets sync manager's timer. |
Unit |
run() |
Unit |
startSync() requests sync manager to start sync. |
Unit |
stopSync() stopSync() requests sync manager to stop sync. |
Unit |
sync() sync() forces sync manager to sync now |
Protected methods | |
---|---|
Unit |
Public methods
createInstance
static funcreateInstance(context: Context!): CookieSyncManager!
Deprecated: Deprecated in Java.
Create a singleton CookieSyncManager within a context
Parameters | |
---|---|
context |
Context!: |
Return | |
---|---|
CookieSyncManager! |
CookieSyncManager |
getInstance
static fungetInstance(): CookieSyncManager!
Deprecated: Deprecated in Java.
Singleton access to a CookieSyncManager
. An IllegalStateException will be thrown if CookieSyncManager#createInstance(Context)
is not called before.
Return | |
---|---|
CookieSyncManager! |
CookieSyncManager |
resetSync
funresetSync(): Unit
Deprecated: Calling resetSync is no longer necessary as the WebView automatically syncs cookies.
resetSync() resets sync manager's timer.
startSync
funstartSync(): Unit
Deprecated: Calling startSync is no longer necessary as the WebView automatically syncs cookies.
startSync() requests sync manager to start sync.
stopSync
funstopSync(): Unit
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
funsync(): Unit
Deprecated: Use CookieManager#flush
instead.
sync() forces sync manager to sync now
Protected methods
syncFromRamToFlash
protected funsyncFromRamToFlash(): Unit
Deprecated: Use CookieManager#flush
instead.