Difference between revisions of "Quarantine class"

From Catglobe Wiki
Jump to: navigation, search
Line 37: Line 37:
  
 
//Create a new quarantine
 
//Create a new quarantine
=//Ex 1:=
+
//Ex 1:
Quarantine Q = new Quarantine("LastName1",15502953);
+
  Quarantine Q = new Quarantine("LastName1",15502953);
Q.Duration=200;
+
  Q.Duration=200;
Q.Save();
+
  Q.Save();
=/Ex 2:=
+
//Ex 2:
Quarantine Q = new Quarantine("",15502953);
+
  Quarantine Q = new Quarantine("",15502953);
Q.Duration=300;
+
  Q.Duration=300;
Q.Name = "LastName2";
+
  Q.Name = "LastName2";
Q.Save();
+
  Q.Save();
=/Ex 3:=
+
//Ex 3:
Quarantine Q = new Quarantine("FirstName3",15502953);
+
  Quarantine Q = new Quarantine("FirstName3",15502953);
Q.Duration=500;
+
  Q.Duration=500;
Q.Name = "LastName3";
+
  Q.Name = "LastName3";
Q.Save();
+
  Q.Save();
 
</source>
 
</source>

Revision as of 11:28, 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(15525566);
print(Q.Duration); //2400
print(Q.Name); //NewQuarantine3
print(Q.ObjectTypeName); //Quarantine
print(Q.ResourceId); //15525566

//Edit data from a quarantine exist in quarantine resource list
Quarantine Q = new Quarantine(15525401);
Q.Duration=1000;
Q.Name="NewName";
Q.Save();

//Create a new quarantine
//Ex 1:
  Quarantine Q = new Quarantine("LastName1",15502953);
  Q.Duration=200;
  Q.Save();
//Ex 2:
  Quarantine Q = new Quarantine("",15502953);
  Q.Duration=300;
  Q.Name = "LastName2";
  Q.Save();
//Ex 3:
  Quarantine Q = new Quarantine("FirstName3",15502953);
  Q.Duration=500;
  Q.Name = "LastName3";
  Q.Save();