Helper Class Reference  1.3
HomeGenie - Automation Programs' Engine API
Public Member Functions | Properties | List of all members
StoreHelper Class Reference

Store helper class.
Class instance accessor: Program.Store(<store_name>) More...

Public Member Functions

ModuleParameter Get (string parameterName)
 Get the specified parameterName from the Store. More...
 
StoreHelper Remove (string parameterName)
 Remove the specified parameterName from the Store. More...
 
void Reset ()
 Remove all parameters from this store. More...
 

Properties

TsList< ModuleParameterList [get]
 Gets the list of parameters defined in the Store. More...
 

Detailed Description

Store helper class.
Class instance accessor: Program.Store(<store_name>)

Member Function Documentation

◆ Get()

ModuleParameter Get ( string  parameterName)

Get the specified parameterName from the Store.

Parameters
parameterNameParameter name.

◆ Remove()

StoreHelper Remove ( string  parameterName)

Remove the specified parameterName from the Store.

Parameters
parameterNameParameter name.

◆ Reset()

void Reset ( )

Remove all parameters from this store.

Property Documentation

◆ List

TsList<ModuleParameter> List
get

Gets the list of parameters defined in the Store.

The list.


The documentation for this class was generated from the following file: