FireSync API
 All Classes Files Functions Variables Typedefs Friends Macros Modules Pages
kActions Class Reference

Description

Represents configuration for a collection of actions.

Inheritance diagram for kActions:
Inheritance graph

Public Member Functions

kAction kActions_ActionAt (kActions actions, kSize index)
 Gets the action at the specified index. More...
 
kSize kActions_ActionCount (kActions actions)
 Gets the total number of actions belonging to the actions collection. More...
 
kStatus kActions_AddAction (kActions actions, const kChar *typeName, const kChar *name, kAction *action)
 Creates and adds a new action to the actions collection. More...
 
kStatus kActions_Clear (kActions actions)
 Resets actions collection settings to defaults. More...
 
kStatus kActions_DeleteAction (kActions actions, kAction action)
 Destroys the specified action and removes it from the actions collection. More...
 
kStatus kActions_FindAction (kActions actions, const kChar *name, kAction *action)
 Finds an existing action by name. More...
 
kStatus kActions_Invoke (kActions actions, const kChar *typeName, kXml config, kObject input, kObject *output, kAlloc alloc)
 Invokes an action of the given type without applying the current settings to this node first. More...
 
kStatus kActions_InvokeAndSync (kActions actions, const kChar *typeName, kXml config, kObject input, kObject *output, kAlloc alloc)
 Applies current setting to the node and invokes an action of the given type. More...
 
kSize kActions_TypeCount (kActions actions)
 Gets the number of action types currently available on this node. More...
 
const kCharkActions_TypeDescriptionAt (kActions actions, kSize index)
 Gets a description of the action type at the specified index. More...
 
const kCharkActions_TypeNameAt (kActions actions, kSize index)
 Gets the name of the action type at the specified index. More...
 

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