Difference between revisions of "GroupBuilderBulkmailVariable class"

From Catglobe Wiki
Jump to: navigation, search
 
Line 1: Line 1:
 
{{CGscriptClass_Template
 
{{CGscriptClass_Template
|Name=GroupBuilderBulkmailVariable
+
|Name=<nowiki>GroupBuilderBulkmailVariable</nowiki>
|Description=Represents a group builder variable for bulkmail.
+
|Description=<nowiki>Represents a group builder variable for bulkmail.</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=Include|HasGetter=1|HasSetter=1|Description=Include users that match rule, or exclude}}
+
{{CGscriptProperties_Template|ReturnType=bool|Name=<nowiki>Include</nowiki>|HasGetter=1|HasSetter=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>}}
 
}}
 
}}
  

Latest revision as of 08:52, 2 July 2020

GroupBuilderBulkmailVariable


Represents a group builder variable for bulkmail.

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 Include { get; set; } - Include users that match rule, or exclude
  • 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: bulkmailVariable";
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); 
 
GroupBuilderBulkmailVariable bulkmailVariable = new GroupBuilderBulkmailVariable ();
bulkmailVariable.BulkmailResourceId=15547138;
bulkmailVariable.Include=true;
 
GroupBuilderRule rule = new GroupBuilderRule (root);
rule.Add(bulkmailVariable);
 
GroupBuilderRuleCollection ruleColection = root.RootRules;
ruleColection.Add(rule);
 
root.Save();