Interface representing a simple storage system. More...
import "extIApplication.idl";
Collaboration diagram for extISessionStorage:
Public Member Functions | |
| NS_SCRIPTABLE NS_IMETHOD | GetEvents (extIEvents **aEvents)=0 |
| Interface representing a simple storage system. | |
| NS_SCRIPTABLE NS_IMETHOD | Has (const nsAString &aName, PRBool *_retval NS_OUTPARAM)=0 |
| Determines if a storage item exists with the given name. | |
| NS_SCRIPTABLE NS_IMETHOD | Set (const nsAString &aName, nsIVariant *aValue)=0 |
| Sets the value of a storage item with the given name. | |
| NS_SCRIPTABLE NS_IMETHOD | Get (const nsAString &aName, nsIVariant *aDefaultValue, nsIVariant **_retval NS_OUTPARAM)=0 |
| Gets the value of a storage item with the given name. | |
| boolean | has (in AString aName) |
| Determines if a storage item exists with the given name. | |
| void | set (in AString aName, in nsIVariant aValue) |
| Sets the value of a storage item with the given name. | |
| nsIVariant | get (in AString aName, in nsIVariant aDefaultValue) |
| Gets the value of a storage item with the given name. | |
Public Attributes | |
| readonly attribute extIEvents | events |
| The events object for the storage supports: "change". | |
Detailed Description
Interface representing a simple storage system.
Member Function Documentation
| NS_SCRIPTABLE NS_IMETHOD extISessionStorage::Get | ( | const nsAString & | aName, | |
| nsIVariant * | aDefaultValue, | |||
| nsIVariant **_retval | NS_OUTPARAM | |||
| ) | [pure virtual] |
Gets the value of a storage item with the given name.
Returns a default value if the item does not exist.
- Parameters:
-
aName The name of an item aDefaultValue The value to return if no item exists with the given name
- Returns:
- value of the item or the given default value if no item exists with the given name.
| nsIVariant extISessionStorage::get | ( | in AString | aName, | |
| in nsIVariant | aDefaultValue | |||
| ) |
Gets the value of a storage item with the given name.
Returns a default value if the item does not exist.
- Parameters:
-
aName The name of an item aDefaultValue The value to return if no item exists with the given name
- Returns:
- value of the item or the given default value if no item exists with the given name.
| NS_SCRIPTABLE NS_IMETHOD extISessionStorage::GetEvents | ( | extIEvents ** | aEvents | ) | [pure virtual] |
Interface representing a simple storage system.
The events object for the storage supports: "change"
| boolean extISessionStorage::has | ( | in AString | aName | ) |
Determines if a storage item exists with the given name.
- Parameters:
-
aName The name of an item
- Returns:
- true if an item exists with the given name, false otherwise.
| NS_SCRIPTABLE NS_IMETHOD extISessionStorage::Has | ( | const nsAString & | aName, | |
| PRBool *_retval | NS_OUTPARAM | |||
| ) | [pure virtual] |
Determines if a storage item exists with the given name.
- Parameters:
-
aName The name of an item
- Returns:
- true if an item exists with the given name, false otherwise.
| NS_SCRIPTABLE NS_IMETHOD extISessionStorage::Set | ( | const nsAString & | aName, | |
| nsIVariant * | aValue | |||
| ) | [pure virtual] |
Sets the value of a storage item with the given name.
- Parameters:
-
aName The name of an item aValue The value to assign to the item
| void extISessionStorage::set | ( | in AString | aName, | |
| in nsIVariant | aValue | |||
| ) |
Sets the value of a storage item with the given name.
- Parameters:
-
aName The name of an item aValue The value to assign to the item
Member Data Documentation
| readonly attribute extIEvents extISessionStorage::events |
The events object for the storage supports: "change".
The documentation for this interface was generated from the following files:
