GroupBuilderGroupVariable class - Revision history

Administrator at 07:26, 2 July 2020

2020-07-02T07:26:06Z

← Older revision		Revision as of 07:26, 2 July 2020
Line 1:		Line 1:
	{{CGscriptClass_Template		{{CGscriptClass_Template
	\|Name=GroupBuilderGroupVariable		\|Name=<nowiki>GroupBuilderGroupVariable</nowiki>
	\|Description=Represents a group builder variable for group membership.		\|Description=<nowiki>Represents a group builder variable for group membership.</nowiki>
	\|Constructors=		\|InheritsFrom=GroupBuilderVariable\|Constructors=
	{{CGscriptConstructors_Template\|Parameters=		{{CGscriptConstructors_Template\|Parameters=
	{{CGscriptParameters_Template\|Type=bool\|Name=include\|Description=Include users, or if false exclude users}}		{{CGscriptParameters_Template\|Type=bool\|Name=<nowiki>include</nowiki>\|Description=<nowiki>Include users, or if false exclude users</nowiki>}}
	\|Description=Create new variable}}		\|Description=<nowiki>Create new variable</nowiki>}}
	\|Methods=		\|Methods=
	{{CGscriptMethods_Template\|ReturnType=Empty\|Name=Add\|Parameters=		{{CGscriptMethods_Template\|ReturnType=Empty\|Name=<nowiki>Add</nowiki>\|Parameters=
	{{CGscriptParameters_Template\|Type=int\|Name=groupResourceId\|Description=Group resource id to add}}		{{CGscriptParameters_Template\|Type=int\|Name=<nowiki>groupResourceId</nowiki>\|Description=<nowiki>Group resource id to add</nowiki>}}
	\|Description=Add a new group}}		\|Description=<nowiki>Add a new group</nowiki>}}
	{{CGscriptMethods_Template\|ReturnType=~~int~~\|Name=this[] { get; }\|Parameters=		{{CGscriptMethods_Template\|ReturnType=object\|Name=<nowiki>this[] { get; }</nowiki>\|Parameters=
	{{CGscriptParameters_Template\|Type=int\|Name=index\|Description=Index}}		{{CGscriptParameters_Template\|Type=int\|Name=<nowiki>index</nowiki>\|Description=<nowiki>Index</nowiki>}}
	\|Description=Get group resource id at index}}		\|Description=<nowiki>Get group resource id at index</nowiki>}}
	{{CGscriptMethods_Template\|ReturnType=bool\|Name=Remove\|Parameters=		{{CGscriptMethods_Template\|ReturnType=bool\|Name=<nowiki>Remove</nowiki>\|Parameters=
	{{CGscriptParameters_Template\|Type=int\|Name=groupResourceId\|Description=Group resource id to remove}}		{{CGscriptParameters_Template\|Type=int\|Name=<nowiki>groupResourceId</nowiki>\|Description=<nowiki>Group resource id to remove</nowiki>}}
	\|Description=Remove group. Return true if removed}}		\|Description=<nowiki>Remove group. Return true if removed</nowiki>}}
	{{CGscriptMethods_Template\|ReturnType=string\|Name=ToString\|Description=The string representation of the object.}}		{{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=Count\|HasGetter=1\|Description=Number of groups}}		{{CGscriptProperties_Template\|ReturnType=int\|Name=<nowiki>Count</nowiki>\|HasGetter=1\|Description=<nowiki>Number of groups</nowiki>}}
	{{CGscriptProperties_Template\|ReturnType=bool\|Name=Include\|HasGetter=1\|Description=Include users that match rule, or exclude}}		{{CGscriptProperties_Template\|ReturnType=bool\|Name=<nowiki>Include</nowiki>\|HasGetter=1\|Description=<nowiki>Include users that match rule, or exclude</nowiki>}}
	{{CGscriptProperties_Template\|ReturnType=string\|Name=ObjectTypeName\|HasGetter=1\|Description=The name of the type of object.}}		{{CGscriptProperties_Template\|ReturnType=string\|Name=<nowiki>ObjectTypeName</nowiki>\|HasGetter=1\|Description=<nowiki>The name of the type of object.</nowiki>}}
	{{CGscriptProperties_Template\|ReturnType=TypeInformation\|Name=TypeInformation\|HasGetter=1\|Description=Get information about this class.}}		{{CGscriptProperties_Template\|ReturnType=TypeInformation\|Name=<nowiki>TypeInformation</nowiki>\|HasGetter=1\|Inherited=object\|Description=<nowiki>Get information about this class.</nowiki>}}
	}}		}}

Nguyenduyan at 04:56, 30 March 2017

2017-03-30T04:56:24Z

← Older revision		Revision as of 04:56, 30 March 2017
Line 26:		Line 26:
	=== <span style="color:#DF8621">'''Examples'''</span> ===		=== <span style="color:#DF8621">'''Examples'''</span> ===

	'''Example: Add group variable''' <source lang="javascript">		'''Example: Add group variable'''
			<source lang="javascript">
	//Create a new group		//Create a new group
	string groupName = "Test Group Builder: groupVariable";		string groupName = "Test Group Builder: groupVariable";
Line 52:		Line 53:
	//Rebuild group		//Rebuild group
	Group_rebuildGroup(groupRId,true);		Group_rebuildGroup(groupRId,true);
	</source><br/>'''Example: Remove group variable''' <source lang="javascript">		</source>
			<br/>
			'''Example: Remove group variable'''
			<source lang="javascript">
	number groupRId = 15560550;		number groupRId = 15560550;

Line 60:		Line 64:
	GroupBuilderRule rule = ruleColection[0];		GroupBuilderRule rule = ruleColection[0];
	GroupBuilderGroupVariable groupVariable = rule[0];		GroupBuilderGroupVariable groupVariable = rule[0];
			print(groupVariable.Count);
	groupVariable.Remove(15085949);		groupVariable.Remove(15085949);

	root.Save();		root.Save();
	</source>		</source>

Nguyenduyan at 04:54, 30 March 2017

2017-03-30T04:54:15Z

← Older revision		Revision as of 04:54, 30 March 2017
Line 23:		Line 23:
	{{CGscriptProperties_Template\|ReturnType=TypeInformation\|Name=TypeInformation\|HasGetter=1\|Description=Get information about this class.}}		{{CGscriptProperties_Template\|ReturnType=TypeInformation\|Name=TypeInformation\|HasGetter=1\|Description=Get information about this class.}}
	}}		}}

			=== <span style="color:#DF8621">'''Examples'''</span> ===

			'''Example: Add group variable''' <source lang="javascript">
			//Create a new group
			string groupName = "Test Group Builder: groupVariable";
			number groupTemplateResourceId=2066;
			number parentResourceId = 11088827;
			array group = Group_new(groupName, groupTemplateResourceId, parentResourceId);
			Group_save(group);
			number groupRId = group[GROUP_RESOURCE_ID ];

			//Create rule for the group
			GroupBuilderRoot root = new GroupBuilderRoot (groupRId);

			GroupBuilderGroupVariable groupVariable = new GroupBuilderGroupVariable (true);//true: include; false: exclude
			groupVariable.Add(15547043);// 15547043: resourceId of group want to add to
			groupVariable.Add(15085949);// 15085949: resourceId of group want to add to

			GroupBuilderRule rule = new GroupBuilderRule (root);
			rule.Add(groupVariable);

			GroupBuilderRuleCollection ruleColection = root.RootRules;
			ruleColection.Add(rule);

			root.Save();

			//Rebuild group
			Group_rebuildGroup(groupRId,true);
			</source><br/>'''Example: Remove group variable''' <source lang="javascript">
			number groupRId = 15560550;

			GroupBuilderRoot root = new GroupBuilderRoot (groupRId);

			GroupBuilderRuleCollection ruleColection = root.RootRules;
			GroupBuilderRule rule = ruleColection[0];
			GroupBuilderGroupVariable groupVariable = rule[0];
			groupVariable.Remove(15085949);

			root.Save();
			</source>

Nguyenduyan: Created page with "{{CGscriptClass_Template |Name=GroupBuilderGroupVariable |Description=Represents a group builder variable for group membership. |Constructors= {{CGscriptConstructors_Template|..."

2017-03-28T09:57:11Z

Created page with "{{CGscriptClass_Template |Name=GroupBuilderGroupVariable |Description=Represents a group builder variable for group membership. |Constructors= {{CGscriptConstructors_Template|..."

New page

{{CGscriptClass_Template
|Name=GroupBuilderGroupVariable
|Description=Represents a group builder variable for group membership.
|Constructors=
{{CGscriptConstructors_Template|Parameters=
{{CGscriptParameters_Template|Type=bool|Name=include|Description=Include users, or if false exclude users}}
|Description=Create new variable}}
|Methods=
{{CGscriptMethods_Template|ReturnType=Empty|Name=Add|Parameters=
{{CGscriptParameters_Template|Type=int|Name=groupResourceId|Description=Group resource id to add}}
|Description=Add a new group}}
{{CGscriptMethods_Template|ReturnType=int|Name=this[] { get; }|Parameters=
{{CGscriptParameters_Template|Type=int|Name=index|Description=Index}}
|Description=Get group resource id at index}}
{{CGscriptMethods_Template|ReturnType=bool|Name=Remove|Parameters=
{{CGscriptParameters_Template|Type=int|Name=groupResourceId|Description=Group resource id to remove}}
|Description=Remove group. Return true if removed}}
{{CGscriptMethods_Template|ReturnType=string|Name=ToString|Description=The string representation of the object.}}
|Properties=
{{CGscriptProperties_Template|ReturnType=int|Name=Count|HasGetter=1|Description=Number of groups}}
{{CGscriptProperties_Template|ReturnType=bool|Name=Include|HasGetter=1|Description=Include users that match rule, or exclude}}
{{CGscriptProperties_Template|ReturnType=string|Name=ObjectTypeName|HasGetter=1|Description=The name of the type of object.}}
{{CGscriptProperties_Template|ReturnType=TypeInformation|Name=TypeInformation|HasGetter=1|Description=Get information about this class.}}
}}