FireSync API
 All Classes Files Functions Variables Typedefs Friends Macros Modules Pages
kAction.h
Go to the documentation of this file.
1 
8 #ifndef K_FIRESYNC_ACTION_H
9 #define K_FIRESYNC_ACTION_H
10 
11 #include <kFireSync/kNodeDef.h>
12 #include <kFireSync/Action/kAxAction.h>
13 
20 //typedef kObject kAction; --forward-declared in kFsDef.x.h
21 
30 kFsFx(kStatus) kAction_SetName(kAction action, const kChar* name);
31 
39 kFsFx(const kChar*) kAction_Name(kAction action);
40 
48 kFsFx(const kChar*) kAction_TypeName(kAction action);
49 
58 kFsFx(kStatus) kAction_SetTrigger(kAction action, kActionTrigger triggerType);
59 
67 kFsFx(kActionTrigger) kAction_Trigger(kAction action);
68 
82 kFsFx(kStatus) kAction_SetConfig(kAction action, kXml settings);
83 
92 kFsFx(kStatus) kAction_Config(kAction action, kXml settings);
93 
107 kFsFx(kStatus) kAction_Invoke(kAction action, kObject input, kObject* output, kAlloc alloc);
108 
121 kFsFx(kStatus) kAction_InvokeAndSync(kAction action, kObject input, kObject* output, kAlloc alloc);
122 
123 #include <kFireSync/Client/kAction.x.h>
124 
125 #endif
kAction::kAction_Invoke
kStatus kAction_Invoke(kAction action, kObject input, kObject *output, kAlloc alloc)
Invokes this action without applying the current settings to this node first.
kAction::kAction_Name
const kChar * kAction_Name(kAction action)
Gets a descriptive name for this action.
kAction::kAction_SetConfig
kStatus kAction_SetConfig(kAction action, kXml settings)
Sets configuration for the action.
kAction::kAction_InvokeAndSync
kStatus kAction_InvokeAndSync(kAction action, kObject input, kObject *output, kAlloc alloc)
Applies current setting to the node and invokes this action.
kActionTrigger
Represents an action trigger type.
kAction::kAction_SetName
kStatus kAction_SetName(kAction action, const kChar *name)
Sets a descriptive name for the action.
kNodeDef.h
Essential declarations related to FireSync nodes.
kAction
Represents action configuration.
kAction::kAction_Config
kStatus kAction_Config(kAction action, kXml settings)
Gets configuration for the action.
kAction::kAction_Trigger
kActionTrigger kAction_Trigger(kAction action)
Gets the trigger type for the action.
kAction::kAction_SetTrigger
kStatus kAction_SetTrigger(kAction action, kActionTrigger triggerType)
Sets the trigger type for the action.
kAction::kAction_TypeName
const kChar * kAction_TypeName(kAction action)
Gets the type name of this action.
kAxAction.h
Declares the kAxAction class and related types.