Difference between revisions of "GroupBuilderProtectedUntilVariable class"

From Catglobe Wiki
Jump to: navigation, search
(Created page with "{{CGscriptClass_Template |Name=GroupBuilderProtectedUntilVariable |Description=Represents a group builder variable for users that are available at the given day. |Constructors...")
 
 
(One intermediate revision by one other user not shown)
Line 1: Line 1:
 
{{CGscriptClass_Template
 
{{CGscriptClass_Template
|Name=GroupBuilderProtectedUntilVariable
+
|Name=<nowiki>GroupBuilderProtectedUntilVariable</nowiki>
|Description=Represents a group builder variable for users that are available at the given day.
+
|Description=<nowiki>Represents a group builder variable for users that are available at the given day.</nowiki>
|Constructors=
+
|InheritsFrom=GroupBuilderVariable|Constructors=
{{CGscriptConstructors_Template|Description=Create new variable}}
+
{{CGscriptConstructors_Template|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=DateTime|Name=ProtectedUntilDate|HasGetter=1|HasSetter=1|Description=The date to check if a user is available}}
+
{{CGscriptProperties_Template|ReturnType=DateTime|Name=<nowiki>ProtectedUntilDate</nowiki>|HasGetter=1|HasSetter=1|Description=<nowiki>The date to check if a user is available</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: protectedUntilVariable";
 +
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);
 +
GroupBuilderProtectedUntilVariable protectedUntilVariable = new GroupBuilderProtectedUntilVariable();
 +
DateTime date = new DateTime("2017-4-19");
 +
protectedUntilVariable.ProtectedUntilDate = date;
 +
GroupBuilderRule rule = new GroupBuilderRule (root);
 +
rule.Add(protectedUntilVariable);
 +
GroupBuilderRuleCollection ruleColection = root.RootRules;
 +
ruleColection.Add(rule);
 +
root.Save();
 +
</source>

Latest revision as of 06:25, 2 July 2020

GroupBuilderProtectedUntilVariable


Represents a group builder variable for users that are available at the given day.

Parent class

Inherits from GroupBuilderVariable

Constructors

  • () - 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.
  • DateTime ProtectedUntilDate { get; set; } - The date to check if a user is available
  • (From object) TypeInformation TypeInformation { get; } - Get information about this class.


Examples

//Create a new group
string groupName = "Test Group Builder: protectedUntilVariable";
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);
GroupBuilderProtectedUntilVariable protectedUntilVariable = new GroupBuilderProtectedUntilVariable();
DateTime date = new DateTime("2017-4-19");
protectedUntilVariable.ProtectedUntilDate = date; 
GroupBuilderRule rule = new GroupBuilderRule (root);
rule.Add(protectedUntilVariable); 
GroupBuilderRuleCollection ruleColection = root.RootRules;
ruleColection.Add(rule); 
root.Save();