Difference between revisions of "CatTaskScheduleHelper class"

From Catglobe Wiki
Jump to: navigation, search
(Tag: visualeditor-switched)
Line 22: Line 22:
 
{{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> ===
 +
<source lang="javascript">
 +
CatTaskScheduleHelper csHelper = new CatTaskScheduleHelper();
 +
number taskId = 54183;
 +
CatTaskNeverSchedule schedule = new CatTaskNeverSchedule();
 +
csHelper.RescheduleByMetaDataId(taskId, schedule);
 +
</source>

Revision as of 03:26, 31 May 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
  • 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);