View source for GroupBuilderContactAmountVariable class

{{CGscriptClass_Template
|Name=GroupBuilderContactAmountVariable
|Description=Represents a group builder variable for contact amount.
|Constructors=
{{CGscriptConstructors_Template|Description=Create new variable}}
|Methods=
{{CGscriptMethods_Template|ReturnType=Empty|Name=SetFixedDateLimited|Parameters=
{{CGscriptParameters_Template|Type=DateTime|Name=fromDate|Description=From date|Comma=,}}{{CGscriptParameters_Template|Type=DateTime|Name=toDate|Description=To date}}
|Description=Set a fixed date limitation}}
{{CGscriptMethods_Template|ReturnType=Empty|Name=SetFloatingDateLimited|Parameters=
{{CGscriptParameters_Template|Type=int|Name=nrDaysBefore|Description=Number of days before today to start|Comma=,}}{{CGscriptParameters_Template|Type=int|Name=nrDays|Description=Number of days to include}}
|Description=Set a floating date limitation}}
{{CGscriptMethods_Template|ReturnType=Empty|Name=SetMailType|Parameters=
{{CGscriptParameters_Template|Type=bool|Name=isEmail|Description=Include normal emails sent|Comma=,}}{{CGscriptParameters_Template|Type=bool|Name=isBulkmail|Description=Include bulk emails sent}}
|Description=Include normal emails sent and/or bulkmails}}
{{CGscriptMethods_Template|ReturnType=Empty|Name=SetNotDateLimited|Description=Remove date limitation}}
{{CGscriptMethods_Template|ReturnType=string|Name=ToString|Description=The string representation of the object.}}
|Properties=
{{CGscriptProperties_Template|ReturnType=int|Name=GroupResourceId|HasGetter=1|HasSetter=1|Description=Include only mails sent sent to people in this group}}
{{CGscriptProperties_Template|ReturnType=bool|Name=IsBulkmail|HasGetter=1|Description=Include bulk emails sent}}
{{CGscriptProperties_Template|ReturnType=bool|Name=IsEmail|HasGetter=1|Description=Include normal emails sent}}
{{CGscriptProperties_Template|ReturnType=bool|Name=IsFixedDateLimited|HasGetter=1|Description=Include all users within date range}}
{{CGscriptProperties_Template|ReturnType=bool|Name=IsFloatingDateLimited|HasGetter=1|Description=Include all users within floating date range}}
{{CGscriptProperties_Template|ReturnType=bool|Name=IsNotDateLimited|HasGetter=1|Description=Include all users date wise}}
{{CGscriptProperties_Template|ReturnType=string|Name=ObjectTypeName|HasGetter=1|Description=The name of the type of object.}}
{{CGscriptProperties_Template|ReturnType=string|Name=Operator|HasGetter=1|HasSetter=1|Description=Include those that received more, the exact or less emails than the target given}}
{{CGscriptProperties_Template|ReturnType=int|Name=Target|HasGetter=1|HasSetter=1|Description=Include those that received more, the exact or less emails than the target given}}
{{CGscriptProperties_Template|ReturnType=int|Name=TargetResourceId|HasGetter=1|HasSetter=1|Description=Include only mails sent directly under this resource}}
{{CGscriptProperties_Template|ReturnType=TypeInformation|Name=TypeInformation|HasGetter=1|Description=Get information about this class.}}
}}

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

<source lang="javascript">
//Create a new group
string groupName = "Test Group Builder: ContactAmountVariable";
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);
 
GroupBuilderContactAmountVariable ContactAmountVariable = new GroupBuilderContactAmountVariable ();

DateTime fromDate = new DateTime("2017/03/25");
DateTime toDate = new DateTime("2017/03/31");
ContactAmountVariable.SetFixedDateLimited(fromDate,toDate);

//number nrDaysBefore = 6;
//number nrDays=5;
//ContactAmountVariable.SetFloatingDateLimited(nrDaysBefore ,nrDays);

bool isEmail = true;
bool isBulkmail = false;
ContactAmountVariable.SetMailType(isEmail, isBulkmail);

//ContactAmountVariable.SetNotDateLimited();

ContactAmountVariable.GroupResourceId =15560179;
ContactAmountVariable.TargetResourceId =15546533;
ContactAmountVariable.Operator=">";
ContactAmountVariable.Target=1;
 
print(ContactAmountVariable.IsBulkmail );// false
print(ContactAmountVariable.IsEmail );// true
print(ContactAmountVariable.IsFixedDateLimited );// true
print(ContactAmountVariable.IsFloatingDateLimited );//false
print(ContactAmountVariable.IsNotDateLimited );// false
print(ContactAmountVariable.Operator );// >
print(ContactAmountVariable.Target );// 1
print(ContactAmountVariable.GroupResourceId );// 15560179
print(ContactAmountVariable.TargetResourceId );// 15546533
 
GroupBuilderRule rule = new GroupBuilderRule (root);
rule.Add(ContactAmountVariable);
 
GroupBuilderRuleCollection ruleColection = root.RootRules;
ruleColection.Add(rule);
 
root.Save();
</source>