ardi::item::module

Interact with items of type module.

Supported property names are: -name -config -parent. All properties available can be passed via the "create" API or modified on an existing item via the "set" API.

ardi::item::module::create args

Creates an item of type "module".
Parameters
For a full list of property names, see above.
Returns
The ID of the item or tcl-error in case an error occurred during creation. i.e ardi::item::module create -name "My Module" -config "CapturePagesAndWindows" -parent $rootid

ardi::item::module::delete args

Deletes the item with the specified ID.
Parameters
-id (mandatory)
value: item ID. The item ID which is returned by the corresponding "create" API.
default value: ""
Returns
1 for ok
tcl-error in case of error i.e ardi::item::module delete -id $id

ardi::item::module::get args

Queries the value of one property.
Parameters
-id (mandatory)
value: item ID. The item ID which is returned by the corresponding "create" API.
default value: ""
For a full list of property names, see above.
Returns
The value of the specified property or tcl-error in case of error usage: ardi::item::module get -id $id -property parent

ardi::item::module::getpropertyid args

Queries id of property.
Parameters
-id
value: item ID
-key
value: property key

ardi::item::module::getpropertykeylist args

Queries list of properties.
Parameters
-id
value: item ID
Returns
list of property keys for a particular item ID

ardi::item::module::set args

Sets one or multiple parameters to specified values. The type of the item is assigned upon creation and cannot be changed after.
Parameters
-id (mandatory)
value: item ID. The item ID which is returned by the corresponding "create" API.
default value: ""
For a full list of property names, see above.
Returns
1 for ok
tcl-error in case of error i.e ardi::item::module set -id $id -name "My Module" -config "CapturePagesAndWindows" -parent $parentid