FireSync API
 All Classes Files Functions Variables Typedefs Friends Macros Modules Pages
kActions.h
Go to the documentation of this file.
1 
8 #ifndef K_FIRESYNC_ACTIONS_H
9 #define K_FIRESYNC_ACTIONS_H
10 
11 #include <kFireSync/kNodeDef.h>
12 
13 kBeginHeader()
14 
15 
21 //typedef kObject kActions; --forward-declared in kFsDef.x.h
22 
23 
33 kFsFx(kSize) kActions_TypeCount(kActions actions);
34 
43 kFsFx(const kChar*) kActions_TypeNameAt(kActions actions, kSize index);
44 
53 kFsFx(const kChar*) kActions_TypeDescriptionAt(kActions actions, kSize index);
54 
62 kFsFx(kStatus) kActions_Clear(kActions actions);
63 
78 kFsFx(kStatus) kActions_AddAction(kActions actions, const kChar* typeName, const kChar* name, kAction* action);
79 
88 kFsFx(kStatus) kActions_DeleteAction(kActions actions, kAction action);
89 
99 kFsFx(kStatus) kActions_FindAction(kActions actions, const kChar* name, kAction* action);
100 
108 kFsFx(kSize) kActions_ActionCount(kActions actions);
109 
118 kFsFx(kAction) kActions_ActionAt(kActions actions, kSize index);
119 
138 kFsFx(kStatus) kActions_Invoke(kActions actions, const kChar* typeName, kXml config, kObject input, kObject* output, kAlloc alloc);
139 
140 kEndHeader()
141 
142 #include <kFireSync/Client/kActions.x.h>
143 
144 #endif
kActions::kActions_AddAction
kStatus kActions_AddAction(kActions actions, const kChar *typeName, const kChar *name, kAction *action)
Creates and adds a new action to the actions collection.
kActions::kActions_TypeNameAt
const kChar * kActions_TypeNameAt(kActions actions, kSize index)
Gets the name of the action type at the specified index.
kNodeDef.h
Essential declarations related to FireSync nodes.
kAction
Represents action configuration.
kActions::kActions_TypeCount
kSize kActions_TypeCount(kActions actions)
Gets the number of action types currently available on this node.
kActions::kActions_Invoke
kStatus kActions_Invoke(kActions actions, const kChar *typeName, kXml config, kObject input, kObject *output, kAlloc alloc)
Invokes an action of the given type.
kActions::kActions_TypeDescriptionAt
const kChar * kActions_TypeDescriptionAt(kActions actions, kSize index)
Gets a description of the action type at the specified index.
kActions::kActions_ActionAt
kAction kActions_ActionAt(kActions actions, kSize index)
Gets the action at the specified index.
kActions::kActions_DeleteAction
kStatus kActions_DeleteAction(kActions actions, kAction action)
Destroys the specified action and removes it from the actions collection.
kActions::kActions_ActionCount
kSize kActions_ActionCount(kActions actions)
Gets the total number of actions belonging to the actions collection.
kActions
Represents configuration for a collection of actions.
kActions::kActions_FindAction
kStatus kActions_FindAction(kActions actions, const kChar *name, kAction *action)
Finds an existing action by name.
kActions::kActions_Clear
kStatus kActions_Clear(kActions actions)
Resets actions collection settings to defaults.