Class SMSRequest

Inheritance
object
NotifyRequest
ComposeRequest
MessageRequest
SMSRequest
Inherited Members
Namespace: Zenoph.Notify.Request
Assembly: Zenoph.Notify.dll
Syntax
[ComVisible(true)]
[Guid("7735CD4B-87EE-4035-BD4D-B1B983DFB021")]
public class SMSRequest : MessageRequest, IComposer, IMessageComposer, ISchedule, ISMSComposer

Constructors

SMSRequest()

Declaration
public SMSRequest()

SMSRequest(AuthProfile)

Declaration
public SMSRequest(AuthProfile ap)
Parameters
Type Name Description
AuthProfile ap

Fields

_messageTypes

Declaration
protected static List<Dictionary<string, object>> _messageTypes
Field Value
Type Description
List<Dictionary<string, object>>

Methods

addDestination(string)

Declaration
[ComVisible(true)]
public override NumberAddInfo addDestination(string phoneNumber)
Parameters
Type Name Description
string phoneNumber
Returns
Type Description
NumberAddInfo
Overrides

addDestination(string, bool)

Adds a phone number to the message destinations list.

Declaration
[ComVisible(false)]
public override NumberAddInfo addDestination(string phoneNumber, bool throwEx)
Parameters
Type Name Description
string phoneNumber

The phone number to be added to the message destinations list
bool throwEx

Exception Control Specifier (ECS) that indicates whether Exception should be thrown or not when phoneNumber is invalid or not permitted
Returns
Type Description
NumberAddInfo
Overrides

getMessageCount(string, SMSType)

Declaration
[ComVisible(false)]
public static int getMessageCount(string msg, SMSType type)
Parameters
Type Name Description
string msg
SMSType type
Returns
Type Description
int

getMessageId(string)

Declaration
public string getMessageId(string phoneNumber)
Parameters
Type Name Description
string phoneNumber
Returns
Type Description
string

getMessageVariables(string)

Declaration
[ComVisible(false)]
public static string[] getMessageVariables(string msg)
Parameters
Type Name Description
string msg
Returns
Type Description
string[]

getMessageVariables(string, bool)

Declaration
[ComVisible(false)]
public static string[] getMessageVariables(string msg, bool trim)
Parameters
Type Name Description
string msg
bool trim
Returns
Type Description
string[]

getMessageVariablesCount(string)

Declaration
[ComVisible(false)]
public static int getMessageVariablesCount(string text)
Parameters
Type Name Description
string text
Returns
Type Description
int

getSMSTypes()

Declaration
[ComVisible(false)]
public static List<SMSType> getSMSTypes()
Returns
Type Description
List<SMSType>

getUserDefaultTextMessageType()

Declaration
public SMSType getUserDefaultTextMessageType()
Returns
Type Description
SMSType

isAlphaNumbericSender(string)

Declaration
[ComVisible(false)]
public static bool isAlphaNumbericSender(string sender)
Parameters
Type Name Description
string sender
Returns
Type Description
bool

isAlphaNumbericSenderEx(string)

Declaration
[ComVisible(true)]
public bool isAlphaNumbericSenderEx(string sender)
Parameters
Type Name Description
string sender
Returns
Type Description
bool

setMessage(string)

Declaration
[ComVisible(true)]
public override void setMessage(string message)
Parameters
Type Name Description
string message
Overrides

submit()

Declaration
[ComVisible(true)]
public override APIResponse submit()
Returns
Type Description
APIResponse
Overrides

submitComposer(SMSComposer, object, string, Delegate, Delegate)

Declaration
[ComVisible(false)]
public static APIResponse submitComposer(SMSComposer sc, object arg1, string arg2 = null, Delegate spea = null, Delegate scea = null)
Parameters
Type Name Description
SMSComposer sc
object arg1
string arg2
Delegate spea
Delegate scea
Returns
Type Description
APIResponse

submitComposer(SMSComposer, string)

Declaration
[ComVisible(false)]
public static APIResponse submitComposer(SMSComposer sc, string apiKey)
Parameters
Type Name Description
SMSComposer sc
string apiKey
Returns
Type Description
APIResponse

submitComposer(SMSComposer, string, Delegate, Delegate)

Declaration
[ComVisible(false)]
public static object submitComposer(SMSComposer sc, string apiKey, Delegate spea, Delegate scea)
Parameters
Type Name Description
SMSComposer sc
string apiKey
Delegate spea
Delegate scea
Returns
Type Description
object

submitComposer(SMSComposer, string, string)

Declaration
[ComVisible(false)]
public static APIResponse submitComposer(SMSComposer sc, string plogin, string ppass)
Parameters
Type Name Description
SMSComposer sc
string plogin
string ppass
Returns
Type Description
APIResponse

submitComposer(SMSComposer, string, string, Delegate, Delegate)

Declaration
[ComVisible(false)]
public static object submitComposer(SMSComposer sc, string plogin, string ppass, Delegate spea, Delegate scea)
Parameters
Type Name Description
SMSComposer sc
string plogin
string ppass
Delegate spea
Delegate scea
Returns
Type Description
object

submitComposer(SMSComposer, AuthProfile)

Declaration
[ComVisible(false)]
public static APIResponse submitComposer(SMSComposer sc, AuthProfile ap)
Parameters
Type Name Description
SMSComposer sc
AuthProfile ap
Returns
Type Description
APIResponse

submitComposer(SMSComposer, AuthProfile, Delegate, Delegate)

Declaration
[ComVisible(false)]
public static object submitComposer(SMSComposer sc, AuthProfile ap, Delegate spea, Delegate scea)
Parameters
Type Name Description
SMSComposer sc
AuthProfile ap
Delegate spea
Delegate scea
Returns
Type Description
object

submitComposerEx(SMSComposer, Delegate, Delegate)

Declaration
[ComVisible(true)]
public APIResponse submitComposerEx(SMSComposer sc, Delegate spea = null, Delegate scea = null)
Parameters
Type Name Description
SMSComposer sc
Delegate spea
Delegate scea
Returns
Type Description
APIResponse

validate()

Declaration
protected void validate()

Explicit Interface Implementations

addDestination(string, bool, string[])

Declaration
[ComVisible(false)]
NumberAddInfo addDestination(string phoneNumber, bool throwEx, string[] values)
Parameters
Type Name Description
string phoneNumber
bool throwEx
string[] values
Returns
Type Description
NumberAddInfo

addDestination(string, bool, string[], string)

Declaration
[ComVisible(false)]
NumberAddInfo addDestination(string phoneNumber, bool throwEx, string[] values, string messageId)
Parameters
Type Name Description
string phoneNumber
bool throwEx
string[] values
string messageId
Returns
Type Description
NumberAddInfo

addDestination(string, string[])

Declaration
[ComVisible(false)]
NumberAddInfo addDestination(string phoneNumber, string[] values)
Parameters
Type Name Description
string phoneNumber
string[] values
Returns
Type Description
NumberAddInfo

addDestination(string, string[], string)

Declaration
[ComVisible(false)]
NumberAddInfo addDestination(string phoneNumber, string[] values, string messageId)
Parameters
Type Name Description
string phoneNumber
string[] values
string messageId
Returns
Type Description
NumberAddInfo

addPersonalisedDestination(string, bool, string[])

Declaration
[ComVisible(false)]
NumberAddInfo addPersonalisedDestination(string phoneNumber, bool throwEx, string[] values)
Parameters
Type Name Description
string phoneNumber
bool throwEx
string[] values
Returns
Type Description
NumberAddInfo

addPersonalisedDestination(string, bool, string[], string)

Declaration
[ComVisible(false)]
NumberAddInfo addPersonalisedDestination(string phoneNumber, bool throwEx, string[] values, string messageId)
Parameters
Type Name Description
string phoneNumber
bool throwEx
string[] values
string messageId
Returns
Type Description
NumberAddInfo

addPersonalisedDestination(string, string[], string)

Declaration
[ComVisible(false)]
NumberAddInfo addPersonalisedDestination(string phoneNumber, string[] values, string messageId)
Parameters
Type Name Description
string phoneNumber
string[] values
string messageId
Returns
Type Description
NumberAddInfo

addPersonalisedDestinationEx(string, bool, object, string)

Declaration
[ComVisible(true)]
NumberAddInfo addPersonalisedDestinationEx(string phoneNumber, bool throwEx = true, object values = null, string messageId = null)
Parameters
Type Name Description
string phoneNumber
bool throwEx
object values
string messageId
Returns
Type Description
NumberAddInfo

addPersonalisedDestintion(string, string[])

Declaration
[ComVisible(false)]
NumberAddInfo addPersonalisedDestintion(string phoneNumber, string[] values)
Parameters
Type Name Description
string phoneNumber
string[] values
Returns
Type Description
NumberAddInfo

getDefaultSMSType()

Declaration
[ComVisible(true)]
SMSType getDefaultSMSType()
Returns
Type Description
SMSType

getDestinationWriteMode(string, string[])

Declaration
[ComVisible(false)]
DestinationMode getDestinationWriteMode(string phoneNumber, string[] values)
Parameters
Type Name Description
string phoneNumber
string[] values
Returns
Type Description
DestinationMode

getMessageCount()

Declaration
[ComVisible(false)]
int getMessageCount()
Returns
Type Description
int

getMessageCountEx(string, SMSType)

Declaration
[ComVisible(true)]
int getMessageCountEx(string message, SMSType type)
Parameters
Type Name Description
string message
SMSType type
Returns
Type Description
int

getMessageId(string, string[])

Declaration
string getMessageId(string phoneNumber, string[] values)
Parameters
Type Name Description
string phoneNumber
string[] values
Returns
Type Description
string

getMessageVariables()

Declaration
[ComVisible(false)]
string[] getMessageVariables()
Returns
Type Description
string[]

getMessageVariables(bool)

Declaration
[ComVisible(false)]
string[] getMessageVariables(bool trim)
Parameters
Type Name Description
bool trim
Returns
Type Description
string[]

getMessageVariablesCount()

Declaration
[ComVisible(true)]
int getMessageVariablesCount()
Returns
Type Description
int

getMessageVariablesCountEx(string)

Declaration
[ComVisible(true)]
int getMessageVariablesCountEx(string message)
Parameters
Type Name Description
string message
Returns
Type Description
int

getMessageVariablesEx(bool, string)

Declaration
[ComVisible(true)]
string[] getMessageVariablesEx(bool trim = true, string msg = null)
Parameters
Type Name Description
bool trim
string msg
Returns
Type Description
string[]

getPersonalisedDestinationMessageId(string, string[])

Declaration
[ComVisible(true)]
string getPersonalisedDestinationMessageId(string phoneNumber, string[] values)
Parameters
Type Name Description
string phoneNumber
string[] values
Returns
Type Description
string

getPersonalisedDestinationWriteMode(string, string[])

Declaration
[ComVisible(true)]
DestinationMode getPersonalisedDestinationWriteMode(string phoneNumber, string[] values)
Parameters
Type Name Description
string phoneNumber
string[] values
Returns
Type Description
DestinationMode

getPersonalisedMessagePreview(string)

Declaration
[ComVisible(false)]
string[] getPersonalisedMessagePreview(string phoneNumber)
Parameters
Type Name Description
string phoneNumber
Returns
Type Description
string[]

getPersonalisedMessagePreview(string, string[])

Declaration
[ComVisible(false)]
string getPersonalisedMessagePreview(string phoneNumber, string[] values)
Parameters
Type Name Description
string phoneNumber
string[] values
Returns
Type Description
string

getPersonalisedMessagePreview(string, PersonalisedValues)

Declaration
[ComVisible(false)]
string getPersonalisedMessagePreview(string phoneNumber, PersonalisedValues pv)
Parameters
Type Name Description
string phoneNumber
PersonalisedValues pv
Returns
Type Description
string

getPersonalisedMessagePreviewEx(string, object)

Declaration
[ComVisible(false)]
PersonalisedMessagesList getPersonalisedMessagePreviewEx(string phoneNumber, object values = null)
Parameters
Type Name Description
string phoneNumber
object values
Returns
Type Description
PersonalisedMessagesList

getPersonalisedValues(string)

Declaration
[ComVisible(true)]
PersonalisedValuesList getPersonalisedValues(string phoneNumber)
Parameters
Type Name Description
string phoneNumber
Returns
Type Description
PersonalisedValuesList

getPersonalisedValuesById(string)

Declaration
[ComVisible(true)]
string[] getPersonalisedValuesById(string messageId)
Parameters
Type Name Description
string messageId
Returns
Type Description
string[]

getRegisteredSenderIds()

Declaration
[ComVisible(true)]
string[] getRegisteredSenderIds()
Returns
Type Description
string[]

getSMSType()

Declaration
[ComVisible(true)]
SMSType getSMSType()
Returns
Type Description
SMSType

isPersonalised()

Declaration
bool isPersonalised()
Returns
Type Description
bool

personalisedValuesExists(string, string[])

Declaration
[ComVisible(true)]
bool personalisedValuesExists(string phoneNumber, string[] values)
Parameters
Type Name Description
string phoneNumber
string[] values
Returns
Type Description
bool

removeDestination(string, string[])

Declaration
[ComVisible(false)]
bool removeDestination(string phoneNumber, string[] values)
Parameters
Type Name Description
string phoneNumber
string[] values
Returns
Type Description
bool

removePersonalisedDestination(string, string[])

Declaration
[ComVisible(true)]
bool removePersonalisedDestination(string phoneNumber, string[] values)
Parameters
Type Name Description
string phoneNumber
string[] values
Returns
Type Description
bool

removePersonalisedValues(string, string[])

Declaration
[ComVisible(true)]
bool removePersonalisedValues(string phoneNumber, string[] values)
Parameters
Type Name Description
string phoneNumber
string[] values
Returns
Type Description
bool

setMessage(string, bool)

Declaration
[ComVisible(false)]
void setMessage(string message, bool isPsnd)
Parameters
Type Name Description
string message
bool isPsnd

setMessageCategory(MessageCategory)

Declaration
[ComVisible(true)]
void setMessageCategory(MessageCategory category)
Parameters
Type Name Description
MessageCategory category

setMessageEx(string, object)

Declaration
[ComVisible(true)]
void setMessageEx(string msg, object psnd = null)
Parameters
Type Name Description
string msg
object psnd

setSMSType(string)

Declaration
[ComVisible(false)]
void setSMSType(string type)
Parameters
Type Name Description
string type

setSMSType(SMSType)

Declaration
[ComVisible(false)]
void setSMSType(SMSType type)
Parameters
Type Name Description
SMSType type

setSMSTypeEx(object)

Declaration
[ComVisible(true)]
void setSMSTypeEx(object type)
Parameters
Type Name Description
object type

updatePersonalisedValues(string, string[])

Declaration
[ComVisible(false)]
bool updatePersonalisedValues(string phonenum, string[] newValues)
Parameters
Type Name Description
string phonenum
string[] newValues
Returns
Type Description
bool

updatePersonalisedValues(string, string[], string)

Declaration
[ComVisible(false)]
bool updatePersonalisedValues(string phoneNumber, string[] values, string messageId)
Parameters
Type Name Description
string phoneNumber
string[] values
string messageId
Returns
Type Description
bool

updatePersonalisedValues(string, string[], string[])

Declaration
[ComVisible(false)]
bool updatePersonalisedValues(string phonenum, string[] newValues, string[] prevValues)
Parameters
Type Name Description
string phonenum
string[] newValues
string[] prevValues
Returns
Type Description
bool

updatePersonalisedValuesById(string, string[])

Declaration
[ComVisible(true)]
bool updatePersonalisedValuesById(string messageId, string[] newValues)
Parameters
Type Name Description
string messageId
string[] newValues
Returns
Type Description
bool

updatePersonalisedValuesEx(string, string[], object)

Declaration
[ComVisible(true)]
bool updatePersonalisedValuesEx(string phonenum, string[] newValues, object prevValues = null)
Parameters
Type Name Description
string phonenum
string[] newValues
object prevValues
Returns
Type Description
bool

updatePersonalisedValuesExWithId(string, string[], string)

Declaration
[ComVisible(true)]
bool updatePersonalisedValuesExWithId(string phoneNumber, string[] newValues, string newMessageId)
Parameters
Type Name Description
string phoneNumber
string[] newValues
string newMessageId
Returns
Type Description
bool

Implements