Toggle menu
876
3.8K
30.2K
279.1K
Catglobe Wiki
Toggle preferences menu
Toggle personal menu
Not logged in
Your IP address will be publicly visible if you make any edits.

Quarantine class: Difference between revisions

From Catglobe Wiki
No edit summary
No edit summary
 
(7 intermediate revisions by 2 users not shown)
Line 1: Line 1:
{{CGscriptClass_Template
{{CGscriptClass_Template
|Name=Quarantine
|Name=<nowiki>Quarantine</nowiki>
|Description=A quarantine prohibiting bulkmails and bulksms from being sent to user.
|Description=<nowiki>A quarantine prohibiting bulkmails and bulksms from being sent to user.</nowiki>
|Constructors=
|InheritsFrom=object|Constructors=
{{CGscriptConstructors_Template|Parameters=
{{CGscriptConstructors_Template|Parameters=
{{CGscriptParameters_Template|Type=number|Name=ResourceId|Description=Resource Id of the Quarantine}}
{{CGscriptParameters_Template|Type=int|Name=<nowiki>ResourceId</nowiki>|Description=<nowiki>Resource Id of the Quarantine</nowiki>}}
|Description=Instanciate an existing instance using the resource id of a Quarantine}}
|Description=<nowiki>Instanciate an existing instance using the resource id of a Quarantine</nowiki>}}
{{CGscriptConstructors_Template|Parameters=
{{CGscriptConstructors_Template|Parameters=
{{CGscriptParameters_Template|Type=string|Name=name|Description=Resource name|Comma=,}}{{CGscriptParameters_Template|Type=number|Name=parentResourceId|Description=Parent resource.}}
{{CGscriptParameters_Template|Type=string|Name=<nowiki>name</nowiki>|Description=<nowiki>Resource name</nowiki>|Comma=,}}{{CGscriptParameters_Template|Type=int|Name=<nowiki>parentResourceId</nowiki>|Description=<nowiki>Parent resource.</nowiki>}}
|Description=Instanciate a new instance}}
|Description=<nowiki>Instanciate a new instance</nowiki>}}
|Methods=
|Methods=
{{CGscriptMethods_Template|ReturnType=Empty|Name=Save|Description=Save the ResourceTemplate resource}}
{{CGscriptMethods_Template|ReturnType=Empty|Name=<nowiki>Save</nowiki>|Description=<nowiki>Save the ResourceTemplate resource</nowiki>}}
{{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=number|Name=Duration|HasGetter=1|HasSetter=1|Description=Number of seconds the quarantine is enforced in seconds}}
{{CGscriptProperties_Template|ReturnType=int|Name=<nowiki>Duration</nowiki>|HasGetter=1|HasSetter=1|Description=<nowiki>Number of seconds the quarantine is enforced in seconds</nowiki>}}
{{CGscriptProperties_Template|ReturnType=string|Name=Name|HasGetter=1|HasSetter=1|Description=Name of the Quarantine resource}}
{{CGscriptProperties_Template|ReturnType=string|Name=<nowiki>Name</nowiki>|HasGetter=1|HasSetter=1|Description=<nowiki>Name of the Quarantine resource</nowiki>}}
{{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=number|Name=ResourceId|HasGetter=1|Description=The Id of the Quarantine}}
{{CGscriptProperties_Template|ReturnType=int|Name=<nowiki>ResourceId</nowiki>|HasGetter=1|Description=<nowiki>The Id of the Quarantine</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>}}
}}
}}


Line 25: Line 25:
//Get data from a quarantine exist in quarantine resource list
//Get data from a quarantine exist in quarantine resource list
Quarantine Q = new Quarantine(15525566);
Quarantine Q = new Quarantine(15525566);
print(Q.Duration);" "//2400
print(Q.Duration); //2400
print(Q.Name);" "//NewQuarantine3
print(Q.Name); //NewQuarantine3
print(Q.ObjectTypeName);" "//Quarantine
print(Q.ObjectTypeName); //Quarantine
print(Q.ResourceId);" "//15525566
print(Q.ResourceId); //15525566


//Edit data from a quarantine exist in quarantine resource list
//Edit data from a quarantine exist in quarantine resource list
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>

Latest revision as of 05:14, 2 July 2020

Quarantine



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

Parent class

Inherits from object

Constructors

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

Methods

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

Properties

  • int 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.
  • int ResourceId { get; } - The Id of the Quarantine
  • (From object) 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();