Added in API level 5

WebStorage


open class WebStorage
kotlin.Any
   ↳ android.webkit.WebStorage

This class is used to manage the JavaScript storage APIs provided by the WebView. It manages the Web SQL Database API and the HTML5 Web Storage API. The Web SQL Database API provides storage which is private to a given origin. Use of the Web SQL Database can be attributed to an origin. It is also possible to set per-origin quotas.

Summary

Nested classes
open

This class encapsulates information about the amount of storage currently used by an origin for the JavaScript storage APIs.

abstract

Encapsulates a callback function which is used to provide a new quota for a JavaScript storage API.

Public methods
open Unit

Clears all storage currently being used by the JavaScript storage APIs.

open Unit
deleteOrigin(origin: String!)

Clears the storage currently being used by the Web SQL Database APIs by the given origin.

open static WebStorage!

Gets the singleton instance of this class.

open Unit

Gets the origins currently using the Web SQL Database APIs.

open Unit
getQuotaForOrigin(origin: String!, callback: ValueCallback<Long!>!)

Gets the storage quota for the Web SQL Database API for the given origin.

open Unit
getUsageForOrigin(origin: String!, callback: ValueCallback<Long!>!)

Gets the amount of storage currently being used by the Web SQL Database APIs by the given origin.

open Unit
setQuotaForOrigin(origin: String!, quota: Long)

Sets the storage quota for the Web SQL Database API for the given origin.

Public methods

deleteAllData

Added in API level 7
open fun deleteAllData(): Unit

Clears all storage currently being used by the JavaScript storage APIs. This includes Web SQL Database and the HTML5 Web Storage APIs.

deleteOrigin

Added in API level 7
open fun deleteOrigin(origin: String!): Unit

Clears the storage currently being used by the Web SQL Database APIs by the given origin. The origin is specified using its string representation.

getInstance

Added in API level 7
open static fun getInstance(): WebStorage!

Gets the singleton instance of this class.

Return
WebStorage! the singleton WebStorage instance

getOrigins

Added in API level 7
open fun getOrigins(callback: ValueCallback<MutableMap<Any?, Any?>!>!): Unit

Gets the origins currently using the Web SQL Database APIs. This method operates asynchronously, with the result being provided via a ValueCallback. The origins are provided as a map, of type Map<String, WebStorage.Origin>, from the string representation of the origin to a WebStorage.Origin object.

getQuotaForOrigin

Added in API level 7
open fun getQuotaForOrigin(
    origin: String!,
    callback: ValueCallback<Long!>!
): Unit

Gets the storage quota for the Web SQL Database API for the given origin. The quota is given in bytes and the origin is specified using its string representation. This method operates asynchronously, with the result being provided via a ValueCallback.

getUsageForOrigin

Added in API level 7
open fun getUsageForOrigin(
    origin: String!,
    callback: ValueCallback<Long!>!
): Unit

Gets the amount of storage currently being used by the Web SQL Database APIs by the given origin. The amount is given in bytes and the origin is specified using its string representation. This method operates asynchronously, with the result being provided via a ValueCallback.

setQuotaForOrigin

Added in API level 7
Deprecated in API level 18
open fun setQuotaForOrigin(
    origin: String!,
    quota: Long
): Unit

Deprecated: Controlling quota per-origin will not be supported in future.

Sets the storage quota for the Web SQL Database API for the given origin. The quota is specified in bytes and the origin is specified using its string representation.