goog.storage.mechanism.IEUserData

Provided By	`goog.storage.mechanism.IEUserData`
Extends	`goog.storage.mechanism.IterableMechanism` `goog.storage.mechanism.Mechanism`
All Implemented Interfaces	`Iterable<string>`

Provides a storage mechanism using IE userData.

new IEUserData( `storageKey`, `opt_storageNodeId` )

Parameters

`storageKey`	`string`
	The key (store name) to store the data under.
`opt_storageNodeId`	`string=`
	The ID of the associated HTML element, one will be created if not provided.

Instance Methods

Returns an iterator that iterates over the elements in the storage. Will throw goog.iter.StopIteration after the last element.

Overrides

goog.storage.mechanism.IterableMechanism

Parameters

`opt_keys`	`boolean=`
	True to iterate over the keys. False to iterate over the values. The default value is false.

Returns

goog.iter.Iterator

The iterator.

Remove all key-value pairs.

Could be overridden in a subclass, as the default implementation is not very efficient - it iterates over all keys.

Overrides	`goog.storage.mechanism.IterableMechanism`
Parameters	None.

Get the value stored under a key.

Overrides

goog.storage.mechanism.Mechanism

Parameters

`key`	`string`
	The key to get.

Returns

(string|null)

The corresponding value, null if not found.

Get the number of stored key-value pairs.

Could be overridden in a subclass, as the default implementation is not very efficient - it iterates over all keys.

Overrides

goog.storage.mechanism.IterableMechanism

Parameters

None.

Returns

number

Number of stored elements.

Determines whether or not the mechanism is available.

Parameters

None.

Returns

boolean

True if the mechanism is available.

Remove a key and its value.

Overrides

goog.storage.mechanism.Mechanism

Parameters

`key`	`string`
	The key to remove.

Set a value for a key.

Overrides

goog.storage.mechanism.Mechanism

Parameters

`key`	`string`
	The key to set.
`value`	`string`
	The string to save.

Static Properties

Encoding map for characters which are not encoded by encodeURIComponent(). See encodeKey_ documentation for encoding details.