Difference between revisions of "SampleRule class"

From Catglobe Wiki
Jump to: navigation, search
Line 21: Line 21:
 
|Description=<nowiki>Get all sample rules associacted with a group</nowiki>}}
 
|Description=<nowiki>Get all sample rules associacted with a group</nowiki>}}
 
}}
 
}}
 +
=== <span style="color:#DF8621">'''Examples'''</span> ===
 +
<source lang="javascript">
 +
number groupRId = 15644390;
 +
array sampleRule = SampleRule_getByGroupResourceId(groupRId);
 +
for(number i = 0; i<sampleRule.Count; i++)
 +
{
 +
print(sampleRule[i].Active);
 +
print(sampleRule[i].ActualSize);
 +
print(sampleRule[i].DeletedDate);
 +
print(sampleRule[i].Description);
 +
print(sampleRule[i].SampleRuleType );
 +
print(sampleRule[i].SizeWithData );
 +
print(sampleRule[i].SizeWithoutData );
 +
}
 +
</source>

Revision as of 11:28, 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

Examples

number groupRId = 15644390;
array sampleRule = SampleRule_getByGroupResourceId(groupRId);
for(number i = 0; i<sampleRule.Count; i++)
{
	print(sampleRule[i].Active);
	print(sampleRule[i].ActualSize);
	print(sampleRule[i].DeletedDate);
	print(sampleRule[i].Description);
	print(sampleRule[i].SampleRuleType );
	print(sampleRule[i].SizeWithData );
	print(sampleRule[i].SizeWithoutData );
}