Catglobe Wiki - Recent changes [en]

Task class

Antester@voxmeter.dk — Tue, 02 Jun 2026 10:36:27 GMT

← Older revision		Revision as of 10:36, 2 June 2026
Line 1:		Line 1:
	{{CGscriptClass_Template\|Name=<nowiki>Task</nowiki>\|Description=<nowiki>Represents a Task resource object.</nowiki>\|InheritsFrom=Array\|Constructors={{CGscriptConstructors_Template\|Parameters=		{{CGscriptClass_Template
			\|Name=<nowiki>Task</nowiki>
			\|Description=<nowiki>Represents a Task resource object.</nowiki>
			\|InheritsFrom=Array\|Constructors=
			{{CGscriptConstructors_Template\|Parameters=
	{{CGscriptParameters_Template\|Type=string\|Name=<nowiki>name</nowiki>\|Description=<nowiki>Name of the task</nowiki>\|Comma=,}}{{CGscriptParameters_Template\|Type=int\|Name=<nowiki>Parent resource id</nowiki>\|Description=<nowiki>Resource id of the parent</nowiki>}}		{{CGscriptParameters_Template\|Type=string\|Name=<nowiki>name</nowiki>\|Description=<nowiki>Name of the task</nowiki>\|Comma=,}}{{CGscriptParameters_Template\|Type=int\|Name=<nowiki>Parent resource id</nowiki>\|Description=<nowiki>Resource id of the parent</nowiki>}}
	\|Description=<nowiki>Creates a new task with the task name as description</nowiki>}}		\|Description=<nowiki>Creates a new task with the task name as description</nowiki>}}
Line 10:		Line 14:
	{{CGscriptConstructors_Template\|Parameters=		{{CGscriptConstructors_Template\|Parameters=
	{{CGscriptParameters_Template\|Type=string\|Name=<nowiki>name</nowiki>\|Description=<nowiki>Name of the task</nowiki>\|Comma=,}}{{CGscriptParameters_Template\|Type=int\|Name=<nowiki>Parent resource id</nowiki>\|Description=<nowiki>Resource id of the parent</nowiki>\|Comma=,}}{{CGscriptParameters_Template\|Type=string\|Name=<nowiki>description</nowiki>\|Description=<nowiki>Description of the task</nowiki>\|Comma=,}}{{CGscriptParameters_Template\|Type=int?\|Name=<nowiki>Task template</nowiki>\|Description=<nowiki>Resource id of the task template (0 for default)</nowiki>}}		{{CGscriptParameters_Template\|Type=string\|Name=<nowiki>name</nowiki>\|Description=<nowiki>Name of the task</nowiki>\|Comma=,}}{{CGscriptParameters_Template\|Type=int\|Name=<nowiki>Parent resource id</nowiki>\|Description=<nowiki>Resource id of the parent</nowiki>\|Comma=,}}{{CGscriptParameters_Template\|Type=string\|Name=<nowiki>description</nowiki>\|Description=<nowiki>Description of the task</nowiki>\|Comma=,}}{{CGscriptParameters_Template\|Type=int?\|Name=<nowiki>Task template</nowiki>\|Description=<nowiki>Resource id of the task template (0 for default)</nowiki>}}
	\|Description=<nowiki>Creates a new task with a custom description and a template</nowiki>}}\|Methods={{CGscriptMethods_Template\|ReturnType=Empty\|Name=<nowiki>Accept</nowiki>\|Description=<nowiki>Accepts this task using the current user</nowiki>}}		\|Description=<nowiki>Creates a new task with a custom description and a template</nowiki>}}
			\|Methods=
			{{CGscriptMethods_Template\|ReturnType=Empty\|Name=<nowiki>Accept</nowiki>\|Description=<nowiki>Accepts this task using the current user</nowiki>}}
	{{CGscriptMethods_Template\|ReturnType=Empty\|Name=<nowiki>Accept</nowiki>\|Parameters=		{{CGscriptMethods_Template\|ReturnType=Empty\|Name=<nowiki>Accept</nowiki>\|Parameters=
	{{CGscriptParameters_Template\|Type=int\|Name=<nowiki>User resource id</nowiki>\|Description=<nowiki>The user resource id</nowiki>}}		{{CGscriptParameters_Template\|Type=int\|Name=<nowiki>User resource id</nowiki>\|Description=<nowiki>The user resource id</nowiki>}}
Line 78:		Line 84:
	{{CGscriptMethods_Template\|ReturnType=Empty\|Name=<nowiki>this[] { get; }</nowiki>\|Parameters=		{{CGscriptMethods_Template\|ReturnType=Empty\|Name=<nowiki>this[] { get; }</nowiki>\|Parameters=
	{{CGscriptParameters_Template\|Type=int\|Name=<nowiki>index</nowiki>\|Description=<nowiki>Index</nowiki>\|Comma=,}}{{CGscriptParameters_Template\|Type=object\|Name=<nowiki>value</nowiki>\|Description=<nowiki>Value to set</nowiki>}}		{{CGscriptParameters_Template\|Type=int\|Name=<nowiki>index</nowiki>\|Description=<nowiki>Index</nowiki>\|Comma=,}}{{CGscriptParameters_Template\|Type=object\|Name=<nowiki>value</nowiki>\|Description=<nowiki>Value to set</nowiki>}}
	\|Description=<nowiki>Backward-compatible indexer</nowiki>}}\|Properties={{CGscriptProperties_Template\|ReturnType=number\|Name=<nowiki>Average</nowiki>\|HasGetter=1\|Description=<nowiki>Average of the objects in the Array object. Can only use if all the elements are of type Number</nowiki>}}		\|Description=<nowiki>Backward-compatible indexer</nowiki>}}
			\|Properties=
			{{CGscriptProperties_Template\|ReturnType=number\|Name=<nowiki>Average</nowiki>\|HasGetter=1\|Description=<nowiki>Average of the objects in the Array object. Can only use if all the elements are of type Number</nowiki>}}
	{{CGscriptProperties_Template\|ReturnType=int\|Name=<nowiki>CaseNumber</nowiki>\|HasGetter=1\|Description=<nowiki>The task case number</nowiki>}}		{{CGscriptProperties_Template\|ReturnType=int\|Name=<nowiki>CaseNumber</nowiki>\|HasGetter=1\|Description=<nowiki>The task case number</nowiki>}}
	{{CGscriptProperties_Template\|ReturnType=bool\|Name=<nowiki>Completed</nowiki>\|HasGetter=1\|HasSetter=1\|Description=<nowiki>Whether the task is completed</nowiki>}}		{{CGscriptProperties_Template\|ReturnType=bool\|Name=<nowiki>Completed</nowiki>\|HasGetter=1\|HasSetter=1\|Description=<nowiki>Whether the task is completed</nowiki>}}
Line 101:		Line 109:
	{{CGscriptProperties_Template\|ReturnType=bool\|Name=<nowiki>TimeRegistration</nowiki>\|HasGetter=1\|Description=<nowiki>Whether time registration is enabled</nowiki>}}		{{CGscriptProperties_Template\|ReturnType=bool\|Name=<nowiki>TimeRegistration</nowiki>\|HasGetter=1\|Description=<nowiki>Whether time registration is enabled</nowiki>}}
	{{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>}}
	{{CGscriptProperties_Template\|ReturnType=int\|Name=<nowiki>Version</nowiki>\|HasGetter=1\|Description=<nowiki>The task object version</nowiki>}}\|StaticMethods={{CGscriptMethods_Template\|ReturnType=Empty\|Name=<nowiki>Task_accept</nowiki>\|Parameters=		{{CGscriptProperties_Template\|ReturnType=int\|Name=<nowiki>Version</nowiki>\|HasGetter=1\|Description=<nowiki>The task object version</nowiki>}}
			\|StaticMethods=
			{{CGscriptMethods_Template\|ReturnType=Empty\|Name=<nowiki>Task_accept</nowiki>\|Parameters=
	{{CGscriptParameters_Template\|Type=int\|Name=<nowiki>Task resource id</nowiki>\|Description=<nowiki>The task resource id</nowiki>}}		{{CGscriptParameters_Template\|Type=int\|Name=<nowiki>Task resource id</nowiki>\|Description=<nowiki>The task resource id</nowiki>}}
	\|Description=<nowiki>Accepts the task using the current user</nowiki>}}		\|Description=<nowiki>Accepts the task using the current user</nowiki>}}
Line 134:		Line 144:
	{{CGscriptParameters_Template\|Type=int\|Name=<nowiki>Task resource id</nowiki>\|Description=<nowiki>The task resource id</nowiki>}}		{{CGscriptParameters_Template\|Type=int\|Name=<nowiki>Task resource id</nowiki>\|Description=<nowiki>The task resource id</nowiki>}}
	\|Description=<nowiki>Returns the completion deadline of the task, or empty if not set</nowiki>}}		\|Description=<nowiki>Returns the completion deadline of the task, or empty if not set</nowiki>}}
	~~{{CGscriptMethods_Template\|ReturnType=int?\|Name=<nowiki>Task_getResourceUniqueIdFromTaskCaseNumber</nowiki>\|Parameters=~~
	~~{{CGscriptParameters_Template\|Type=int\|Name=<nowiki>Task case number</nowiki>\|Description=<nowiki>The task case number</nowiki>}}~~
	~~\|Description=<nowiki>Returns the resource unique id for the task with the given case number, or empty if not found</nowiki>}}~~
	{{CGscriptMethods_Template\|ReturnType=bool\|Name=<nowiki>Task_getSendMailOnStatusChange</nowiki>\|Parameters=		{{CGscriptMethods_Template\|ReturnType=bool\|Name=<nowiki>Task_getSendMailOnStatusChange</nowiki>\|Parameters=
	{{CGscriptParameters_Template\|Type=int\|Name=<nowiki>Task resource id</nowiki>\|Description=<nowiki>The task resource id</nowiki>}}		{{CGscriptParameters_Template\|Type=int\|Name=<nowiki>Task resource id</nowiki>\|Description=<nowiki>The task resource id</nowiki>}}
Line 152:		Line 159:
	{{CGscriptParameters_Template\|Type=array\|Name=<nowiki>Task resource id</nowiki>\|Description=<nowiki>Array of task resource ids</nowiki>}}		{{CGscriptParameters_Template\|Type=array\|Name=<nowiki>Task resource id</nowiki>\|Description=<nowiki>Array of task resource ids</nowiki>}}
	\|Description=<nowiki>Returns the tasks with the given resource ids</nowiki>}}		\|Description=<nowiki>Returns the tasks with the given resource ids</nowiki>}}
			{{CGscriptMethods_Template\|ReturnType=Task\|Name=<nowiki>Task_new</nowiki>\|Parameters=
			{{CGscriptParameters_Template\|Type=string\|Name=<nowiki>name</nowiki>\|Description=<nowiki>Name of the task</nowiki>\|Comma=,}}{{CGscriptParameters_Template\|Type=int\|Name=<nowiki>Parent resource id</nowiki>\|Description=<nowiki>Resource id of the parent</nowiki>}}
			\|Obsolete=1
			\|Description=<nowiki>Initialises a new task object with the task name as description</nowiki>}}
			{{CGscriptMethods_Template\|ReturnType=Task\|Name=<nowiki>Task_new</nowiki>\|Parameters=
			{{CGscriptParameters_Template\|Type=string\|Name=<nowiki>name</nowiki>\|Description=<nowiki>Name of the task</nowiki>\|Comma=,}}{{CGscriptParameters_Template\|Type=int\|Name=<nowiki>Parent resource id</nowiki>\|Description=<nowiki>Resource id of the parent</nowiki>\|Comma=,}}{{CGscriptParameters_Template\|Type=int?\|Name=<nowiki>Task template</nowiki>\|Description=<nowiki>Resource id of the task template (0 for default)</nowiki>}}
			\|Obsolete=1
			\|Description=<nowiki>Initialises a new task object with the task name as description and a template</nowiki>}}
			{{CGscriptMethods_Template\|ReturnType=Task\|Name=<nowiki>Task_new</nowiki>\|Parameters=
			{{CGscriptParameters_Template\|Type=string\|Name=<nowiki>name</nowiki>\|Description=<nowiki>Name of the task</nowiki>\|Comma=,}}{{CGscriptParameters_Template\|Type=int\|Name=<nowiki>Parent resource id</nowiki>\|Description=<nowiki>Resource id of the parent</nowiki>\|Comma=,}}{{CGscriptParameters_Template\|Type=string\|Name=<nowiki>description</nowiki>\|Description=<nowiki>Description of the task</nowiki>}}
			\|Obsolete=1
			\|Description=<nowiki>Initialises a new task object with a custom description</nowiki>}}
			{{CGscriptMethods_Template\|ReturnType=Task\|Name=<nowiki>Task_new</nowiki>\|Parameters=
			{{CGscriptParameters_Template\|Type=string\|Name=<nowiki>name</nowiki>\|Description=<nowiki>Name of the task</nowiki>\|Comma=,}}{{CGscriptParameters_Template\|Type=int\|Name=<nowiki>Parent resource id</nowiki>\|Description=<nowiki>Resource id of the parent</nowiki>\|Comma=,}}{{CGscriptParameters_Template\|Type=string\|Name=<nowiki>description</nowiki>\|Description=<nowiki>Description of the task</nowiki>\|Comma=,}}{{CGscriptParameters_Template\|Type=int?\|Name=<nowiki>Task template</nowiki>\|Description=<nowiki>Resource id of the task template (0 for default)</nowiki>}}
			\|Obsolete=1
			\|Description=<nowiki>Initialises a new task object with a custom description and a template</nowiki>}}
	{{CGscriptMethods_Template\|ReturnType=Empty\|Name=<nowiki>Task_reassign</nowiki>\|Parameters=		{{CGscriptMethods_Template\|ReturnType=Empty\|Name=<nowiki>Task_reassign</nowiki>\|Parameters=
	{{CGscriptParameters_Template\|Type=int\|Name=<nowiki>Task resource id</nowiki>\|Description=<nowiki>The task resource id</nowiki>\|Comma=,}}{{CGscriptParameters_Template\|Type=int\|Name=<nowiki>Responsible resource id</nowiki>\|Description=<nowiki>The new responsible resource id</nowiki>\|Comma=,}}{{CGscriptParameters_Template\|Type=string\|Name=<nowiki>Content</nowiki>\|Description=<nowiki>The reassignment comment</nowiki>}}		{{CGscriptParameters_Template\|Type=int\|Name=<nowiki>Task resource id</nowiki>\|Description=<nowiki>The task resource id</nowiki>\|Comma=,}}{{CGscriptParameters_Template\|Type=int\|Name=<nowiki>Responsible resource id</nowiki>\|Description=<nowiki>The new responsible resource id</nowiki>\|Comma=,}}{{CGscriptParameters_Template\|Type=string\|Name=<nowiki>Content</nowiki>\|Description=<nowiki>The reassignment comment</nowiki>}}
Line 164:		Line 187:
	{{CGscriptParameters_Template\|Type=int\|Name=<nowiki>Task resource id</nowiki>\|Description=<nowiki>The task resource id</nowiki>\|Comma=,}}{{CGscriptParameters_Template\|Type=string\|Name=<nowiki>Content</nowiki>\|Description=<nowiki>The rejection comment</nowiki>\|Comma=,}}{{CGscriptParameters_Template\|Type=int?\|Name=<nowiki>User resource id</nowiki>\|Description=<nowiki>The user resource id</nowiki>}}		{{CGscriptParameters_Template\|Type=int\|Name=<nowiki>Task resource id</nowiki>\|Description=<nowiki>The task resource id</nowiki>\|Comma=,}}{{CGscriptParameters_Template\|Type=string\|Name=<nowiki>Content</nowiki>\|Description=<nowiki>The rejection comment</nowiki>\|Comma=,}}{{CGscriptParameters_Template\|Type=int?\|Name=<nowiki>User resource id</nowiki>\|Description=<nowiki>The user resource id</nowiki>}}
	\|Description=<nowiki>Rejects (or rejects a rejection of) the task as the specified user</nowiki>}}		\|Description=<nowiki>Rejects (or rejects a rejection of) the task as the specified user</nowiki>}}
			{{CGscriptMethods_Template\|ReturnType=Empty\|Name=<nowiki>Task_save</nowiki>\|Parameters=
			{{CGscriptParameters_Template\|Type=Task\|Name=<nowiki>Task</nowiki>\|Description=<nowiki>The task array object to save</nowiki>}}
			\|Obsolete=1
			\|Description=<nowiki>Saves a task object to the database</nowiki>}}
	{{CGscriptMethods_Template\|ReturnType=Empty\|Name=<nowiki>Task_setAcceptanceDeadline</nowiki>\|Parameters=		{{CGscriptMethods_Template\|ReturnType=Empty\|Name=<nowiki>Task_setAcceptanceDeadline</nowiki>\|Parameters=
	{{CGscriptParameters_Template\|Type=int\|Name=<nowiki>Task resource id</nowiki>\|Description=<nowiki>The task resource id</nowiki>}}		{{CGscriptParameters_Template\|Type=int\|Name=<nowiki>Task resource id</nowiki>\|Description=<nowiki>The task resource id</nowiki>}}
Line 194:		Line 221:
	{{CGscriptParameters_Template\|Type=int\|Name=<nowiki>Task resource id</nowiki>\|Description=<nowiki>The task resource id</nowiki>\|Comma=,}}{{CGscriptParameters_Template\|Type=bool\|Name=<nowiki>Send mails</nowiki>\|Description=<nowiki>True to enable mails</nowiki>}}		{{CGscriptParameters_Template\|Type=int\|Name=<nowiki>Task resource id</nowiki>\|Description=<nowiki>The task resource id</nowiki>\|Comma=,}}{{CGscriptParameters_Template\|Type=bool\|Name=<nowiki>Send mails</nowiki>\|Description=<nowiki>True to enable mails</nowiki>}}
	\|Description=<nowiki>Sets send-mail-on-status-change for the task</nowiki>}}		\|Description=<nowiki>Sets send-mail-on-status-change for the task</nowiki>}}
	~~{{CGscriptMethods_Template\|ReturnType=Empty\|Name=<nowiki>Task_setSupervisor</nowiki>\|Parameters=~~		}}
	{{CGscriptParameters_Template\|Type=int\|Name=<nowiki>task unique id</nowiki>\|Description=<nowiki>The task resource id</nowiki>\|Comma=,}}{{CGscriptParameters_Template\|Type=int\|Name=<nowiki>supervisor resource unique id</nowiki>\|Description=<nowiki>The supervisor resource id</nowiki>}}
	~~\|Description=<nowiki>Sets the supervisor of a task</nowiki>}}~~}}

GroupRule class

Antester@voxmeter.dk — Tue, 02 Jun 2026 10:26:59 GMT

Replaced content with "GroupBuilderRule_class"

← Older revision		Revision as of 10:26, 2 June 2026
Line 1:		Line 1:
	{{CGscriptClass_Template\|Name=<nowiki>GroupRule</nowiki>\|Description=<nowiki>Represents a group builder rule (the targeting rule attached to a group).</nowiki>\|InheritsFrom=Array\|Methods={{CGscriptMethods_Template\|ReturnType=Empty\|Name=<nowiki>Save</nowiki>\|Description=<nowiki>Save this group rule to the database</nowiki>}}		[[GroupBuilderRule_class]]
	~~{{CGscriptMethods_Template\|ReturnType=Empty\|Name=<nowiki>SetPercentTarget</nowiki>\|Parameters=~~
	~~{{CGscriptParameters_Template\|Type=int\|Name=<nowiki>Target percentage</nowiki>\|Description=<nowiki>Percentage target (-1 for unlimited)</nowiki>}}~~
	~~\|Description=<nowiki>Set a percentage target for this rule and save</nowiki>}}~~
	~~{{CGscriptMethods_Template\|ReturnType=Empty\|Name=<nowiki>SetTarget</nowiki>\|Parameters=~~
	~~{{CGscriptParameters_Template\|Type=int\|Name=<nowiki>Target</nowiki>\|Description=<nowiki>New target value (-1 for unlimited)</nowiki>}}~~
	~~\|Description=<nowiki>Set a new absolute target for this rule and save</nowiki>}}~~
	~~{{CGscriptMethods_Template\|ReturnType=Empty\|Name=<nowiki>SetTargetUnlimited</nowiki>\|Description=<nowiki>Set this rule's target to unlimited and save</nowiki>}}~~
	~~{{CGscriptMethods_Template\|ReturnType=string\|Name=<nowiki>ToString</nowiki>\|Description=<nowiki>The string representation of the object.</nowiki>}}~~
	~~{{CGscriptMethods_Template\|ReturnType=object\|Name=<nowiki>this~~[] ~~{ get; }</nowiki>\|Parameters=~~
	~~{{CGscriptParameters_Template\|Type=int\|Name=<nowiki>index</nowiki>\|Description=<nowiki>Index</nowiki>}}~~
	~~\|Description=<nowiki>Backward-compatible indexer</nowiki>}}~~
	~~{{CGscriptMethods_Template\|ReturnType=Empty\|Name=<nowiki>this[~~] ~~{ get; }</nowiki>\|Parameters=~~
	{{CGscriptParameters_Template\|Type=int\|Name=<nowiki>index</nowiki>\|Description=<nowiki>Index</nowiki>\|Comma=,}}{{CGscriptParameters_Template\|Type=object\|Name=<nowiki>value</nowiki>\|Description=<nowiki>Value to set</nowiki>}}
	\|Description=<nowiki>Backward-compatible indexer</nowiki>}}\|Properties={{CGscriptProperties_Template\|ReturnType=number\|Name=<nowiki>Average</nowiki>\|HasGetter=1\|Description=<nowiki>Average of the objects in the Array object. Can only use if all the elements are of type Number</nowiki>}}
	~~{{CGscriptProperties_Template\|ReturnType=int\|Name=<nowiki>Id</nowiki>\|HasGetter=1\|Description=<nowiki>Primary-key id of the rule</nowiki>}}~~
	~~{{CGscriptProperties_Template\|ReturnType=bool\|Name=<nowiki>IncludeDeleted</nowiki>\|HasGetter=1\|HasSetter=1\|Description=<nowiki>Whether deleted users are eligible</nowiki>}}~~
	~~{{CGscriptProperties_Template\|ReturnType=bool\|Name=<nowiki>IncludeDisabled</nowiki>\|HasGetter=1\|HasSetter=1\|Description=<nowiki>Whether disabled users are eligible</nowiki>}}~~
	{{CGscriptProperties_Template\|ReturnType=number\|Name=<nowiki>Max</nowiki>\|HasGetter=1\|Description=<nowiki>Largest of all the objects in the Array object. Can only use if all the elements are of type Number</nowiki>}}
	{{CGscriptProperties_Template\|ReturnType=number\|Name=<nowiki>Min</nowiki>\|HasGetter=1\|Description=<nowiki>Smallest of all the objects in the Array object. Can only use if all the elements are of type Number</nowiki>}}
	~~{{CGscriptProperties_Template\|ReturnType=string\|Name=<nowiki>Name</nowiki>\|HasGetter=1\|HasSetter=1\|Description=<nowiki>Display name of the rule</nowiki>}}~~
	~~{{CGscriptProperties_Template\|ReturnType=string\|Name=<nowiki>ObjectTypeName</nowiki>\|HasGetter=1\|Description=<nowiki>The name of the type of object.</nowiki>}}~~
	{{CGscriptProperties_Template\|ReturnType=number\|Name=<nowiki>Sum</nowiki>\|HasGetter=1\|Description=<nowiki>Sum of all the objects in the Array object. Can only use if all the elements are of type Number</nowiki>}}
	~~{{CGscriptProperties_Template\|ReturnType=int\|Name=<nowiki>Target</nowiki>\|HasGetter=1\|HasSetter=1\|Description=<nowiki>Absolute target user count (-1 = unlimited)</nowiki>}}~~
	{{CGscriptProperties_Template\|ReturnType=number\|Name=<nowiki>TargetPercentage</nowiki>\|HasGetter=1\|HasSetter=1\|Description=<nowiki>Target as a percentage of the parent rule (-1 = unlimited / not set)</nowiki>}}
	~~{{CGscriptProperties_Template\|ReturnType=TypeInformation\|Name=<nowiki>TypeInformation</nowiki>\|HasGetter=1\|Description=<nowiki>Get information about this class.</nowiki>}}~~
	{{CGscriptProperties_Template\|ReturnType=int\|Name=<nowiki>UserCount</nowiki>\|HasGetter=1\|Description=<nowiki>Actual number of users produced by this rule after the last rebuild</nowiki>}}\|StaticMethods={{CGscriptMethods_Template\|ReturnType=GroupRule\|Name=<nowiki>GroupRule_getRuleById</nowiki>\|Parameters=
	~~{{CGscriptParameters_Template\|Type=int\|Name=<nowiki>Group Rule id</nowiki>\|Description=<nowiki>Id of the group rule</nowiki>}}~~
	~~\|Description=<nowiki>Get the existing group rule object by using group rule id</nowiki>}}~~
	~~{{CGscriptMethods_Template\|ReturnType=number\|Name=<nowiki>GroupRule_getUserCount</nowiki>\|Parameters=~~
	~~{{CGscriptParameters_Template\|Type=int\|Name=<nowiki>Group Rule id</nowiki>\|Description=<nowiki>Id of the group rule</nowiki>}}~~
	~~\|Description=<nowiki>Return the actual number of users in a specified group builder rule</nowiki>}}}}~~

GroupBuilderRule class

Antester@voxmeter.dk — Tue, 02 Jun 2026 10:23:49 GMT

← Older revision		Revision as of 10:23, 2 June 2026
Line 10:		Line 10:
	{{CGscriptParameters_Template\|Type=GroupBuilderVariable\|Name=<nowiki>variable</nowiki>\|Description=<nowiki>Variable to add</nowiki>}}		{{CGscriptParameters_Template\|Type=GroupBuilderVariable\|Name=<nowiki>variable</nowiki>\|Description=<nowiki>Variable to add</nowiki>}}
	\|Description=<nowiki>Add a new variable</nowiki>}}		\|Description=<nowiki>Add a new variable</nowiki>}}
			{{CGscriptMethods_Template\|ReturnType=bool\|Name=<nowiki>Remove</nowiki>\|Parameters=
			{{CGscriptParameters_Template\|Type=GroupBuilderVariable\|Name=<nowiki>variable</nowiki>\|Description=<nowiki>Variable to remove</nowiki>}}
			\|Description=<nowiki>Remove variable. Return true if removed</nowiki>}}
			{{CGscriptMethods_Template\|ReturnType=Empty\|Name=<nowiki>Save</nowiki>\|Description=<nowiki>Save this group rule to the database</nowiki>}}
			{{CGscriptMethods_Template\|ReturnType=Empty\|Name=<nowiki>SetPercentTarget</nowiki>\|Parameters=
			{{CGscriptParameters_Template\|Type=int\|Name=<nowiki>Target percentage</nowiki>\|Description=<nowiki>Percentage target (-1 for unlimited)</nowiki>}}
			\|Description=<nowiki>Set a percentage target for this rule and save</nowiki>}}
			{{CGscriptMethods_Template\|ReturnType=Empty\|Name=<nowiki>SetTarget</nowiki>\|Parameters=
			{{CGscriptParameters_Template\|Type=int\|Name=<nowiki>Target</nowiki>\|Description=<nowiki>New target value (-1 for unlimited)</nowiki>}}
			\|Description=<nowiki>Set a new absolute target for this rule and save</nowiki>}}
			{{CGscriptMethods_Template\|ReturnType=Empty\|Name=<nowiki>SetTargetUnlimited</nowiki>\|Description=<nowiki>Set this rule's target to unlimited and save</nowiki>}}
			{{CGscriptMethods_Template\|ReturnType=string\|Name=<nowiki>ToString</nowiki>\|Description=<nowiki>The string representation of the object.</nowiki>}}
	{{CGscriptMethods_Template\|ReturnType=object\|Name=<nowiki>this[] { get; }</nowiki>\|Parameters=		{{CGscriptMethods_Template\|ReturnType=object\|Name=<nowiki>this[] { get; }</nowiki>\|Parameters=
	{{CGscriptParameters_Template\|Type=int\|Name=<nowiki>index</nowiki>\|Description=<nowiki>Index</nowiki>}}		{{CGscriptParameters_Template\|Type=int\|Name=<nowiki>index</nowiki>\|Description=<nowiki>Index</nowiki>}}
	\|Description=<nowiki>Get variable at index</nowiki>}}		\|Description=<nowiki>Get variable at index</nowiki>}}
	~~{{CGscriptMethods_Template\|ReturnType=bool\|Name=<nowiki>Remove</nowiki>\|Parameters=~~		{{CGscriptMethods_Template\|ReturnType=Empty\|Name=<nowiki>this[] { get; }</nowiki>\|Parameters=
	~~{{CGscriptParameters_Template\|Type=GroupBuilderVariable\|Name=<nowiki>variable</nowiki>\|Description=<nowiki>Variable to remove</nowiki>}}~~
	~~\|Description=<nowiki>Remove variable. Return true if removed</nowiki>}}~~
	{{CGscriptMethods_Template\|ReturnType=Empty\|Name=<nowiki>this[] { ~~set~~; }</nowiki>\|Parameters=
	{{CGscriptParameters_Template\|Type=int\|Name=<nowiki>index</nowiki>\|Description=<nowiki>Index</nowiki>\|Comma=,}}{{CGscriptParameters_Template\|Type=object\|Name=<nowiki>value</nowiki>\|Description=<nowiki>Value to set</nowiki>}}		{{CGscriptParameters_Template\|Type=int\|Name=<nowiki>index</nowiki>\|Description=<nowiki>Index</nowiki>\|Comma=,}}{{CGscriptParameters_Template\|Type=object\|Name=<nowiki>value</nowiki>\|Description=<nowiki>Value to set</nowiki>}}
	\|Description=<nowiki>Set variable at index</nowiki>}}		\|Description=<nowiki>Set variable at index</nowiki>}}
	~~{{CGscriptMethods_Template\|ReturnType=string\|Name=<nowiki>ToString</nowiki>\|Inherited=object\|Description=<nowiki>The string representation of the object.</nowiki>}}~~
	\|Properties=		\|Properties=
	{{CGscriptProperties_Template\|ReturnType=int\|Name=<nowiki>Actual</nowiki>\|HasGetter=1\|Description=<nowiki>How many of the final group amount was generated from this rule</nowiki>}}		{{CGscriptProperties_Template\|ReturnType=int\|Name=<nowiki>Actual</nowiki>\|HasGetter=1\|Description=<nowiki>How many of the final group amount was generated from this rule</nowiki>}}
	{{CGscriptProperties_Template\|ReturnType=GroupBuilderRuleCollection\|Name=<nowiki>Children</nowiki>\|HasGetter=1\|Description=<nowiki>Child rules for this rule</nowiki>}}		{{CGscriptProperties_Template\|ReturnType=GroupBuilderRuleCollection\|Name=<nowiki>Children</nowiki>\|HasGetter=1\|Description=<nowiki>Child rules for this rule</nowiki>}}
	{{CGscriptProperties_Template\|ReturnType=int\|Name=<nowiki>Count</nowiki>\|HasGetter=1\|Description=<nowiki>Number of variables at this level</nowiki>}}		{{CGscriptProperties_Template\|ReturnType=int\|Name=<nowiki>Count</nowiki>\|HasGetter=1\|Description=<nowiki>Number of variables at this level</nowiki>}}
			{{CGscriptProperties_Template\|ReturnType=int\|Name=<nowiki>Id</nowiki>\|HasGetter=1\|Description=<nowiki>Primary-key id of the rule</nowiki>}}
	{{CGscriptProperties_Template\|ReturnType=bool\|Name=<nowiki>IncludeDeleted</nowiki>\|HasGetter=1\|HasSetter=1\|Description=<nowiki>Include deleted users or not</nowiki>}}		{{CGscriptProperties_Template\|ReturnType=bool\|Name=<nowiki>IncludeDeleted</nowiki>\|HasGetter=1\|HasSetter=1\|Description=<nowiki>Include deleted users or not</nowiki>}}
	{{CGscriptProperties_Template\|ReturnType=bool\|Name=<nowiki>IncludeDisabled</nowiki>\|HasGetter=1\|HasSetter=1\|Description=<nowiki>Include disabled users or not</nowiki>}}		{{CGscriptProperties_Template\|ReturnType=bool\|Name=<nowiki>IncludeDisabled</nowiki>\|HasGetter=1\|HasSetter=1\|Description=<nowiki>Include disabled users or not</nowiki>}}
Line 31:		Line 40:
	{{CGscriptProperties_Template\|ReturnType=int\|Name=<nowiki>Target</nowiki>\|HasGetter=1\|HasSetter=1\|Description=<nowiki>Target amount to build for this group. -1 == all</nowiki>}}		{{CGscriptProperties_Template\|ReturnType=int\|Name=<nowiki>Target</nowiki>\|HasGetter=1\|HasSetter=1\|Description=<nowiki>Target amount to build for this group. -1 == all</nowiki>}}
	{{CGscriptProperties_Template\|ReturnType=number\|Name=<nowiki>TargetPct</nowiki>\|HasGetter=1\|HasSetter=1\|Description=<nowiki>Target as pct of parent. -1 == use Target</nowiki>}}		{{CGscriptProperties_Template\|ReturnType=number\|Name=<nowiki>TargetPct</nowiki>\|HasGetter=1\|HasSetter=1\|Description=<nowiki>Target as pct of parent. -1 == use Target</nowiki>}}
	{{CGscriptProperties_Template\|ReturnType=TypeInformation\|Name=<nowiki>TypeInformation</nowiki>\|HasGetter=1~~\|Inherited=object~~\|Description=<nowiki>Get information about this class.</nowiki>}}		{{CGscriptProperties_Template\|ReturnType=number\|Name=<nowiki>TargetPercentage</nowiki>\|HasGetter=1\|HasSetter=1\|Description=<nowiki>Target as a percentage of the parent rule (-1 = unlimited / not set)</nowiki>}}
			{{CGscriptProperties_Template\|ReturnType=TypeInformation\|Name=<nowiki>TypeInformation</nowiki>\|HasGetter=1\|Description=<nowiki>Get information about this class.</nowiki>}}
			{{CGscriptProperties_Template\|ReturnType=int\|Name=<nowiki>UserCount</nowiki>\|HasGetter=1\|Description=<nowiki>Actual number of users produced by this rule after the last rebuild</nowiki>}}
			\|StaticMethods=
			{{CGscriptMethods_Template\|ReturnType=GroupBuilderRule\|Name=<nowiki>GroupBuilderRule_getRuleById</nowiki>\|Parameters=
			{{CGscriptParameters_Template\|Type=int\|Name=<nowiki>Group Rule id</nowiki>\|Description=<nowiki>Id of the group rule</nowiki>}}
			\|Description=<nowiki>Get the existing group builder rule object by using group rule id</nowiki>}}
			{{CGscriptMethods_Template\|ReturnType=number\|Name=<nowiki>GroupBuilderRule_getUserCount</nowiki>\|Parameters=
			{{CGscriptParameters_Template\|Type=int\|Name=<nowiki>Group Rule id</nowiki>\|Description=<nowiki>Id of the group rule</nowiki>}}
			\|Description=<nowiki>Return the actual number of users in a specified group builder rule</nowiki>}}
	}}		}}

← Older revision		Revision as of 10:36, 2 June 2026
Line 1:		Line 1:
	{{CGscriptClass_Template\|Name=<nowiki>Task</nowiki>\|Description=<nowiki>Represents a Task resource object.</nowiki>\|InheritsFrom=Array\|Constructors={{CGscriptConstructors_Template\|Parameters=		{{CGscriptClass_Template
			\|Name=<nowiki>Task</nowiki>
			\|Description=<nowiki>Represents a Task resource object.</nowiki>
			\|InheritsFrom=Array\|Constructors=
			{{CGscriptConstructors_Template\|Parameters=
	{{CGscriptParameters_Template\|Type=string\|Name=<nowiki>name</nowiki>\|Description=<nowiki>Name of the task</nowiki>\|Comma=,}}{{CGscriptParameters_Template\|Type=int\|Name=<nowiki>Parent resource id</nowiki>\|Description=<nowiki>Resource id of the parent</nowiki>}}		{{CGscriptParameters_Template\|Type=string\|Name=<nowiki>name</nowiki>\|Description=<nowiki>Name of the task</nowiki>\|Comma=,}}{{CGscriptParameters_Template\|Type=int\|Name=<nowiki>Parent resource id</nowiki>\|Description=<nowiki>Resource id of the parent</nowiki>}}
	\|Description=<nowiki>Creates a new task with the task name as description</nowiki>}}		\|Description=<nowiki>Creates a new task with the task name as description</nowiki>}}
Line 10:		Line 14:
	{{CGscriptConstructors_Template\|Parameters=		{{CGscriptConstructors_Template\|Parameters=
	{{CGscriptParameters_Template\|Type=string\|Name=<nowiki>name</nowiki>\|Description=<nowiki>Name of the task</nowiki>\|Comma=,}}{{CGscriptParameters_Template\|Type=int\|Name=<nowiki>Parent resource id</nowiki>\|Description=<nowiki>Resource id of the parent</nowiki>\|Comma=,}}{{CGscriptParameters_Template\|Type=string\|Name=<nowiki>description</nowiki>\|Description=<nowiki>Description of the task</nowiki>\|Comma=,}}{{CGscriptParameters_Template\|Type=int?\|Name=<nowiki>Task template</nowiki>\|Description=<nowiki>Resource id of the task template (0 for default)</nowiki>}}		{{CGscriptParameters_Template\|Type=string\|Name=<nowiki>name</nowiki>\|Description=<nowiki>Name of the task</nowiki>\|Comma=,}}{{CGscriptParameters_Template\|Type=int\|Name=<nowiki>Parent resource id</nowiki>\|Description=<nowiki>Resource id of the parent</nowiki>\|Comma=,}}{{CGscriptParameters_Template\|Type=string\|Name=<nowiki>description</nowiki>\|Description=<nowiki>Description of the task</nowiki>\|Comma=,}}{{CGscriptParameters_Template\|Type=int?\|Name=<nowiki>Task template</nowiki>\|Description=<nowiki>Resource id of the task template (0 for default)</nowiki>}}
	\|Description=<nowiki>Creates a new task with a custom description and a template</nowiki>}}\|Methods={{CGscriptMethods_Template\|ReturnType=Empty\|Name=<nowiki>Accept</nowiki>\|Description=<nowiki>Accepts this task using the current user</nowiki>}}		\|Description=<nowiki>Creates a new task with a custom description and a template</nowiki>}}
			\|Methods=
			{{CGscriptMethods_Template\|ReturnType=Empty\|Name=<nowiki>Accept</nowiki>\|Description=<nowiki>Accepts this task using the current user</nowiki>}}
	{{CGscriptMethods_Template\|ReturnType=Empty\|Name=<nowiki>Accept</nowiki>\|Parameters=		{{CGscriptMethods_Template\|ReturnType=Empty\|Name=<nowiki>Accept</nowiki>\|Parameters=
	{{CGscriptParameters_Template\|Type=int\|Name=<nowiki>User resource id</nowiki>\|Description=<nowiki>The user resource id</nowiki>}}		{{CGscriptParameters_Template\|Type=int\|Name=<nowiki>User resource id</nowiki>\|Description=<nowiki>The user resource id</nowiki>}}
Line 78:		Line 84:
	{{CGscriptMethods_Template\|ReturnType=Empty\|Name=<nowiki>this[] { get; }</nowiki>\|Parameters=		{{CGscriptMethods_Template\|ReturnType=Empty\|Name=<nowiki>this[] { get; }</nowiki>\|Parameters=
	{{CGscriptParameters_Template\|Type=int\|Name=<nowiki>index</nowiki>\|Description=<nowiki>Index</nowiki>\|Comma=,}}{{CGscriptParameters_Template\|Type=object\|Name=<nowiki>value</nowiki>\|Description=<nowiki>Value to set</nowiki>}}		{{CGscriptParameters_Template\|Type=int\|Name=<nowiki>index</nowiki>\|Description=<nowiki>Index</nowiki>\|Comma=,}}{{CGscriptParameters_Template\|Type=object\|Name=<nowiki>value</nowiki>\|Description=<nowiki>Value to set</nowiki>}}
	\|Description=<nowiki>Backward-compatible indexer</nowiki>}}\|Properties={{CGscriptProperties_Template\|ReturnType=number\|Name=<nowiki>Average</nowiki>\|HasGetter=1\|Description=<nowiki>Average of the objects in the Array object. Can only use if all the elements are of type Number</nowiki>}}		\|Description=<nowiki>Backward-compatible indexer</nowiki>}}
			\|Properties=
			{{CGscriptProperties_Template\|ReturnType=number\|Name=<nowiki>Average</nowiki>\|HasGetter=1\|Description=<nowiki>Average of the objects in the Array object. Can only use if all the elements are of type Number</nowiki>}}
	{{CGscriptProperties_Template\|ReturnType=int\|Name=<nowiki>CaseNumber</nowiki>\|HasGetter=1\|Description=<nowiki>The task case number</nowiki>}}		{{CGscriptProperties_Template\|ReturnType=int\|Name=<nowiki>CaseNumber</nowiki>\|HasGetter=1\|Description=<nowiki>The task case number</nowiki>}}
	{{CGscriptProperties_Template\|ReturnType=bool\|Name=<nowiki>Completed</nowiki>\|HasGetter=1\|HasSetter=1\|Description=<nowiki>Whether the task is completed</nowiki>}}		{{CGscriptProperties_Template\|ReturnType=bool\|Name=<nowiki>Completed</nowiki>\|HasGetter=1\|HasSetter=1\|Description=<nowiki>Whether the task is completed</nowiki>}}
Line 101:		Line 109:
	{{CGscriptProperties_Template\|ReturnType=bool\|Name=<nowiki>TimeRegistration</nowiki>\|HasGetter=1\|Description=<nowiki>Whether time registration is enabled</nowiki>}}		{{CGscriptProperties_Template\|ReturnType=bool\|Name=<nowiki>TimeRegistration</nowiki>\|HasGetter=1\|Description=<nowiki>Whether time registration is enabled</nowiki>}}
	{{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>}}
	{{CGscriptProperties_Template\|ReturnType=int\|Name=<nowiki>Version</nowiki>\|HasGetter=1\|Description=<nowiki>The task object version</nowiki>}}\|StaticMethods={{CGscriptMethods_Template\|ReturnType=Empty\|Name=<nowiki>Task_accept</nowiki>\|Parameters=		{{CGscriptProperties_Template\|ReturnType=int\|Name=<nowiki>Version</nowiki>\|HasGetter=1\|Description=<nowiki>The task object version</nowiki>}}
			\|StaticMethods=
			{{CGscriptMethods_Template\|ReturnType=Empty\|Name=<nowiki>Task_accept</nowiki>\|Parameters=
	{{CGscriptParameters_Template\|Type=int\|Name=<nowiki>Task resource id</nowiki>\|Description=<nowiki>The task resource id</nowiki>}}		{{CGscriptParameters_Template\|Type=int\|Name=<nowiki>Task resource id</nowiki>\|Description=<nowiki>The task resource id</nowiki>}}
	\|Description=<nowiki>Accepts the task using the current user</nowiki>}}		\|Description=<nowiki>Accepts the task using the current user</nowiki>}}
Line 134:		Line 144:
	{{CGscriptParameters_Template\|Type=int\|Name=<nowiki>Task resource id</nowiki>\|Description=<nowiki>The task resource id</nowiki>}}		{{CGscriptParameters_Template\|Type=int\|Name=<nowiki>Task resource id</nowiki>\|Description=<nowiki>The task resource id</nowiki>}}
	\|Description=<nowiki>Returns the completion deadline of the task, or empty if not set</nowiki>}}		\|Description=<nowiki>Returns the completion deadline of the task, or empty if not set</nowiki>}}
	~~{{CGscriptMethods_Template\|ReturnType=int?\|Name=<nowiki>Task_getResourceUniqueIdFromTaskCaseNumber</nowiki>\|Parameters=~~
	~~{{CGscriptParameters_Template\|Type=int\|Name=<nowiki>Task case number</nowiki>\|Description=<nowiki>The task case number</nowiki>}}~~
	~~\|Description=<nowiki>Returns the resource unique id for the task with the given case number, or empty if not found</nowiki>}}~~
	{{CGscriptMethods_Template\|ReturnType=bool\|Name=<nowiki>Task_getSendMailOnStatusChange</nowiki>\|Parameters=		{{CGscriptMethods_Template\|ReturnType=bool\|Name=<nowiki>Task_getSendMailOnStatusChange</nowiki>\|Parameters=
	{{CGscriptParameters_Template\|Type=int\|Name=<nowiki>Task resource id</nowiki>\|Description=<nowiki>The task resource id</nowiki>}}		{{CGscriptParameters_Template\|Type=int\|Name=<nowiki>Task resource id</nowiki>\|Description=<nowiki>The task resource id</nowiki>}}
Line 152:		Line 159:
	{{CGscriptParameters_Template\|Type=array\|Name=<nowiki>Task resource id</nowiki>\|Description=<nowiki>Array of task resource ids</nowiki>}}		{{CGscriptParameters_Template\|Type=array\|Name=<nowiki>Task resource id</nowiki>\|Description=<nowiki>Array of task resource ids</nowiki>}}
	\|Description=<nowiki>Returns the tasks with the given resource ids</nowiki>}}		\|Description=<nowiki>Returns the tasks with the given resource ids</nowiki>}}
			{{CGscriptMethods_Template\|ReturnType=Task\|Name=<nowiki>Task_new</nowiki>\|Parameters=
			{{CGscriptParameters_Template\|Type=string\|Name=<nowiki>name</nowiki>\|Description=<nowiki>Name of the task</nowiki>\|Comma=,}}{{CGscriptParameters_Template\|Type=int\|Name=<nowiki>Parent resource id</nowiki>\|Description=<nowiki>Resource id of the parent</nowiki>}}
			\|Obsolete=1
			\|Description=<nowiki>Initialises a new task object with the task name as description</nowiki>}}
			{{CGscriptMethods_Template\|ReturnType=Task\|Name=<nowiki>Task_new</nowiki>\|Parameters=
			{{CGscriptParameters_Template\|Type=string\|Name=<nowiki>name</nowiki>\|Description=<nowiki>Name of the task</nowiki>\|Comma=,}}{{CGscriptParameters_Template\|Type=int\|Name=<nowiki>Parent resource id</nowiki>\|Description=<nowiki>Resource id of the parent</nowiki>\|Comma=,}}{{CGscriptParameters_Template\|Type=int?\|Name=<nowiki>Task template</nowiki>\|Description=<nowiki>Resource id of the task template (0 for default)</nowiki>}}
			\|Obsolete=1
			\|Description=<nowiki>Initialises a new task object with the task name as description and a template</nowiki>}}
			{{CGscriptMethods_Template\|ReturnType=Task\|Name=<nowiki>Task_new</nowiki>\|Parameters=
			{{CGscriptParameters_Template\|Type=string\|Name=<nowiki>name</nowiki>\|Description=<nowiki>Name of the task</nowiki>\|Comma=,}}{{CGscriptParameters_Template\|Type=int\|Name=<nowiki>Parent resource id</nowiki>\|Description=<nowiki>Resource id of the parent</nowiki>\|Comma=,}}{{CGscriptParameters_Template\|Type=string\|Name=<nowiki>description</nowiki>\|Description=<nowiki>Description of the task</nowiki>}}
			\|Obsolete=1
			\|Description=<nowiki>Initialises a new task object with a custom description</nowiki>}}
			{{CGscriptMethods_Template\|ReturnType=Task\|Name=<nowiki>Task_new</nowiki>\|Parameters=
			{{CGscriptParameters_Template\|Type=string\|Name=<nowiki>name</nowiki>\|Description=<nowiki>Name of the task</nowiki>\|Comma=,}}{{CGscriptParameters_Template\|Type=int\|Name=<nowiki>Parent resource id</nowiki>\|Description=<nowiki>Resource id of the parent</nowiki>\|Comma=,}}{{CGscriptParameters_Template\|Type=string\|Name=<nowiki>description</nowiki>\|Description=<nowiki>Description of the task</nowiki>\|Comma=,}}{{CGscriptParameters_Template\|Type=int?\|Name=<nowiki>Task template</nowiki>\|Description=<nowiki>Resource id of the task template (0 for default)</nowiki>}}
			\|Obsolete=1
			\|Description=<nowiki>Initialises a new task object with a custom description and a template</nowiki>}}
	{{CGscriptMethods_Template\|ReturnType=Empty\|Name=<nowiki>Task_reassign</nowiki>\|Parameters=		{{CGscriptMethods_Template\|ReturnType=Empty\|Name=<nowiki>Task_reassign</nowiki>\|Parameters=
	{{CGscriptParameters_Template\|Type=int\|Name=<nowiki>Task resource id</nowiki>\|Description=<nowiki>The task resource id</nowiki>\|Comma=,}}{{CGscriptParameters_Template\|Type=int\|Name=<nowiki>Responsible resource id</nowiki>\|Description=<nowiki>The new responsible resource id</nowiki>\|Comma=,}}{{CGscriptParameters_Template\|Type=string\|Name=<nowiki>Content</nowiki>\|Description=<nowiki>The reassignment comment</nowiki>}}		{{CGscriptParameters_Template\|Type=int\|Name=<nowiki>Task resource id</nowiki>\|Description=<nowiki>The task resource id</nowiki>\|Comma=,}}{{CGscriptParameters_Template\|Type=int\|Name=<nowiki>Responsible resource id</nowiki>\|Description=<nowiki>The new responsible resource id</nowiki>\|Comma=,}}{{CGscriptParameters_Template\|Type=string\|Name=<nowiki>Content</nowiki>\|Description=<nowiki>The reassignment comment</nowiki>}}
Line 164:		Line 187:
	{{CGscriptParameters_Template\|Type=int\|Name=<nowiki>Task resource id</nowiki>\|Description=<nowiki>The task resource id</nowiki>\|Comma=,}}{{CGscriptParameters_Template\|Type=string\|Name=<nowiki>Content</nowiki>\|Description=<nowiki>The rejection comment</nowiki>\|Comma=,}}{{CGscriptParameters_Template\|Type=int?\|Name=<nowiki>User resource id</nowiki>\|Description=<nowiki>The user resource id</nowiki>}}		{{CGscriptParameters_Template\|Type=int\|Name=<nowiki>Task resource id</nowiki>\|Description=<nowiki>The task resource id</nowiki>\|Comma=,}}{{CGscriptParameters_Template\|Type=string\|Name=<nowiki>Content</nowiki>\|Description=<nowiki>The rejection comment</nowiki>\|Comma=,}}{{CGscriptParameters_Template\|Type=int?\|Name=<nowiki>User resource id</nowiki>\|Description=<nowiki>The user resource id</nowiki>}}
	\|Description=<nowiki>Rejects (or rejects a rejection of) the task as the specified user</nowiki>}}		\|Description=<nowiki>Rejects (or rejects a rejection of) the task as the specified user</nowiki>}}
			{{CGscriptMethods_Template\|ReturnType=Empty\|Name=<nowiki>Task_save</nowiki>\|Parameters=
			{{CGscriptParameters_Template\|Type=Task\|Name=<nowiki>Task</nowiki>\|Description=<nowiki>The task array object to save</nowiki>}}
			\|Obsolete=1
			\|Description=<nowiki>Saves a task object to the database</nowiki>}}
	{{CGscriptMethods_Template\|ReturnType=Empty\|Name=<nowiki>Task_setAcceptanceDeadline</nowiki>\|Parameters=		{{CGscriptMethods_Template\|ReturnType=Empty\|Name=<nowiki>Task_setAcceptanceDeadline</nowiki>\|Parameters=
	{{CGscriptParameters_Template\|Type=int\|Name=<nowiki>Task resource id</nowiki>\|Description=<nowiki>The task resource id</nowiki>}}		{{CGscriptParameters_Template\|Type=int\|Name=<nowiki>Task resource id</nowiki>\|Description=<nowiki>The task resource id</nowiki>}}
Line 194:		Line 221:
	{{CGscriptParameters_Template\|Type=int\|Name=<nowiki>Task resource id</nowiki>\|Description=<nowiki>The task resource id</nowiki>\|Comma=,}}{{CGscriptParameters_Template\|Type=bool\|Name=<nowiki>Send mails</nowiki>\|Description=<nowiki>True to enable mails</nowiki>}}		{{CGscriptParameters_Template\|Type=int\|Name=<nowiki>Task resource id</nowiki>\|Description=<nowiki>The task resource id</nowiki>\|Comma=,}}{{CGscriptParameters_Template\|Type=bool\|Name=<nowiki>Send mails</nowiki>\|Description=<nowiki>True to enable mails</nowiki>}}
	\|Description=<nowiki>Sets send-mail-on-status-change for the task</nowiki>}}		\|Description=<nowiki>Sets send-mail-on-status-change for the task</nowiki>}}
	~~{{CGscriptMethods_Template\|ReturnType=Empty\|Name=<nowiki>Task_setSupervisor</nowiki>\|Parameters=~~		}}
	{{CGscriptParameters_Template\|Type=int\|Name=<nowiki>task unique id</nowiki>\|Description=<nowiki>The task resource id</nowiki>\|Comma=,}}{{CGscriptParameters_Template\|Type=int\|Name=<nowiki>supervisor resource unique id</nowiki>\|Description=<nowiki>The supervisor resource id</nowiki>}}
	~~\|Description=<nowiki>Sets the supervisor of a task</nowiki>}}~~}}

← Older revision		Revision as of 10:26, 2 June 2026
Line 1:		Line 1:
	{{CGscriptClass_Template\|Name=<nowiki>GroupRule</nowiki>\|Description=<nowiki>Represents a group builder rule (the targeting rule attached to a group).</nowiki>\|InheritsFrom=Array\|Methods={{CGscriptMethods_Template\|ReturnType=Empty\|Name=<nowiki>Save</nowiki>\|Description=<nowiki>Save this group rule to the database</nowiki>}}		[[GroupBuilderRule_class]]
	~~{{CGscriptMethods_Template\|ReturnType=Empty\|Name=<nowiki>SetPercentTarget</nowiki>\|Parameters=~~
	~~{{CGscriptParameters_Template\|Type=int\|Name=<nowiki>Target percentage</nowiki>\|Description=<nowiki>Percentage target (-1 for unlimited)</nowiki>}}~~
	~~\|Description=<nowiki>Set a percentage target for this rule and save</nowiki>}}~~
	~~{{CGscriptMethods_Template\|ReturnType=Empty\|Name=<nowiki>SetTarget</nowiki>\|Parameters=~~
	~~{{CGscriptParameters_Template\|Type=int\|Name=<nowiki>Target</nowiki>\|Description=<nowiki>New target value (-1 for unlimited)</nowiki>}}~~
	~~\|Description=<nowiki>Set a new absolute target for this rule and save</nowiki>}}~~
	~~{{CGscriptMethods_Template\|ReturnType=Empty\|Name=<nowiki>SetTargetUnlimited</nowiki>\|Description=<nowiki>Set this rule's target to unlimited and save</nowiki>}}~~
	~~{{CGscriptMethods_Template\|ReturnType=string\|Name=<nowiki>ToString</nowiki>\|Description=<nowiki>The string representation of the object.</nowiki>}}~~
	~~{{CGscriptMethods_Template\|ReturnType=object\|Name=<nowiki>this~~[] ~~{ get; }</nowiki>\|Parameters=~~
	~~{{CGscriptParameters_Template\|Type=int\|Name=<nowiki>index</nowiki>\|Description=<nowiki>Index</nowiki>}}~~
	~~\|Description=<nowiki>Backward-compatible indexer</nowiki>}}~~
	~~{{CGscriptMethods_Template\|ReturnType=Empty\|Name=<nowiki>this[~~] ~~{ get; }</nowiki>\|Parameters=~~
	{{CGscriptParameters_Template\|Type=int\|Name=<nowiki>index</nowiki>\|Description=<nowiki>Index</nowiki>\|Comma=,}}{{CGscriptParameters_Template\|Type=object\|Name=<nowiki>value</nowiki>\|Description=<nowiki>Value to set</nowiki>}}
	\|Description=<nowiki>Backward-compatible indexer</nowiki>}}\|Properties={{CGscriptProperties_Template\|ReturnType=number\|Name=<nowiki>Average</nowiki>\|HasGetter=1\|Description=<nowiki>Average of the objects in the Array object. Can only use if all the elements are of type Number</nowiki>}}
	~~{{CGscriptProperties_Template\|ReturnType=int\|Name=<nowiki>Id</nowiki>\|HasGetter=1\|Description=<nowiki>Primary-key id of the rule</nowiki>}}~~
	~~{{CGscriptProperties_Template\|ReturnType=bool\|Name=<nowiki>IncludeDeleted</nowiki>\|HasGetter=1\|HasSetter=1\|Description=<nowiki>Whether deleted users are eligible</nowiki>}}~~
	~~{{CGscriptProperties_Template\|ReturnType=bool\|Name=<nowiki>IncludeDisabled</nowiki>\|HasGetter=1\|HasSetter=1\|Description=<nowiki>Whether disabled users are eligible</nowiki>}}~~
	{{CGscriptProperties_Template\|ReturnType=number\|Name=<nowiki>Max</nowiki>\|HasGetter=1\|Description=<nowiki>Largest of all the objects in the Array object. Can only use if all the elements are of type Number</nowiki>}}
	{{CGscriptProperties_Template\|ReturnType=number\|Name=<nowiki>Min</nowiki>\|HasGetter=1\|Description=<nowiki>Smallest of all the objects in the Array object. Can only use if all the elements are of type Number</nowiki>}}
	~~{{CGscriptProperties_Template\|ReturnType=string\|Name=<nowiki>Name</nowiki>\|HasGetter=1\|HasSetter=1\|Description=<nowiki>Display name of the rule</nowiki>}}~~
	~~{{CGscriptProperties_Template\|ReturnType=string\|Name=<nowiki>ObjectTypeName</nowiki>\|HasGetter=1\|Description=<nowiki>The name of the type of object.</nowiki>}}~~
	{{CGscriptProperties_Template\|ReturnType=number\|Name=<nowiki>Sum</nowiki>\|HasGetter=1\|Description=<nowiki>Sum of all the objects in the Array object. Can only use if all the elements are of type Number</nowiki>}}
	~~{{CGscriptProperties_Template\|ReturnType=int\|Name=<nowiki>Target</nowiki>\|HasGetter=1\|HasSetter=1\|Description=<nowiki>Absolute target user count (-1 = unlimited)</nowiki>}}~~
	{{CGscriptProperties_Template\|ReturnType=number\|Name=<nowiki>TargetPercentage</nowiki>\|HasGetter=1\|HasSetter=1\|Description=<nowiki>Target as a percentage of the parent rule (-1 = unlimited / not set)</nowiki>}}
	~~{{CGscriptProperties_Template\|ReturnType=TypeInformation\|Name=<nowiki>TypeInformation</nowiki>\|HasGetter=1\|Description=<nowiki>Get information about this class.</nowiki>}}~~
	{{CGscriptProperties_Template\|ReturnType=int\|Name=<nowiki>UserCount</nowiki>\|HasGetter=1\|Description=<nowiki>Actual number of users produced by this rule after the last rebuild</nowiki>}}\|StaticMethods={{CGscriptMethods_Template\|ReturnType=GroupRule\|Name=<nowiki>GroupRule_getRuleById</nowiki>\|Parameters=
	~~{{CGscriptParameters_Template\|Type=int\|Name=<nowiki>Group Rule id</nowiki>\|Description=<nowiki>Id of the group rule</nowiki>}}~~
	~~\|Description=<nowiki>Get the existing group rule object by using group rule id</nowiki>}}~~
	~~{{CGscriptMethods_Template\|ReturnType=number\|Name=<nowiki>GroupRule_getUserCount</nowiki>\|Parameters=~~
	~~{{CGscriptParameters_Template\|Type=int\|Name=<nowiki>Group Rule id</nowiki>\|Description=<nowiki>Id of the group rule</nowiki>}}~~
	~~\|Description=<nowiki>Return the actual number of users in a specified group builder rule</nowiki>}}}}~~

← Older revision		Revision as of 10:23, 2 June 2026
Line 10:		Line 10:
	{{CGscriptParameters_Template\|Type=GroupBuilderVariable\|Name=<nowiki>variable</nowiki>\|Description=<nowiki>Variable to add</nowiki>}}		{{CGscriptParameters_Template\|Type=GroupBuilderVariable\|Name=<nowiki>variable</nowiki>\|Description=<nowiki>Variable to add</nowiki>}}
	\|Description=<nowiki>Add a new variable</nowiki>}}		\|Description=<nowiki>Add a new variable</nowiki>}}
			{{CGscriptMethods_Template\|ReturnType=bool\|Name=<nowiki>Remove</nowiki>\|Parameters=
			{{CGscriptParameters_Template\|Type=GroupBuilderVariable\|Name=<nowiki>variable</nowiki>\|Description=<nowiki>Variable to remove</nowiki>}}
			\|Description=<nowiki>Remove variable. Return true if removed</nowiki>}}
			{{CGscriptMethods_Template\|ReturnType=Empty\|Name=<nowiki>Save</nowiki>\|Description=<nowiki>Save this group rule to the database</nowiki>}}
			{{CGscriptMethods_Template\|ReturnType=Empty\|Name=<nowiki>SetPercentTarget</nowiki>\|Parameters=
			{{CGscriptParameters_Template\|Type=int\|Name=<nowiki>Target percentage</nowiki>\|Description=<nowiki>Percentage target (-1 for unlimited)</nowiki>}}
			\|Description=<nowiki>Set a percentage target for this rule and save</nowiki>}}
			{{CGscriptMethods_Template\|ReturnType=Empty\|Name=<nowiki>SetTarget</nowiki>\|Parameters=
			{{CGscriptParameters_Template\|Type=int\|Name=<nowiki>Target</nowiki>\|Description=<nowiki>New target value (-1 for unlimited)</nowiki>}}
			\|Description=<nowiki>Set a new absolute target for this rule and save</nowiki>}}
			{{CGscriptMethods_Template\|ReturnType=Empty\|Name=<nowiki>SetTargetUnlimited</nowiki>\|Description=<nowiki>Set this rule's target to unlimited and save</nowiki>}}
			{{CGscriptMethods_Template\|ReturnType=string\|Name=<nowiki>ToString</nowiki>\|Description=<nowiki>The string representation of the object.</nowiki>}}
	{{CGscriptMethods_Template\|ReturnType=object\|Name=<nowiki>this[] { get; }</nowiki>\|Parameters=		{{CGscriptMethods_Template\|ReturnType=object\|Name=<nowiki>this[] { get; }</nowiki>\|Parameters=
	{{CGscriptParameters_Template\|Type=int\|Name=<nowiki>index</nowiki>\|Description=<nowiki>Index</nowiki>}}		{{CGscriptParameters_Template\|Type=int\|Name=<nowiki>index</nowiki>\|Description=<nowiki>Index</nowiki>}}
	\|Description=<nowiki>Get variable at index</nowiki>}}		\|Description=<nowiki>Get variable at index</nowiki>}}
	~~{{CGscriptMethods_Template\|ReturnType=bool\|Name=<nowiki>Remove</nowiki>\|Parameters=~~		{{CGscriptMethods_Template\|ReturnType=Empty\|Name=<nowiki>this[] { get; }</nowiki>\|Parameters=
	~~{{CGscriptParameters_Template\|Type=GroupBuilderVariable\|Name=<nowiki>variable</nowiki>\|Description=<nowiki>Variable to remove</nowiki>}}~~
	~~\|Description=<nowiki>Remove variable. Return true if removed</nowiki>}}~~
	{{CGscriptMethods_Template\|ReturnType=Empty\|Name=<nowiki>this[] { ~~set~~; }</nowiki>\|Parameters=
	{{CGscriptParameters_Template\|Type=int\|Name=<nowiki>index</nowiki>\|Description=<nowiki>Index</nowiki>\|Comma=,}}{{CGscriptParameters_Template\|Type=object\|Name=<nowiki>value</nowiki>\|Description=<nowiki>Value to set</nowiki>}}		{{CGscriptParameters_Template\|Type=int\|Name=<nowiki>index</nowiki>\|Description=<nowiki>Index</nowiki>\|Comma=,}}{{CGscriptParameters_Template\|Type=object\|Name=<nowiki>value</nowiki>\|Description=<nowiki>Value to set</nowiki>}}
	\|Description=<nowiki>Set variable at index</nowiki>}}		\|Description=<nowiki>Set variable at index</nowiki>}}
	~~{{CGscriptMethods_Template\|ReturnType=string\|Name=<nowiki>ToString</nowiki>\|Inherited=object\|Description=<nowiki>The string representation of the object.</nowiki>}}~~
	\|Properties=		\|Properties=
	{{CGscriptProperties_Template\|ReturnType=int\|Name=<nowiki>Actual</nowiki>\|HasGetter=1\|Description=<nowiki>How many of the final group amount was generated from this rule</nowiki>}}		{{CGscriptProperties_Template\|ReturnType=int\|Name=<nowiki>Actual</nowiki>\|HasGetter=1\|Description=<nowiki>How many of the final group amount was generated from this rule</nowiki>}}
	{{CGscriptProperties_Template\|ReturnType=GroupBuilderRuleCollection\|Name=<nowiki>Children</nowiki>\|HasGetter=1\|Description=<nowiki>Child rules for this rule</nowiki>}}		{{CGscriptProperties_Template\|ReturnType=GroupBuilderRuleCollection\|Name=<nowiki>Children</nowiki>\|HasGetter=1\|Description=<nowiki>Child rules for this rule</nowiki>}}
	{{CGscriptProperties_Template\|ReturnType=int\|Name=<nowiki>Count</nowiki>\|HasGetter=1\|Description=<nowiki>Number of variables at this level</nowiki>}}		{{CGscriptProperties_Template\|ReturnType=int\|Name=<nowiki>Count</nowiki>\|HasGetter=1\|Description=<nowiki>Number of variables at this level</nowiki>}}
			{{CGscriptProperties_Template\|ReturnType=int\|Name=<nowiki>Id</nowiki>\|HasGetter=1\|Description=<nowiki>Primary-key id of the rule</nowiki>}}
	{{CGscriptProperties_Template\|ReturnType=bool\|Name=<nowiki>IncludeDeleted</nowiki>\|HasGetter=1\|HasSetter=1\|Description=<nowiki>Include deleted users or not</nowiki>}}		{{CGscriptProperties_Template\|ReturnType=bool\|Name=<nowiki>IncludeDeleted</nowiki>\|HasGetter=1\|HasSetter=1\|Description=<nowiki>Include deleted users or not</nowiki>}}
	{{CGscriptProperties_Template\|ReturnType=bool\|Name=<nowiki>IncludeDisabled</nowiki>\|HasGetter=1\|HasSetter=1\|Description=<nowiki>Include disabled users or not</nowiki>}}		{{CGscriptProperties_Template\|ReturnType=bool\|Name=<nowiki>IncludeDisabled</nowiki>\|HasGetter=1\|HasSetter=1\|Description=<nowiki>Include disabled users or not</nowiki>}}
Line 31:		Line 40:
	{{CGscriptProperties_Template\|ReturnType=int\|Name=<nowiki>Target</nowiki>\|HasGetter=1\|HasSetter=1\|Description=<nowiki>Target amount to build for this group. -1 == all</nowiki>}}		{{CGscriptProperties_Template\|ReturnType=int\|Name=<nowiki>Target</nowiki>\|HasGetter=1\|HasSetter=1\|Description=<nowiki>Target amount to build for this group. -1 == all</nowiki>}}
	{{CGscriptProperties_Template\|ReturnType=number\|Name=<nowiki>TargetPct</nowiki>\|HasGetter=1\|HasSetter=1\|Description=<nowiki>Target as pct of parent. -1 == use Target</nowiki>}}		{{CGscriptProperties_Template\|ReturnType=number\|Name=<nowiki>TargetPct</nowiki>\|HasGetter=1\|HasSetter=1\|Description=<nowiki>Target as pct of parent. -1 == use Target</nowiki>}}
	{{CGscriptProperties_Template\|ReturnType=TypeInformation\|Name=<nowiki>TypeInformation</nowiki>\|HasGetter=1~~\|Inherited=object~~\|Description=<nowiki>Get information about this class.</nowiki>}}		{{CGscriptProperties_Template\|ReturnType=number\|Name=<nowiki>TargetPercentage</nowiki>\|HasGetter=1\|HasSetter=1\|Description=<nowiki>Target as a percentage of the parent rule (-1 = unlimited / not set)</nowiki>}}
			{{CGscriptProperties_Template\|ReturnType=TypeInformation\|Name=<nowiki>TypeInformation</nowiki>\|HasGetter=1\|Description=<nowiki>Get information about this class.</nowiki>}}
			{{CGscriptProperties_Template\|ReturnType=int\|Name=<nowiki>UserCount</nowiki>\|HasGetter=1\|Description=<nowiki>Actual number of users produced by this rule after the last rebuild</nowiki>}}
			\|StaticMethods=
			{{CGscriptMethods_Template\|ReturnType=GroupBuilderRule\|Name=<nowiki>GroupBuilderRule_getRuleById</nowiki>\|Parameters=
			{{CGscriptParameters_Template\|Type=int\|Name=<nowiki>Group Rule id</nowiki>\|Description=<nowiki>Id of the group rule</nowiki>}}
			\|Description=<nowiki>Get the existing group builder rule object by using group rule id</nowiki>}}
			{{CGscriptMethods_Template\|ReturnType=number\|Name=<nowiki>GroupBuilderRule_getUserCount</nowiki>\|Parameters=
			{{CGscriptParameters_Template\|Type=int\|Name=<nowiki>Group Rule id</nowiki>\|Description=<nowiki>Id of the group rule</nowiki>}}
			\|Description=<nowiki>Return the actual number of users in a specified group builder rule</nowiki>}}
	}}		}}