Click or drag to resize
ZenophSMS Class
Class for creating and sending personalised and non-personalised SMS.
Inheritance Hierarchy
SystemObject
  Zenoph.SMSLibZenophSMS

Namespace: Zenoph.SMSLib
Assembly: Zenoph.SMSLib (in Zenoph.SMSLib.dll) Version: 2015.9.30.0 (2015.09.30.0)
Syntax
public class ZenophSMS

The ZenophSMS type exposes the following members.

Constructors
  NameDescription
Public methodZenophSMS
The constructor that initialises object for sending either personalised or non-personalised SMS.
Top
Methods
  NameDescription
Public methodCode exampleaddRecipient(String)
Adds a phone number to the destinations list. If the phone number already exists, it will be ignored.
Public methodCode exampleaddRecipient(String, Boolean)
Adds a phone number to the destinations list. If the phone number already exists, it will be ignored.
Public methodCode exampleaddRecipient(String, String)
Adds a phone number and its personalised values to the destinations list. If the phone number already exists, the values specified for this method call will replace the already existing values.
Public methodCode exampleaddRecipient(String, String, Boolean)
Adds a phone number and its personalised values to the destinations list. If the phone number already exists, the values specified for this method call will replace the already existing values.
Public methodaddRecipients
Adds a list of phone numbers to the destinations list.
Public methodauthenticate
Authenticates a user for messaging.
Public methodauthenticated
Tells whether user has been authenticated for messaging or not.
Public methodchangePassword
Requests the change of account password.
Public methodclearRecipients
Clears the list that contains phone numbers for destinations.
Public methoddeleteRecipient
Deletes a phone number from the destinations list.
Public methodEquals
Determines whether the specified Object is equal to the current Object.
(Inherited from Object.)
Public methodCode exampleextractPhoneNumbers(String)
Searches and extracts phone numbers from specified System.String input source.
Public methodCode exampleextractPhoneNumbers(String, ListString)
Searches and extracts phone numbers from specified System.String input source.
Protected methodFinalize
Allows an Object to attempt to free resources and perform other cleanup operations before the Object is reclaimed by garbage collection.
(Inherited from Object.)
Public methodStatic memberCode examplegetBatchSubmitMax
Gets the maximum number of destinations that can be submitted to the SMS server at once which will immediately return the submit status for the destinations.
Public methodgetCreditsBalance
Gets the credits balance for the user account.
Public methodgetDefaultDialCode
Gets the default international dial code that is prepended to phone numbers without international dial code.
Public methodgetDefaultTimeZone
Gets the default time zone as set in user account.
Public methodGetHashCode
Serves as a hash function for a particular type.
(Inherited from Object.)
Public methodStatic membergetHostUrl
Gets the Web URL of the SMS server website.
Public methodgetMessage
Gets the message that will be sent to the destinations.
Public methodCode examplegetMessagePreview
Gets a preview of the message that will be sent to a destination.
Public methodgetMessageType
Gets the type of message that will be sent.
Public methodStatic membergetMessageTypes
Gets the string representations of all the MSGTYPE enumerations.
Public methodgetRecipients
Gets the list of phone numbers added to the destinations list.
Public methodgetRecipientsCount
Gets the total number of phone numbers that have been added to the destinations list.
Public methodgetSenderId
Gets the identifier that will be shown to recipients as the sender of the message.
Public methodgetSMSCount
Gets the count of SMS for a single destination based on type and length of the composed message.
Public methodStatic membergetSMSCount(String, String)
Gets the count of SMS for a single destination based on type and length of the composed message.
Public methodStatic membergetSMSCount(String, MSGTYPE)
Gets the count of SMS for a single destination based on type and length of the composed message.
Public methodgetSubmitStatus(String, STATUSQUERY)
Gets the status of submitted destinations from a query token.
Public methodCode examplegetSubmitStatus(String, Boolean, STATUSQUERY)
Gets the status of submitted destinations from a query token.
Public methodStatic memberCode examplegetTimeZones
Gets the time zones in the form of regions and cities. These are the values that are actually returned by PHP.
Public methodGetType
Gets the Type of the current instance.
(Inherited from Object.)
Public methodgetUser
Gets the account login used for authentication.
Public methodgetVariables
Gets a list of variables defined in the message for the calling object.
Public methodgetVariables(Boolean)
Gets a list of variables defined in the message for the calling object.
Public methodStatic memberCode examplegetVariables(String)
Gets a list of variables defined in a message for personalisation.
Public methodStatic memberCode examplegetVariables(String, Boolean)
Gets a list of variables defined in a message for personalisation.
Public methodStatic membergetVariablesCount
Gets the total number of variables defined in in the specified message.
Public methodisPersonalised
Indicates whether the message has been personalised for the destinations or not.
Public methodStatic memberisValidPhoneNumber(String)
Checks whether the specified value is a valid phone number or not.
Public methodisValidPhoneNumber(String, Boolean)
Checks whether the specified value is a valid phone number or not.
Protected methodMemberwiseClone
Creates a shallow copy of the current Object.
(Inherited from Object.)
Public methodStatic membermessageTypeToEnum
Converts a System.String representation of a MSGTYPE enumerator to its corresponding MSGTYPE enumeration type.
Public methodStatic membermessageTypeToString
Converts a MSGTYPE enumerator to a System.String object.
Public methodCode exampleparsePhoneNumber
Parses a phone number into a specific international format.
Public methodrecipientExists
Checks to see if the specified phone number exists in the destinations list or not.
Public methodreset
Resets message parameters to defaults.
Public methodschedule(NullableDateTime)
Sets a flag to indicate that the message should be submitted later at a specified date and time. The time portion must be in 24hr format.
Public methodCode exampleschedule(NullableDateTime, String)
Sets a flag to indicate that the message should be submitted later at a specified date and time. The time portion must be in 24hr format.
Public methodCode exampleschedule(NullableDateTime, String, String)
Sets a flag to indicate that the message should be submitted later at a specified date and time. The time portion must be in 24hr format.
Public methodStatic membersendPassword
Requests that account password should be sent to user email address
Public methodCode examplesetDefaultDialCode
Sets the default international dial code to be used for phone numbers not in international format.
Public methodCode examplesetMessage
Sets the message that will be submitted to the recipients.
Public methodsetMessageType(String)
Sets the type of message that should be sent.
Public methodsetMessageType(MSGTYPE)
Sets the type of message that should be sent.
Public methodsetPassword
Sets the user account password for authentication.
Public methodsetSenderId
Sets the sender ID of submitted message. This is what appears on the recipient's phone as the sender of the message.
Public methodsetUser
Sets the account login used for authentication.
Public methodsetWapPushUrl
Sets the Web URL for wap push message.
Public methodCode examplesubmit
Submits the composed message to the SMS server for submission to the added destinations.
Public methodToString
Returns a String that represents the current Object.
(Inherited from Object.)
Top
Fields
  NameDescription
Public fieldStatic memberPSNDRECPTSEP
Contains the character sequence that separates personalised values for different destinations.
Public fieldStatic memberPSNDVALSEP
Contains the character sequence that separates the values for a destination in a personalised SMS.
Top
Events
  NameDescription
Public eventSubmitCompleted
Event that is fired when submission of message is completed.
Public eventSubmitProgressChanged
Event that is fired when the progress of message submission changes.
Top
Remarks
This class is used to create and send SMS with or without personalisation. It involves composing message, setting sender ID, adding recipients and submitting message.
See Also