Difference between revisions of "CatTaskScheduleHelper class"
Nguyenduyan (talk | contribs) (Tag: visualeditor-switched) |
Nguyenduyan (talk | contribs) |
||
Line 11: | Line 11: | ||
{{CGscriptParameters_Template|Type=int|Name=<nowiki>taskId</nowiki>|Description=<nowiki>Id of a task</nowiki>}} | {{CGscriptParameters_Template|Type=int|Name=<nowiki>taskId</nowiki>|Description=<nowiki>Id of a task</nowiki>}} | ||
|Description=<nowiki>From a task, find its schedule</nowiki>}} | |Description=<nowiki>From a task, find its schedule</nowiki>}} | ||
+ | {{CGscriptMethods_Template|ReturnType=CatTaskStatus|Name=<nowiki>GetTaskStatusByInstanceId</nowiki>|Parameters= | ||
+ | {{CGscriptParameters_Template|Type=int|Name=<nowiki>instanceId</nowiki>|Description=<nowiki>Id of an instance of a task</nowiki>}} | ||
+ | |Description=<nowiki>From an instance, get the execution status</nowiki>}} | ||
{{CGscriptMethods_Template|ReturnType=Empty|Name=<nowiki>RescheduleByInstanceId</nowiki>|Parameters= | {{CGscriptMethods_Template|ReturnType=Empty|Name=<nowiki>RescheduleByInstanceId</nowiki>|Parameters= | ||
{{CGscriptParameters_Template|Type=int|Name=<nowiki>instanceId</nowiki>|Description=<nowiki>Id of an instance of a task</nowiki>|Comma=,}}{{CGscriptParameters_Template|Type=CatTaskSchedule|Name=<nowiki>schedule</nowiki>|Description=<nowiki>The new schedule to use</nowiki>}} | {{CGscriptParameters_Template|Type=int|Name=<nowiki>instanceId</nowiki>|Description=<nowiki>Id of an instance of a task</nowiki>|Comma=,}}{{CGscriptParameters_Template|Type=CatTaskSchedule|Name=<nowiki>schedule</nowiki>|Description=<nowiki>The new schedule to use</nowiki>}} | ||
Line 22: | Line 25: | ||
{{CGscriptProperties_Template|ReturnType=TypeInformation|Name=<nowiki>TypeInformation</nowiki>|HasGetter=1|Description=<nowiki>Get information about this class.</nowiki>}} | {{CGscriptProperties_Template|ReturnType=TypeInformation|Name=<nowiki>TypeInformation</nowiki>|HasGetter=1|Description=<nowiki>Get information about this class.</nowiki>}} | ||
}} | }} | ||
+ | |||
=== <span style="color:#DF8621">'''Examples'''</span> === | === <span style="color:#DF8621">'''Examples'''</span> === | ||
<source lang="javascript"> | <source lang="javascript"> |
Revision as of 10:09, 12 July 2017
CatTaskScheduleHelper
Helper class for scheduling CatTasks
Constructors
- () - Instanciate helper
Methods
- CatTaskSchedule GetScheduleByInstanceId(int instanceId "Id of an instance of a task") - From an instance, find the task and find its schedule
- CatTaskSchedule GetScheduleByMetaDataId(int taskId "Id of a task") - From a task, find its schedule
- CatTaskStatus GetTaskStatusByInstanceId(int instanceId "Id of an instance of a task") - From an instance, get the execution status
- Empty RescheduleByInstanceId(int instanceId "Id of an instance of a task", CatTaskSchedule schedule "The new schedule to use") - From an instance, find the task and alter its schedule
- Empty RescheduleByMetaDataId(int taskId "Id of a task", CatTaskSchedule schedule "The new schedule to use") - From a task, alter its schedule
- string ToString() - The string representation of the object.
Properties
- string ObjectTypeName { get; } - The name of the type of object.
- TypeInformation TypeInformation { get; } - Get information about this class.
Examples
CatTaskScheduleHelper csHelper = new CatTaskScheduleHelper();
number taskId = 54183;
CatTaskNeverSchedule schedule = new CatTaskNeverSchedule();
csHelper.RescheduleByMetaDataId(taskId, schedule);