Interface ISMSComposer

Namespace: Zenoph.Notify.Compose

Assembly: Zenoph.Notify.dll

Syntax

[ComVisible(true)]
[Guid("08DD524B-D2C0-40e1-BC9B-27DDAFEB6B3B")]
public interface ISMSComposer

Methods

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[])

Declaration

[ComVisible(false)]
NumberAddInfo addPersonalisedDestination(string phoneNumber, string[] values)

Parameters

Type	Name	Description
string	phoneNumber
string[]	values

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

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(true)]
int getMessageCount()

Returns

Type	Description
int

getMessageCountEx(string, SMSType)

Declaration

[ComVisible(true)]
int getMessageCountEx(string msg, SMSType type)

Parameters

Type	Name	Description
string	msg
SMSType	type

Returns

Type	Description
int

getMessageId(string, string[])

Declaration

[ComVisible(false)]
string getMessageId(string phoneNumber, string[] values)

Parameters

Type	Name	Description
string	phoneNumber
string[]	values

Returns

Type	Description
string

getMessageVariables()

Declaration

[ComVisible(true)]
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(true)]
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

[ComVisible(true)]
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(false)]
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 phoneNumber, string[] newValues)

Parameters

Type	Name	Description
string	phoneNumber
string[]	newValues

Returns

Type	Description
bool

updatePersonalisedValues(string, string[], string)

Declaration

[ComVisible(false)]
bool updatePersonalisedValues(string phoneNumber, string[] newValues, string messageId)

Parameters

Type	Name	Description
string	phoneNumber
string[]	newValues
string	messageId

Returns

Type	Description
bool

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

Declaration

[ComVisible(false)]
bool updatePersonalisedValues(string phoneNumber, string[] newValues, string[] prevValues)

Parameters

Type	Name	Description
string	phoneNumber
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 phoneNumber, string[] newValues, object prevValues = null)

Parameters

Type	Name	Description
string	phoneNumber
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