Help Center

Local Navigation

Object: Storage

Availability

BlackBerry® Device Software version 6.0 or later

The Storage object is used to storage a collection of key/value pairs.

Storage objects are instantiated as one of the following types:

  • sessionStorage: Storage objects of this type let you to store data only for the duration of the current browser session. Once the session is closed on the device, the storage object and the data it contains is deleted.

  • localStorage: Storage objects of this type let you store data that persists across browser sessions. When you create a new localStorage object, it is stored based on the origin domain of the original HTML document.

    The BlackBerry Browser follows the same-origin policy for allowing access to localStorage objects. Web applications are only permitted to access those objects with the same scheme, domain, and port number, as the application. An application can access a localStorage object only by using path names that are relative to the origin domain.

You can assign a key/value pair to a Storage object by using the setItem() method. For example:

localStorage.setItem("name1", value1);

Alternatively, you can index the objects directly using square brackets. For example:

localStorage["name1"] = value1;

Storage properties

Property name

Type

Description

Status

Support level

Availability

length

unsigned long

Returns the number of key/value pairs contained by the Storage object.

read only

HTML 5

6.0 or later

Storage methods

Method name

Description

Support level

Availability

clear()

Empties the Storage object of any contained key/value pairs.

HTML 5

6.0 or later

getItem()

Returns a structured clone of the current value of the given key, if it exists.

HTML 5

6.0 or later

key()

Returns the key at the given position in the list of keys contained by the Storage object.

HTML 5

6.0 or later

removeItem()

Removes the key/value pair with the given key from the Storage object, if it exists.

HTML 5

6.0 or later

setItem()

Adds a new key/value pair to the list of key/value pairs contained by the Storage object.

HTML 5

6.0 or later

Previous topic: Database methods

Was this information helpful? Send us your comments.