Difference between revisions of "EmailTemplate class"

From Catglobe Wiki
Jump to: navigation, search
Line 1: Line 1:
{{CGscriptClass_Template |Name=Dictionary |Description=The dictionary object |Constructors= {{CGscriptConstructors_Template|Description=Create a new dictionary with non-argument.}} {{CGscriptConstructors_Template|Parameters={{CGscriptParameters_Template|Type=params AnyType|Name=params AnyType|Description=}} |Description=Create new dictionary with the specified key-value pairs.}} {{CGscriptConstructors_Template|Parameters= {{CGscriptParameters_Template|Type=array|Name=keys|Description=keys arrayConstant|Comma=,}}{{CGscriptParameters_Template|Type=array|Name=values|Description=values arrayConstant}} |Description=Create new dictionary with the specified keys and values.}} |Methods= {{CGscriptMethods_Template|ReturnType=bool|Name=Add|Parameters= {{CGscriptParameters_Template|Type=string|Name=key|Description=Add with specific key|Comma=,}}{{CGscriptParameters_Template|Type=object|Name=value|Description=Add with specific value}} |Description=Adds the specified key and value to the dictionary.}} {{CGscriptMethods_Template|ReturnType=bool|Name=Add|Parameters= {{CGscriptParameters_Template|Type=int|Name=key|Description=Add with specific key|Comma=,}}{{CGscriptParameters_Template|Type=object|Name=value|Description=Add with specific value}} |Description=Adds the specified key and value to the dictionary.}} {{CGscriptMethods_Template|ReturnType=Empty|Name=Add|Parameters= {{CGscriptParameters_Template|Type=Dictionary|Name=src|Description=Source of keys and values to add}} |Description=Adds the all keys and values from src to current.}} {{CGscriptMethods_Template|ReturnType=Empty|Name=Clear|Description=Remove all keys and values from the dictionary.}} {{CGscriptMethods_Template|ReturnType=bool|Name=ContainsKey|Parameters= {{CGscriptParameters_Template|Type=string|Name=key|Description=Check with specific key}} |Description=Determines whether the dictionary contains the specified key.}} {{CGscriptMethods_Template|ReturnType=bool|Name=ContainsKey|Parameters= {{CGscriptParameters_Template|Type=int|Name=key|Description=Check with specific key}} |Description=Determines whether the dictionary contains the specified key.}} {{CGscriptMethods_Template|ReturnType=bool|Name=ContainsValue|Parameters= {{CGscriptParameters_Template|Type=object|Name=value|Description=Add with specific value}} |Description=Determines whether the dictionary contains the specified value.}} {{CGscriptMethods_Template|ReturnType=object|Name=this[] { get; }|Parameters= {{CGscriptParameters_Template|Type=string|Name=key|Description=The key used to lookup the value.}} |Description=Get an item based on a key.}} {{CGscriptMethods_Template|ReturnType=object|Name=this[] { get; }|Parameters= {{CGscriptParameters_Template|Type=int|Name=key|Description=The key used to lookup the value.}} |Description=Get an item based on a key.}} {{CGscriptMethods_Template|ReturnType=object|Name=Remove|Parameters= {{CGscriptParameters_Template|Type=string|Name=key|Description=Check with specific key}} |Description=Remove the value with the specified key from the dictionary.}} {{CGscriptMethods_Template|ReturnType=object|Name=Remove|Parameters= {{CGscriptParameters_Template|Type=int|Name=key|Description=Remove with specific key}} |Description=Remove the value with the specified key from the dictionary.}} {{CGscriptMethods_Template|ReturnType=Empty|Name=this[] { set; }|Parameters= {{CGscriptParameters_Template|Type=string|Name=key|Description=The key used to lookup the value.|Comma=,}}{{CGscriptParameters_Template|Type=object|Name=value|Description=The value to set.}} |Description=Set an item based on a key and a value.}} {{CGscriptMethods_Template|ReturnType=Empty|Name=this[] { set; }|Parameters= {{CGscriptParameters_Template|Type=int|Name=key|Description=The key used to lookup the value.|Comma=,}}{{CGscriptParameters_Template|Type=object|Name=value|Description=The value to set.}} |Description=Set an item based on a key and a value.}} {{CGscriptMethods_Template|ReturnType=string|Name=ToString|Description=The string representation of the object.}} {{CGscriptMethods_Template|ReturnType=object|Name=TryGetValue|Parameters= {{CGscriptParameters_Template|Type=string|Name=key|Description=Remove with specific key}} |Description=Gets the value associated with the specified key.}} {{CGscriptMethods_Template|ReturnType=object|Name=TryGetValue|Parameters= {{CGscriptParameters_Template|Type=int|Name=key|Description=Remove with specific key}} |Description=Gets the value associated with the specified key.}} |Properties= {{CGscriptProperties_Template|ReturnType=int|Name=Count|HasGetter=1|Description=Gets the number of key/value pairs contained in the dictionary.}} {{CGscriptProperties_Template|ReturnType=array|Name=Keys|HasGetter=1|Description=Gets a list of keys.}} {{CGscriptProperties_Template|ReturnType=string|Name=ObjectTypeName|HasGetter=1|Description=The name of the type of object.}} {{CGscriptProperties_Template|ReturnType=array|Name=SortedKeys|HasGetter=1|Description=Gets a list of keys sorted by current collation.}} {{CGscriptProperties_Template|ReturnType=TypeInformation|Name=TypeInformation|HasGetter=1|Description=Get information about this class.}} {{CGscriptProperties_Template|ReturnType=array|Name=Values|HasGetter=1|Description=Gets a list of values.}} }}
+
{{CGscriptClass_Template
 +
|Name=EmailTemplate
 +
|Description=Represents an email account.
 +
|Constructors=
 +
{{CGscriptConstructors_Template|Parameters=
 +
{{CGscriptParameters_Template|Type=int|Name=resourceId|Description=The resource id of existing template}}
 +
|Description=Instanciate an existing template}}
 +
{{CGscriptConstructors_Template|Parameters=
 +
{{CGscriptParameters_Template|Type=string|Name=parentResourceId|Description=The resource id of existing template|Comma=,}}{{CGscriptParameters_Template|Type=int|Name=parentResourceId|Description=The resource id of existing template}}
 +
|Description=Create a new template}}
 +
|Methods=
 +
{{CGscriptMethods_Template|ReturnType=array|Name=GetAllFromParent|Parameters=
 +
{{CGscriptParameters_Template|Type=int|Name=parentResourceId|Description=The resource id of existing template}}
 +
|Description=Find all mail template that are children on the given resource}}
 +
{{CGscriptMethods_Template|ReturnType=Empty|Name=Save|Description=Save the Email template}}
 +
{{CGscriptMethods_Template|ReturnType=string|Name=ToString|Description=The string representation of the object.}}
 +
|Properties=
 +
{{CGscriptProperties_Template|ReturnType=DateTime|Name=CreatedDate|HasGetter=1|Description=Get the time of creation.}}
 +
{{CGscriptProperties_Template|ReturnType=string|Name=MessageDefaultLanguage|HasGetter=1|HasSetter=1|Description=Get/Set the default language mail body.}}
 +
{{CGscriptProperties_Template|ReturnType=DateTime|Name=ModifiedDate|HasGetter=1|Description=Get the time of last modification.}}
 +
{{CGscriptProperties_Template|ReturnType=string|Name=ObjectTypeName|HasGetter=1|Description=The name of the type of object.}}
 +
{{CGscriptProperties_Template|ReturnType=int|Name=ParentResourceId|HasGetter=1|HasSetter=1|Description=Get the resource id.}}
 +
{{CGscriptProperties_Template|ReturnType=int|Name=ResourceId|HasGetter=1|Description=Get the resource id.}}
 +
{{CGscriptProperties_Template|ReturnType=string|Name=ResourceName|HasGetter=1|HasSetter=1|Description=Get the resource name.}}
 +
{{CGscriptProperties_Template|ReturnType=string|Name=SubjectDefaultLanguage|HasGetter=1|HasSetter=1|Description=Get/Set the default language subject.}}
 +
{{CGscriptProperties_Template|ReturnType=TypeInformation|Name=TypeInformation|HasGetter=1|Description=Get information about this class.}}
 +
}}

Revision as of 09:33, 29 August 2016

EmailTemplate



Represents an email account.

Constructors

  • (int resourceId "The resource id of existing template") - Instanciate an existing template
  • (string parentResourceId "The resource id of existing template", int parentResourceId "The resource id of existing template") - Create a new template

Methods

  • array GetAllFromParent(int parentResourceId "The resource id of existing template") - Find all mail template that are children on the given resource
  • Empty Save() - Save the Email template
  • string ToString() - The string representation of the object.

Properties

  • DateTime CreatedDate { get; } - Get the time of creation.
  • string MessageDefaultLanguage { get; set; } - Get/Set the default language mail body.
  • DateTime ModifiedDate { get; } - Get the time of last modification.
  • string ObjectTypeName { get; } - The name of the type of object.
  • int ParentResourceId { get; set; } - Get the resource id.
  • int ResourceId { get; } - Get the resource id.
  • string ResourceName { get; set; } - Get the resource name.
  • string SubjectDefaultLanguage { get; set; } - Get/Set the default language subject.
  • TypeInformation TypeInformation { get; } - Get information about this class.