Difference between revisions of "BulkSMS class"

From Catglobe Wiki
Jump to: navigation, search
(Created page with "[to do]")
 
Line 1: Line 1:
−
[to do]
+
{{CGscriptClass_Template
 +
|Name=<nowiki>BulkSMS</nowiki>
 +
|Description=<nowiki>Represents a bulkSMS.</nowiki>
 +
|InheritsFrom=object|Constructors=
 +
{{CGscriptConstructors_Template|Parameters=
 +
{{CGscriptParameters_Template|Type=int|Name=<nowiki>bulkSMSId</nowiki>|Description=<nowiki>Id of bulkSMS</nowiki>}}
 +
|Description=<nowiki>Load existing bulkSMS</nowiki>}}
 +
{{CGscriptConstructors_Template|Parameters=
 +
{{CGscriptParameters_Template|Type=string|Name=<nowiki>name</nowiki>|Description=<nowiki>Name of bulkSMS</nowiki>|Comma=,}}{{CGscriptParameters_Template|Type=int|Name=<nowiki>parentId</nowiki>|Description=<nowiki>Parent of bulkSMS</nowiki>|Comma=,}}{{CGscriptParameters_Template|Type=int|Name=<nowiki>mailTemplateId</nowiki>|Description=<nowiki>Id of mail template</nowiki>|Comma=,}}{{CGscriptParameters_Template|Type=string|Name=<nowiki>smsOutProviderName</nowiki>|Description=<nowiki>Case sensitive name of the outgoing SMS provider that should be used to send the SMS</nowiki>}}
 +
|Description=<nowiki>Create bulkSMS</nowiki>}}
 +
{{CGscriptConstructors_Template|Parameters=
 +
{{CGscriptParameters_Template|Type=string|Name=<nowiki>name</nowiki>|Description=<nowiki>Name of bulkSMS</nowiki>|Comma=,}}{{CGscriptParameters_Template|Type=int|Name=<nowiki>parentId</nowiki>|Description=<nowiki>Parent of bulkSMS</nowiki>|Comma=,}}{{CGscriptParameters_Template|Type=int|Name=<nowiki>mailTemplateId</nowiki>|Description=<nowiki>Id of mail template</nowiki>|Comma=,}}{{CGscriptParameters_Template|Type=string|Name=<nowiki>smsOutProviderName</nowiki>|Description=<nowiki>Case sensitive name of the outgoing SMS provider that should be used to send the SMS</nowiki>|Comma=,}}{{CGscriptParameters_Template|Type=int|Name=<nowiki>bulkSMSResourceTemplateId</nowiki>|Description=<nowiki>bulkSMS resource template</nowiki>}}
 +
|Description=<nowiki>Create bulkSMS</nowiki>}}
 +
|Methods=
 +
{{CGscriptMethods_Template|ReturnType=Empty|Name=<nowiki>Save</nowiki>|Description=<nowiki>Save bulkSMS</nowiki>}}
 +
{{CGscriptMethods_Template|ReturnType=int|Name=<nowiki>Send</nowiki>|Description=<nowiki>Send bulkSMS. It send maximum quantity in bulkSMS.</nowiki>}}
 +
{{CGscriptMethods_Template|ReturnType=int|Name=<nowiki>Send</nowiki>|Parameters=
 +
{{CGscriptParameters_Template|Type=int|Name=<nowiki>maxToSend</nowiki>|Description=<nowiki>It is the max sms which send</nowiki>}}
 +
|Description=<nowiki>Send bulkSMS</nowiki>}}
 +
{{CGscriptMethods_Template|ReturnType=Empty|Name=<nowiki>SetGroups</nowiki>|Parameters=
 +
{{CGscriptParameters_Template|Type=Array of ints|Name=<nowiki>groupIds</nowiki>|Description=<nowiki>Array of group id</nowiki>}}
 +
|Description=<nowiki>Set groups to bulkSMS</nowiki>}}
 +
{{CGscriptMethods_Template|ReturnType=Empty|Name=<nowiki>SetGroupsToBeRebuilt</nowiki>|Parameters=
 +
{{CGscriptParameters_Template|Type=Array of ints|Name=<nowiki>groupIds</nowiki>|Description=<nowiki>Array of group id</nowiki>}}
 +
|Description=<nowiki>Set groups to be rebuilt to bulkSMS</nowiki>}}
 +
{{CGscriptMethods_Template|ReturnType=Empty|Name=<nowiki>SetUsers</nowiki>|Parameters=
 +
{{CGscriptParameters_Template|Type=Array of ints|Name=<nowiki>userIds</nowiki>|Description=<nowiki>Array of user id</nowiki>}}
 +
|Description=<nowiki>Set users to bulkSMS</nowiki>}}
 +
{{CGscriptMethods_Template|ReturnType=string|Name=<nowiki>ToString</nowiki>|Inherited=object|Description=<nowiki>The string representation of the object.</nowiki>}}
 +
|Properties=
 +
{{CGscriptProperties_Template|ReturnType=int|Name=<nowiki>DependantBulkSMS</nowiki>|HasGetter=1|HasSetter=1|Description=<nowiki>Dependant of the bulkSMS</nowiki>}}
 +
{{CGscriptProperties_Template|ReturnType=array|Name=<nowiki>DependantSelectedHistories</nowiki>|HasGetter=1|HasSetter=1|Description=<nowiki>selected history of the dependant bulkMail, return array of BulkMailHistory object</nowiki>}}
 +
{{CGscriptProperties_Template|ReturnType=bool|Name=<nowiki>DependantSendToCompleted</nowiki>|HasGetter=1|HasSetter=1|Description=<nowiki>Dependant bulkSMS completed status</nowiki>}}
 +
{{CGscriptProperties_Template|ReturnType=bool|Name=<nowiki>DependantSendToNotStarted</nowiki>|HasGetter=1|HasSetter=1|Description=<nowiki>Dependant bulkSMS not start status</nowiki>}}
 +
{{CGscriptProperties_Template|ReturnType=bool|Name=<nowiki>DependantSendToPartly</nowiki>|HasGetter=1|HasSetter=1|Description=<nowiki>Dependant bulkSMS partly status</nowiki>}}
 +
{{CGscriptProperties_Template|ReturnType=Array of ints|Name=<nowiki>GroupIds</nowiki>|HasGetter=1|Description=<nowiki>GroupIds of the bulkMail</nowiki>}}
 +
{{CGscriptProperties_Template|ReturnType=Array of ints|Name=<nowiki>GroupRebuildIds</nowiki>|HasGetter=1|Description=<nowiki>GroupIds to be rebuild before sent bulkMail</nowiki>}}
 +
{{CGscriptProperties_Template|ReturnType=array|Name=<nowiki>History</nowiki>|HasGetter=1|Description=<nowiki>History of the bulkMail, return array of BulkMailHistory object</nowiki>}}
 +
{{CGscriptProperties_Template|ReturnType=int|Name=<nowiki>Id</nowiki>|HasGetter=1|Description=<nowiki>Id of the bulkSMS</nowiki>}}
 +
{{CGscriptProperties_Template|ReturnType=int|Name=<nowiki>MailTemplateId</nowiki>|HasGetter=1|Description=<nowiki>MailTemplateId Id of the bulkSMS</nowiki>}}
 +
{{CGscriptProperties_Template|ReturnType=string|Name=<nowiki>Name</nowiki>|HasGetter=1|HasSetter=1|Description=<nowiki>Name of the bulkSMS</nowiki>}}
 +
{{CGscriptProperties_Template|ReturnType=int|Name=<nowiki>NoInOutQueue</nowiki>|HasGetter=1|Description=<nowiki>Number of mail in queue</nowiki>}}
 +
{{CGscriptProperties_Template|ReturnType=int|Name=<nowiki>NoOfSent</nowiki>|HasGetter=1|Description=<nowiki>Number of mail sent</nowiki>}}
 +
{{CGscriptProperties_Template|ReturnType=string|Name=<nowiki>ObjectTypeName</nowiki>|HasGetter=1|Description=<nowiki>The name of the type of object.</nowiki>}}
 +
{{CGscriptProperties_Template|ReturnType=int|Name=<nowiki>ParentId</nowiki>|HasGetter=1|Description=<nowiki>Parent Id of the bulkSMS</nowiki>}}
 +
{{CGscriptProperties_Template|ReturnType=string|Name=<nowiki>SmsOutProviderName</nowiki>|HasGetter=1|Description=<nowiki>SmsOutProviderName used to send</nowiki>}}
 +
{{CGscriptProperties_Template|ReturnType=int|Name=<nowiki>TemplateId</nowiki>|HasGetter=1|Description=<nowiki>TemplateId Id of the bulkSMS</nowiki>}}
 +
{{CGscriptProperties_Template|ReturnType=TypeInformation|Name=<nowiki>TypeInformation</nowiki>|HasGetter=1|Inherited=object|Description=<nowiki>Get information about this class.</nowiki>}}
 +
{{CGscriptProperties_Template|ReturnType=Array of ints|Name=<nowiki>UserIds</nowiki>|HasGetter=1|Description=<nowiki>UserIds of the bulkMail</nowiki>}}
 +
}}

Revision as of 07:49, 4 March 2022

BulkSMS



Represents a bulkSMS.

Parent class

Inherits from object

Constructors

  • (int bulkSMSId "Id of bulkSMS") - Load existing bulkSMS
  • (string name "Name of bulkSMS", int parentId "Parent of bulkSMS", int mailTemplateId "Id of mail template", string smsOutProviderName "Case sensitive name of the outgoing SMS provider that should be used to send the SMS") - Create bulkSMS
  • (string name "Name of bulkSMS", int parentId "Parent of bulkSMS", int mailTemplateId "Id of mail template", string smsOutProviderName "Case sensitive name of the outgoing SMS provider that should be used to send the SMS", int bulkSMSResourceTemplateId "bulkSMS resource template") - Create bulkSMS

Methods

  • Empty Save() - Save bulkSMS
  • int Send() - Send bulkSMS. It send maximum quantity in bulkSMS.
  • int Send(int maxToSend "It is the max sms which send") - Send bulkSMS
  • Empty SetGroups(Array of int groupIds "Array of group id") - Set groups to bulkSMS
  • Empty SetGroupsToBeRebuilt(Array of int groupIds "Array of group id") - Set groups to be rebuilt to bulkSMS
  • Empty SetUsers(Array of int userIds "Array of user id") - Set users to bulkSMS
  • (From object) string ToString() - The string representation of the object.

Properties

  • int DependantBulkSMS { get; set; } - Dependant of the bulkSMS
  • array DependantSelectedHistories { get; set; } - selected history of the dependant bulkMail, return array of BulkMailHistory object
  • bool DependantSendToCompleted { get; set; } - Dependant bulkSMS completed status
  • bool DependantSendToNotStarted { get; set; } - Dependant bulkSMS not start status
  • bool DependantSendToPartly { get; set; } - Dependant bulkSMS partly status
  • Array of int GroupIds { get; } - GroupIds of the bulkMail
  • Array of int GroupRebuildIds { get; } - GroupIds to be rebuild before sent bulkMail
  • array History { get; } - History of the bulkMail, return array of BulkMailHistory object
  • int Id { get; } - Id of the bulkSMS
  • int MailTemplateId { get; } - MailTemplateId Id of the bulkSMS
  • string Name { get; set; } - Name of the bulkSMS
  • int NoInOutQueue { get; } - Number of mail in queue
  • int NoOfSent { get; } - Number of mail sent
  • string ObjectTypeName { get; } - The name of the type of object.
  • int ParentId { get; } - Parent Id of the bulkSMS
  • string SmsOutProviderName { get; } - SmsOutProviderName used to send
  • int TemplateId { get; } - TemplateId Id of the bulkSMS
  • (From object) TypeInformation TypeInformation { get; } - Get information about this class.
  • Array of int UserIds { get; } - UserIds of the bulkMail
Retrieved from "http://wiki.catglobe.com/index.php?title=BulkSMS_class&oldid=240256"