Difference between revisions of "GroupBuilderBulkmailHistoryVariable class"

From Catglobe Wiki
Jump to: navigation, search
(Created page with "{{CGscriptClass_Template |Name=GroupBuilderBulkmailHistoryVariable |Description=Represents a group builder variable for bulkmail history. |Constructors= {{CGscriptConstructors...")
 
 
(One intermediate revision by one other user not shown)
Line 1: Line 1:
 
{{CGscriptClass_Template
 
{{CGscriptClass_Template
|Name=GroupBuilderBulkmailHistoryVariable
+
|Name=<nowiki>GroupBuilderBulkmailHistoryVariable</nowiki>
|Description=Represents a group builder variable for bulkmail history.
+
|Description=<nowiki>Represents a group builder variable for bulkmail history.</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=int|Name=BulkmailResourceId|HasGetter=1|HasSetter=1|Description=Bulkmail to get users from}}
+
{{CGscriptProperties_Template|ReturnType=int|Name=<nowiki>BulkmailResourceId</nowiki>|HasGetter=1|HasSetter=1|Description=<nowiki>Bulkmail to get users from</nowiki>}}
{{CGscriptProperties_Template|ReturnType=bool|Name=DependantSendToCompleted|HasGetter=1|HasSetter=1|Description=Respondents that have completed their QAS gets included if set}}
+
{{CGscriptProperties_Template|ReturnType=bool|Name=<nowiki>DependantSendToCompleted</nowiki>|HasGetter=1|HasSetter=1|Description=<nowiki>Respondents that have completed their QAS gets included if set</nowiki>}}
{{CGscriptProperties_Template|ReturnType=bool|Name=DependantSendToNotStarted|HasGetter=1|HasSetter=1|Description=Respondents that have not yet started their QAS gets included if set}}
+
{{CGscriptProperties_Template|ReturnType=bool|Name=<nowiki>DependantSendToNotStarted</nowiki>|HasGetter=1|HasSetter=1|Description=<nowiki>Respondents that have not yet started their QAS gets included if set</nowiki>}}
{{CGscriptProperties_Template|ReturnType=bool|Name=DependantSendToPartly|HasGetter=1|HasSetter=1|Description=Respondents that have partly completed their QAS gets included if set}}
+
{{CGscriptProperties_Template|ReturnType=bool|Name=<nowiki>DependantSendToPartly</nowiki>|HasGetter=1|HasSetter=1|Description=<nowiki>Respondents that have partly completed their QAS gets included if set</nowiki>}}
{{CGscriptProperties_Template|ReturnType=array|Name=History|HasGetter=1|HasSetter=1|Description=History items to get users from}}
+
{{CGscriptProperties_Template|ReturnType=array|Name=<nowiki>History</nowiki>|HasGetter=1|HasSetter=1|Description=<nowiki>History items to get users from</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>}}
 
}}
 
}}
 +
 +
=== <span style="color:#DF8621">'''Examples'''</span> ===
 +
 +
<source lang="javascript">
 +
//Create a new group
 +
string groupName = "Test Group Builder: bulkmailHistoryVariable";
 +
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);
 +
 +
GroupBuilderBulkmailHistoryVariable bulkmailHistoryVariable = new GroupBuilderBulkmailHistoryVariable();
 +
bulkmailHistoryVariable.BulkmailResourceId=15547138;
 +
bulkmailHistoryVariable.DependantSendToCompleted = false;
 +
bulkmailHistoryVariable.DependantSendToNotStarted = true;
 +
bulkmailHistoryVariable.DependantSendToPartly = false;
 +
bulkmailHistoryVariable.History={53481,53482};
 +
 +
GroupBuilderRule rule = new GroupBuilderRule (root);
 +
rule.Add(bulkmailHistoryVariable);
 +
 +
GroupBuilderRuleCollection ruleColection = root.RootRules;
 +
ruleColection.Add(rule);
 +
 +
root.Save();
 +
</source>

Latest revision as of 07:50, 2 July 2020

GroupBuilderBulkmailHistoryVariable


Represents a group builder variable for bulkmail history.

Parent class

Inherits from GroupBuilderVariable

Constructors

  • () - Create new variable

Methods

  • (From object) string ToString() - The string representation of the object.

Properties

  • int BulkmailResourceId { get; set; } - Bulkmail to get users from
  • bool DependantSendToCompleted { get; set; } - Respondents that have completed their QAS gets included if set
  • bool DependantSendToNotStarted { get; set; } - Respondents that have not yet started their QAS gets included if set
  • bool DependantSendToPartly { get; set; } - Respondents that have partly completed their QAS gets included if set
  • array History { get; set; } - History items to get users from
  • string ObjectTypeName { get; } - The name of the type of object.
  • (From object) TypeInformation TypeInformation { get; } - Get information about this class.


Examples

//Create a new group
string groupName = "Test Group Builder: bulkmailHistoryVariable";
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); 
 
GroupBuilderBulkmailHistoryVariable bulkmailHistoryVariable = new GroupBuilderBulkmailHistoryVariable();
bulkmailHistoryVariable.BulkmailResourceId=15547138;
bulkmailHistoryVariable.DependantSendToCompleted = false;
bulkmailHistoryVariable.DependantSendToNotStarted = true;
bulkmailHistoryVariable.DependantSendToPartly = false;
bulkmailHistoryVariable.History={53481,53482};
 
GroupBuilderRule rule = new GroupBuilderRule (root);
rule.Add(bulkmailHistoryVariable);
 
GroupBuilderRuleCollection ruleColection = root.RootRules;
ruleColection.Add(rule);
 
root.Save();