Difference between revisions of "BulkmailResourceTemplate class"

From Catglobe Wiki
Jump to: navigation, search
 
Line 2: Line 2:
 
|Name=<nowiki>BulkmailResourceTemplate</nowiki>
 
|Name=<nowiki>BulkmailResourceTemplate</nowiki>
 
|Description=<nowiki>A bulkmail resource template.</nowiki>
 
|Description=<nowiki>A bulkmail resource template.</nowiki>
−
|Constructors=
+
|InheritsFrom=ResourceTemplate|Constructors=
 
{{CGscriptConstructors_Template|Parameters=
 
{{CGscriptConstructors_Template|Parameters=
 
{{CGscriptParameters_Template|Type=string|Name=<nowiki>name</nowiki>|Description=<nowiki>Resource name</nowiki>}}
 
{{CGscriptParameters_Template|Type=string|Name=<nowiki>name</nowiki>|Description=<nowiki>Resource name</nowiki>}}
Line 13: Line 13:
 
{{CGscriptParameters_Template|Type=int|Name=<nowiki>quarantineResourceId</nowiki>|Description=<nowiki>Resource Id of the quarantine</nowiki>}}
 
{{CGscriptParameters_Template|Type=int|Name=<nowiki>quarantineResourceId</nowiki>|Description=<nowiki>Resource Id of the quarantine</nowiki>}}
 
|Description=<nowiki>Prevent user from getting email/SMS if in this quarantine at the time of sending</nowiki>}}
 
|Description=<nowiki>Prevent user from getting email/SMS if in this quarantine at the time of sending</nowiki>}}
−
{{CGscriptMethods_Template|ReturnType=Empty|Name=<nowiki>DefaultLanguage</nowiki>|Parameters=
+
{{CGscriptMethods_Template|ReturnType=Empty|Name=<nowiki>DefaultLanguage</nowiki>|Inherited=ResourceTemplate|Parameters=
 
{{CGscriptParameters_Template|Type=string|Name=<nowiki>isocode</nowiki>|Description=<nowiki>Iso code to set as default</nowiki>}}
 
{{CGscriptParameters_Template|Type=string|Name=<nowiki>isocode</nowiki>|Description=<nowiki>Iso code to set as default</nowiki>}}
 
|Description=<nowiki>Which Localized Name is the default</nowiki>}}
 
|Description=<nowiki>Which Localized Name is the default</nowiki>}}
 
{{CGscriptMethods_Template|ReturnType=Array of objects|Name=<nowiki>GetQuarantineToAddUserToAfterSend</nowiki>|Description=<nowiki>List of quarantines to add to upon receiving email</nowiki>}}
 
{{CGscriptMethods_Template|ReturnType=Array of objects|Name=<nowiki>GetQuarantineToAddUserToAfterSend</nowiki>|Description=<nowiki>List of quarantines to add to upon receiving email</nowiki>}}
 
{{CGscriptMethods_Template|ReturnType=Array of objects|Name=<nowiki>GetQuarantineToAddUserToCheckBeforeSend</nowiki>|Description=<nowiki>List of quarantines to check before sending</nowiki>}}
 
{{CGscriptMethods_Template|ReturnType=Array of objects|Name=<nowiki>GetQuarantineToAddUserToCheckBeforeSend</nowiki>|Description=<nowiki>List of quarantines to check before sending</nowiki>}}
−
{{CGscriptMethods_Template|ReturnType=Empty|Name=<nowiki>Save</nowiki>|Description=<nowiki>Save the ResourceTemplate resource</nowiki>}}
+
{{CGscriptMethods_Template|ReturnType=Empty|Name=<nowiki>Save</nowiki>|Inherited=ResourceTemplate|Description=<nowiki>Save the ResourceTemplate resource</nowiki>}}
−
{{CGscriptMethods_Template|ReturnType=Empty|Name=<nowiki>SaveProperties</nowiki>|Description=<nowiki>Save the properties of the ResourceTemplate resource. Ignores changes to all constant options in use</nowiki>}}
+
{{CGscriptMethods_Template|ReturnType=Empty|Name=<nowiki>SaveProperties</nowiki>|Inherited=ResourceTemplate|Description=<nowiki>Save the properties of the ResourceTemplate resource. Ignores changes to all constant options in use</nowiki>}}
−
{{CGscriptMethods_Template|ReturnType=string|Name=<nowiki>ToString</nowiki>|Description=<nowiki>The string representation of the object.</nowiki>}}
+
{{CGscriptMethods_Template|ReturnType=string|Name=<nowiki>ToString</nowiki>|Inherited=object|Description=<nowiki>The string representation of the object.</nowiki>}}
 
|Properties=
 
|Properties=
 
{{CGscriptProperties_Template|ReturnType=bool|Name=<nowiki>DependantSendToCompleted</nowiki>|HasGetter=1|HasSetter=1|Description=<nowiki>Is the default that respondents that have completed their QAS gets message</nowiki>}}
 
{{CGscriptProperties_Template|ReturnType=bool|Name=<nowiki>DependantSendToCompleted</nowiki>|HasGetter=1|HasSetter=1|Description=<nowiki>Is the default that respondents that have completed their QAS gets message</nowiki>}}
Line 26: Line 26:
 
{{CGscriptProperties_Template|ReturnType=bool|Name=<nowiki>DependantSendToPartly</nowiki>|HasGetter=1|HasSetter=1|Description=<nowiki>Is the default that respondents that have partly completed their QAS gets message</nowiki>}}
 
{{CGscriptProperties_Template|ReturnType=bool|Name=<nowiki>DependantSendToPartly</nowiki>|HasGetter=1|HasSetter=1|Description=<nowiki>Is the default that respondents that have partly completed their QAS gets message</nowiki>}}
 
{{CGscriptProperties_Template|ReturnType=bool|Name=<nowiki>IsBulkDependant</nowiki>|HasGetter=1|HasSetter=1|Description=<nowiki>Does the recipients of the bulkmail/SMS depend on previous sendings on another bulkmail/SMS</nowiki>}}
 
{{CGscriptProperties_Template|ReturnType=bool|Name=<nowiki>IsBulkDependant</nowiki>|HasGetter=1|HasSetter=1|Description=<nowiki>Does the recipients of the bulkmail/SMS depend on previous sendings on another bulkmail/SMS</nowiki>}}
−
{{CGscriptProperties_Template|ReturnType=string|Name=<nowiki>LocalizedName</nowiki>|HasGetter=1|Description=<nowiki>Localized Name for current user of the ResourceTemplate resource</nowiki>}}
+
{{CGscriptProperties_Template|ReturnType=string|Name=<nowiki>LocalizedName</nowiki>|HasGetter=1|Inherited=ResourceTemplate|Description=<nowiki>Localized Name for current user of the ResourceTemplate resource</nowiki>}}
−
{{CGscriptProperties_Template|ReturnType=Dictionary|Name=<nowiki>LocalizedNames</nowiki>|HasGetter=1|HasSetter=1|Description=<nowiki>Localized Name of the ResourceTemplate resource</nowiki>}}
+
{{CGscriptProperties_Template|ReturnType=Dictionary|Name=<nowiki>LocalizedNames</nowiki>|HasGetter=1|HasSetter=1|Inherited=ResourceTemplate|Description=<nowiki>Localized Name of the ResourceTemplate resource</nowiki>}}
 
{{CGscriptProperties_Template|ReturnType=string|Name=<nowiki>ObjectTypeName</nowiki>|HasGetter=1|Description=<nowiki>The name of the type of object.</nowiki>}}
 
{{CGscriptProperties_Template|ReturnType=string|Name=<nowiki>ObjectTypeName</nowiki>|HasGetter=1|Description=<nowiki>The name of the type of object.</nowiki>}}
−
{{CGscriptProperties_Template|ReturnType=array|Name=<nowiki>Properties</nowiki>|HasGetter=1|Description=<nowiki>Get the list of current properties. Use AddProperty/RemoveProperty to edit order</nowiki>}}
+
{{CGscriptProperties_Template|ReturnType=array|Name=<nowiki>Properties</nowiki>|HasGetter=1|Inherited=ResourceTemplate|Description=<nowiki>Get the list of current properties. Use AddProperty/RemoveProperty to edit order</nowiki>}}
−
{{CGscriptProperties_Template|ReturnType=int|Name=<nowiki>ResourceId</nowiki>|HasGetter=1|Description=<nowiki>The Id of the ResourceTemplate</nowiki>}}
+
{{CGscriptProperties_Template|ReturnType=int|Name=<nowiki>ResourceId</nowiki>|HasGetter=1|Inherited=ResourceTemplate|Description=<nowiki>The Id of the ResourceTemplate</nowiki>}}
−
{{CGscriptProperties_Template|ReturnType=string|Name=<nowiki>ResourceName</nowiki>|HasGetter=1|Description=<nowiki>Name of the ResourceTemplate resource</nowiki>}}
+
{{CGscriptProperties_Template|ReturnType=string|Name=<nowiki>ResourceName</nowiki>|HasGetter=1|Inherited=ResourceTemplate|Description=<nowiki>Name of the ResourceTemplate resource</nowiki>}}
−
{{CGscriptProperties_Template|ReturnType=int|Name=<nowiki>ResourceTemplateType</nowiki>|HasGetter=1|Description=<nowiki>The type of resource that this ResourceTemplate covers</nowiki>}}
+
{{CGscriptProperties_Template|ReturnType=int|Name=<nowiki>ResourceTemplateType</nowiki>|HasGetter=1|Inherited=ResourceTemplate|Description=<nowiki>The type of resource that this ResourceTemplate covers</nowiki>}}
−
{{CGscriptProperties_Template|ReturnType=bool|Name=<nowiki>ResourceTimeregEnabled</nowiki>|HasGetter=1|HasSetter=1|Description=<nowiki>Get/set ResourceTimeregEnabled</nowiki>}}
+
{{CGscriptProperties_Template|ReturnType=bool|Name=<nowiki>ResourceTimeregEnabled</nowiki>|HasGetter=1|HasSetter=1|Inherited=ResourceTemplate|Description=<nowiki>Get/set ResourceTimeregEnabled</nowiki>}}
−
{{CGscriptProperties_Template|ReturnType=TypeInformation|Name=<nowiki>TypeInformation</nowiki>|HasGetter=1|Description=<nowiki>Get information about this class.</nowiki>}}
+
{{CGscriptProperties_Template|ReturnType=TypeInformation|Name=<nowiki>TypeInformation</nowiki>|HasGetter=1|Inherited=object|Description=<nowiki>Get information about this class.</nowiki>}}
 
}}
 
}}
 +
 
=== <span style="color:#DF8621">'''Examples'''</span> ===
 
=== <span style="color:#DF8621">'''Examples'''</span> ===
 
<source lang="javascript">
 
<source lang="javascript">

Latest revision as of 07:39, 2 July 2020

BulkmailResourceTemplate


A bulkmail resource template.

Parent class

Inherits from ResourceTemplate

Constructors

  • (string name "Resource name") - Create a new bulkmail resource template

Methods

  • Empty AddQuarantineToAddUserToAfterSend(int quarantineResourceId "Resource Id of the quarantine") - Add to this quarantine upon receiving email
  • Empty AddQuarantineToCheckBeforeSend(int quarantineResourceId "Resource Id of the quarantine") - Prevent user from getting email/SMS if in this quarantine at the time of sending
  • (From ResourceTemplate) Empty DefaultLanguage(string isocode "Iso code to set as default") - Which Localized Name is the default
  • Array of objects GetQuarantineToAddUserToAfterSend() - List of quarantines to add to upon receiving email
  • Array of objects GetQuarantineToAddUserToCheckBeforeSend() - List of quarantines to check before sending
  • (From ResourceTemplate) Empty Save() - Save the ResourceTemplate resource
  • (From ResourceTemplate) Empty SaveProperties() - Save the properties of the ResourceTemplate resource. Ignores changes to all constant options in use
  • (From object) string ToString() - The string representation of the object.

Properties

  • bool DependantSendToCompleted { get; set; } - Is the default that respondents that have completed their QAS gets message
  • bool DependantSendToNotStarted { get; set; } - Is the default that respondents that have not yet started their QAS gets message
  • bool DependantSendToPartly { get; set; } - Is the default that respondents that have partly completed their QAS gets message
  • bool IsBulkDependant { get; set; } - Does the recipients of the bulkmail/SMS depend on previous sendings on another bulkmail/SMS
  • (From ResourceTemplate) string LocalizedName { get; } - Localized Name for current user of the ResourceTemplate resource
  • (From ResourceTemplate) Dictionary LocalizedNames { get; set; } - Localized Name of the ResourceTemplate resource
  • string ObjectTypeName { get; } - The name of the type of object.
  • (From ResourceTemplate) array Properties { get; } - Get the list of current properties. Use AddProperty/RemoveProperty to edit order
  • (From ResourceTemplate) int ResourceId { get; } - The Id of the ResourceTemplate
  • (From ResourceTemplate) string ResourceName { get; } - Name of the ResourceTemplate resource
  • (From ResourceTemplate) int ResourceTemplateType { get; } - The type of resource that this ResourceTemplate covers
  • (From ResourceTemplate) bool ResourceTimeregEnabled { get; set; } - Get/set ResourceTimeregEnabled
  • (From object) TypeInformation TypeInformation { get; } - Get information about this class.


Examples

BulkmailResourceTemplate templates=new BulkmailResourceTemplate("Bulkmail templates 2");

templates.IsBulkDependant =true;

templates.DependantSendToPartly = true;

templates.DependantSendToCompleted = true;

templates.DependantSendToNotStarted = true;

templates.LocalizedNames = {"da-DK": "Bulkmail templates 2"};

templates.DefaultLanguage("da-DK");

templates.Save();

print(templates.ResourceId);

print(templates.ResourceName);

print(templates.LocalizedNames);
Retrieved from "http://wiki.catglobe.com/index.php?title=BulkmailResourceTemplate_class&oldid=239656"