GroupBuilderTemplateVariable class: Difference between revisions
From Catglobe Wiki
More actions
Nguyenduyan (talk | contribs) Created page with "{{CGscriptClass_Template |Name=GroupBuilderTemplateVariable |Description=Represents a group builder variable for users with no or invalid emails. |Constructors= {{CGscriptCons..." |
No edit summary |
||
| (One intermediate revision by one other user not shown) | |||
| Line 1: | Line 1: | ||
{{CGscriptClass_Template | {{CGscriptClass_Template | ||
|Name=GroupBuilderTemplateVariable | |Name=<nowiki>GroupBuilderTemplateVariable</nowiki> | ||
|Description=Represents a group builder variable for users with no or invalid emails. | |Description=<nowiki>Represents a group builder variable for users with no or invalid emails.</nowiki> | ||
|Constructors= | |InheritsFrom=GroupBuilderVariable|Constructors= | ||
{{CGscriptConstructors_Template|Parameters= | {{CGscriptConstructors_Template|Parameters= | ||
{{CGscriptParameters_Template|Type=bool|Name=userOrGroupResourceTemplate|Description=If true search for users with specific user resource template, otherwise search for users that belongs to groups of specific resource template}} | {{CGscriptParameters_Template|Type=bool|Name=<nowiki>userOrGroupResourceTemplate</nowiki>|Description=<nowiki>If true search for users with specific user resource template, otherwise search for users that belongs to groups of specific resource template</nowiki>}} | ||
|Description=Create new variable}} | |Description=<nowiki>Create new variable</nowiki>}} | ||
|Methods= | |Methods= | ||
{{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=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=int|Name=ResourceTemplateResourceId|HasGetter=1|HasSetter=1|Description=Group or user resource template to get users from}} | {{CGscriptProperties_Template|ReturnType=int|Name=<nowiki>ResourceTemplateResourceId</nowiki>|HasGetter=1|HasSetter=1|Description=<nowiki>Group or user resource template to get users from</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>}} | ||
}} | }} | ||
=== <span style="color:#DF8621">'''Examples'''</span> === | |||
<source lang="javascript"> | |||
//Create a new group | |||
string groupName = "Test Group Builder: templateVariable"; | |||
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); | |||
GroupBuilderTemplateVariable userTemplateVariable = new GroupBuilderTemplateVariable(true); | |||
userTemplateVariable.ResourceTemplateResourceId = 1842; | |||
GroupBuilderTemplateVariable groupTemplateVariable = new GroupBuilderTemplateVariable(false); | |||
groupTemplateVariable.ResourceTemplateResourceId = 2066; | |||
GroupBuilderRule rule = new GroupBuilderRule (root); | |||
rule.Add(userTemplateVariable); | |||
rule.Add(groupTemplateVariable); | |||
GroupBuilderRuleCollection ruleColection = root.RootRules; | |||
ruleColection.Add(rule); | |||
root.Save(); | |||
</source> | |||
Latest revision as of 04:54, 2 July 2020
GroupBuilderTemplateVariable
Represents a group builder variable for users with no or invalid emails.
Parent class
Inherits from GroupBuilderVariable
Constructors
- (bool userOrGroupResourceTemplate "If true search for users with specific user resource template, otherwise search for users that belongs to groups of specific resource template") - Create new variable
Methods
- (From object) string ToString() - The string representation of the object.
Properties
- string ObjectTypeName { get; } - The name of the type of object.
- int ResourceTemplateResourceId { get; set; } - Group or user resource template to get users from
- (From object) TypeInformation TypeInformation { get; } - Get information about this class.
Examples
//Create a new group
string groupName = "Test Group Builder: templateVariable";
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);
GroupBuilderTemplateVariable userTemplateVariable = new GroupBuilderTemplateVariable(true);
userTemplateVariable.ResourceTemplateResourceId = 1842;
GroupBuilderTemplateVariable groupTemplateVariable = new GroupBuilderTemplateVariable(false);
groupTemplateVariable.ResourceTemplateResourceId = 2066;
GroupBuilderRule rule = new GroupBuilderRule (root);
rule.Add(userTemplateVariable);
rule.Add(groupTemplateVariable);
GroupBuilderRuleCollection ruleColection = root.RootRules;
ruleColection.Add(rule);
root.Save();