Difference between revisions of "Quarantine class"

From Catglobe Wiki
Jump to: navigation, search
(Created page with "{{CGscriptClass_Template |Name=Quarantine |Description=A quarantine prohibiting bulkmails and bulksms from being sent to user. |Constructors= {{CGscriptConstructors_Template|P...")
 
Line 19: Line 19:
 
{{CGscriptProperties_Template|ReturnType=TypeInformation|Name=TypeInformation|HasGetter=1|Description=Get information about this class.}}
 
{{CGscriptProperties_Template|ReturnType=TypeInformation|Name=TypeInformation|HasGetter=1|Description=Get information about this class.}}
 
}}
 
}}
 +
 +
=== Examples ===
 +
 +
<source lang="javascript">
 +
//Get data from a quarantine exist in quarantine resource list
 +
Quarantine Q = new Quarantine(15525401);
 +
print(Q.Duration);
 +
print(Q.Name);
 +
print(Q.ObjectTypeName);
 +
print(Q.ResourceId);
 +
</source>

Revision as of 10:00, 20 May 2016

Quarantine



A quarantine prohibiting bulkmails and bulksms from being sent to user.

Constructors

  • (number ResourceId "Resource Id of the Quarantine") - Instanciate an existing instance using the resource id of a Quarantine
  • (string name "Resource name", number parentResourceId "Parent resource.") - Instanciate a new instance

Methods

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

Properties

  • number Duration { get; set; } - Number of seconds the quarantine is enforced in seconds
  • string Name { get; set; } - Name of the Quarantine resource
  • string ObjectTypeName { get; } - The name of the type of object.
  • number ResourceId { get; } - The Id of the Quarantine
  • TypeInformation TypeInformation { get; } - Get information about this class.


Examples

//Get data from a quarantine exist in quarantine resource list
Quarantine Q = new Quarantine(15525401);
print(Q.Duration);
print(Q.Name);
print(Q.ObjectTypeName);
print(Q.ResourceId);