Difference between revisions of "GroupBuilderCatiOutcomeVariable class"

From Catglobe Wiki
Jump to: navigation, search
 
(One intermediate revision by one other user not shown)
Line 1: Line 1:
 
{{CGscriptClass_Template
 
{{CGscriptClass_Template
|Name=GroupBuilderCatiOutcomeVariable
+
|Name=<nowiki>GroupBuilderCatiOutcomeVariable</nowiki>
|Description=Represents a group builder variable for Cati outcome.
+
|Description=<nowiki>Represents a group builder variable for Cati outcome.</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=int|Name=QuestionnaireResourceId|HasGetter=1|HasSetter=1|Description=Questionnaire to get users from}}
+
{{CGscriptProperties_Template|ReturnType=int|Name=<nowiki>QuestionnaireResourceId</nowiki>|HasGetter=1|HasSetter=1|Description=<nowiki>Questionnaire to get users from</nowiki>}}
{{CGscriptProperties_Template|ReturnType=array|Name=Status|HasGetter=1|HasSetter=1|Description=Set which status to look for, use Cati_ContactStatus_* constants}}
+
{{CGscriptProperties_Template|ReturnType=array|Name=<nowiki>Status</nowiki>|HasGetter=1|HasSetter=1|Description=<nowiki>Set which status to look for, use Cati_ContactStatus_* constants</nowiki>}}
{{CGscriptProperties_Template|ReturnType=array|Name=StatusId|HasGetter=1|HasSetter=1|Description=List of specific outcomes to include}}
+
{{CGscriptProperties_Template|ReturnType=array|Name=<nowiki>StatusId</nowiki>|HasGetter=1|HasSetter=1|Description=<nowiki>List of specific outcomes to include</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> ===
 
=== <span style="color:#DF8621">'''Examples'''</span> ===
 
<source lang="javascript">
 
<source lang="javascript">
Line 34: Line 35:
 
ruleColection.Add(rule);  
 
ruleColection.Add(rule);  
 
root.Save();
 
root.Save();
 +
</source>

Latest revision as of 07:30, 2 July 2020

GroupBuilderCatiOutcomeVariable


Represents a group builder variable for Cati outcome.

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.
  • int QuestionnaireResourceId { get; set; } - Questionnaire to get users from
  • array Status { get; set; } - Set which status to look for, use Cati_ContactStatus_* constants
  • array StatusId { get; set; } - List of specific outcomes to include
  • (From object) TypeInformation TypeInformation { get; } - Get information about this class.


Examples

//Create a new group
string groupName = "Test Group Builder: catiOutcomeVariable";
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);
GroupBuilderCatiOutcomeVariable  catiOutcomeVariable = new GroupBuilderCatiOutcomeVariable  ();
catiOutcomeVariable.QuestionnaireResourceId = 15546533;
//catiOutcomeVariable.Status ={1,2,3,4};
catiOutcomeVariable.Status = {Cati_ContactStatus_Success, Cati_ContactStatus_Failure, Cati_ContactStatus_Meeting, Cati_ContactStatus_Retry};
//catiOutcomeVariable.StatusId = {10351,10352}; 
GroupBuilderRule rule = new GroupBuilderRule (root);
rule.Add(catiOutcomeVariable); 
GroupBuilderRuleCollection ruleColection = root.RootRules;
ruleColection.Add(rule); 
root.Save();