Difference between revisions of "SampleRule class"

From Catglobe Wiki
Jump to: navigation, search
(Created page with "{{CGscriptClass_Template |Name=<nowiki>SampleRule</nowiki> |Description=<nowiki>Represents a SampleRule.</nowiki> |Methods= {{CGscriptMethods_Template|ReturnType=Empty|Name=<n...")
 
Line 8: Line 8:
 
{{CGscriptProperties_Template|ReturnType=bool|Name=<nowiki>Active</nowiki>|HasGetter=1|HasSetter=1|Description=<nowiki>Get/Set if the SampleRule is active or not</nowiki>}}
 
{{CGscriptProperties_Template|ReturnType=bool|Name=<nowiki>Active</nowiki>|HasGetter=1|HasSetter=1|Description=<nowiki>Get/Set if the SampleRule is active or not</nowiki>}}
 
{{CGscriptProperties_Template|ReturnType=int|Name=<nowiki>ActualSize</nowiki>|HasGetter=1|Description=<nowiki>Get the ActualSize of Samplerule</nowiki>}}
 
{{CGscriptProperties_Template|ReturnType=int|Name=<nowiki>ActualSize</nowiki>|HasGetter=1|Description=<nowiki>Get the ActualSize of Samplerule</nowiki>}}
{{CGscriptProperties_Template|ReturnType=bool|Name=<nowiki>AllowNewNumbers</nowiki>|HasGetter=1|HasSetter=1|Description=<nowiki>Get/Set the AllowNewNumbers</nowiki>}}
+
{{CGscriptProperties_Template|ReturnType=DateTime|Name=<nowiki>DeletedDate</nowiki>|HasGetter=1|Description=<nowiki>Get/Set the DeletedDate of Samplerule</nowiki>}}
{{CGscriptProperties_Template|ReturnType=DateTime|Name=<nowiki>DeletedDate</nowiki>|HasGetter=1|HasSetter=1|Description=<nowiki>Get/Set the DeletedDate of Samplerule</nowiki>}}
 
 
{{CGscriptProperties_Template|ReturnType=string|Name=<nowiki>Description</nowiki>|HasGetter=1|HasSetter=1|Description=<nowiki>Get/Set the Description of Samplerule</nowiki>}}
 
{{CGscriptProperties_Template|ReturnType=string|Name=<nowiki>Description</nowiki>|HasGetter=1|HasSetter=1|Description=<nowiki>Get/Set the Description of Samplerule</nowiki>}}
{{CGscriptProperties_Template|ReturnType=bool|Name=<nowiki>EmailRequired</nowiki>|HasGetter=1|HasSetter=1|Description=<nowiki>Get/Set the EmailRequired</nowiki>}}
 
{{CGscriptProperties_Template|ReturnType=int|Name=<nowiki>FinalPanelExpectedTarget</nowiki>|HasGetter=1|HasSetter=1|Description=<nowiki>Get/Set the Target of FinalPanelExpectedTarget</nowiki>}}
 
 
{{CGscriptProperties_Template|ReturnType=string|Name=<nowiki>Name</nowiki>|HasGetter=1|HasSetter=1|Description=<nowiki>Get/Set the Name of Samplerule</nowiki>}}
 
{{CGscriptProperties_Template|ReturnType=string|Name=<nowiki>Name</nowiki>|HasGetter=1|HasSetter=1|Description=<nowiki>Get/Set the Name of Samplerule</nowiki>}}
 
{{CGscriptProperties_Template|ReturnType=string|Name=<nowiki>ObjectTypeName</nowiki>|HasGetter=1|Description=<nowiki>The name of the type of object.</nowiki>}}
 
{{CGscriptProperties_Template|ReturnType=string|Name=<nowiki>ObjectTypeName</nowiki>|HasGetter=1|Description=<nowiki>The name of the type of object.</nowiki>}}
{{CGscriptProperties_Template|ReturnType=number|Name=<nowiki>Percentage</nowiki>|HasGetter=1|HasSetter=1|Description=<nowiki>Get/Set the Percentage of Samplerule</nowiki>}}
 
{{CGscriptProperties_Template|ReturnType=bool|Name=<nowiki>PhoneNumberRequired</nowiki>|HasGetter=1|HasSetter=1|Description=<nowiki>Get/Set the PhoneNumberRequired</nowiki>}}
 
{{CGscriptProperties_Template|ReturnType=string|Name=<nowiki>RedirectLink</nowiki>|HasGetter=1|HasSetter=1|Description=<nowiki>Get/Set the RedirectLink of Samplerule</nowiki>}}
 
{{CGscriptProperties_Template|ReturnType=int|Name=<nowiki>RequestedSize</nowiki>|HasGetter=1|HasSetter=1|Description=<nowiki>Get/Set the RequestedSize of Samplerule</nowiki>}}
 
 
{{CGscriptProperties_Template|ReturnType=int|Name=<nowiki>SampleRuleType</nowiki>|HasGetter=1|Description=<nowiki>Get the Type of Samplerule</nowiki>}}
 
{{CGscriptProperties_Template|ReturnType=int|Name=<nowiki>SampleRuleType</nowiki>|HasGetter=1|Description=<nowiki>Get the Type of Samplerule</nowiki>}}
{{CGscriptProperties_Template|ReturnType=int|Name=<nowiki>SiteId</nowiki>|HasGetter=1|Description=<nowiki>Get the SiteId of Samplerule</nowiki>}}
 
 
{{CGscriptProperties_Template|ReturnType=int|Name=<nowiki>SizeWithData</nowiki>|HasGetter=1|Description=<nowiki>Get the SizeWithData of Samplerule</nowiki>}}
 
{{CGscriptProperties_Template|ReturnType=int|Name=<nowiki>SizeWithData</nowiki>|HasGetter=1|Description=<nowiki>Get the SizeWithData of Samplerule</nowiki>}}
 
{{CGscriptProperties_Template|ReturnType=int|Name=<nowiki>SizeWithoutData</nowiki>|HasGetter=1|Description=<nowiki>Get the SizeWithoutData of Samplerule</nowiki>}}
 
{{CGscriptProperties_Template|ReturnType=int|Name=<nowiki>SizeWithoutData</nowiki>|HasGetter=1|Description=<nowiki>Get the SizeWithoutData of Samplerule</nowiki>}}
{{CGscriptProperties_Template|ReturnType=int|Name=<nowiki>Target</nowiki>|HasGetter=1|HasSetter=1|Description=<nowiki>Get/Set the Target of Samplerule</nowiki>}}
 
 
{{CGscriptProperties_Template|ReturnType=TypeInformation|Name=<nowiki>TypeInformation</nowiki>|HasGetter=1|Description=<nowiki>Get information about this class.</nowiki>}}
 
{{CGscriptProperties_Template|ReturnType=TypeInformation|Name=<nowiki>TypeInformation</nowiki>|HasGetter=1|Description=<nowiki>Get information about this class.</nowiki>}}
 +
|StaticMethods=
 +
{{CGscriptMethods_Template|ReturnType=Array of SampleRule|Name=<nowiki>SampleRule_getByGroupResourceId</nowiki>|Parameters=
 +
{{CGscriptParameters_Template|Type=int|Name=<nowiki>groupResourceId</nowiki>|Description=<nowiki>Resource id of the group to get samples from</nowiki>}}
 +
|Description=<nowiki>Get all sample rules associacted with a group</nowiki>}}
 
}}
 
}}

Revision as of 11:09, 17 January 2019

SampleRule



Represents a SampleRule.


Methods

  • Empty Save() - Save SampleRule
  • string ToString() - The string representation of the object.

Properties

  • bool Active { get; set; } - Get/Set if the SampleRule is active or not
  • int ActualSize { get; } - Get the ActualSize of Samplerule
  • DateTime DeletedDate { get; } - Get/Set the DeletedDate of Samplerule
  • string Description { get; set; } - Get/Set the Description of Samplerule
  • string Name { get; set; } - Get/Set the Name of Samplerule
  • string ObjectTypeName { get; } - The name of the type of object.
  • int SampleRuleType { get; } - Get the Type of Samplerule
  • int SizeWithData { get; } - Get the SizeWithData of Samplerule
  • int SizeWithoutData { get; } - Get the SizeWithoutData of Samplerule
  • TypeInformation TypeInformation { get; } - Get information about this class.

Static Methods

  • Array of SampleRule SampleRule_getByGroupResourceId(int groupResourceId "Resource id of the group to get samples from") - Get all sample rules associacted with a group