Class Composer

Inheritance

object

Composer

MessageComposer

USSDComposer

Implements

IComposer

Inherited Members

object.ToString()

object.Equals(object)

object.Equals(object, object)

object.ReferenceEquals(object, object)

object.GetHashCode()

object.GetType()

object.Finalize()

object.MemberwiseClone()

Namespace: Zenoph.Notify.Compose

Assembly: Zenoph.Notify.dll

Syntax

[ComVisible(true)]
[Guid("3E476579-8856-4d74-B4E1-E6131E3B3B82")]
public abstract class Composer : IComposer

Constructors

Composer()

Declaration

public Composer()

Composer(AuthProfile)

Declaration

public Composer(AuthProfile ap)

Parameters

Type	Name	Description
AuthProfile	ap

Fields

__DEST_COUNTRYCODE_LABEL__

Declaration

protected static readonly string __DEST_COUNTRYCODE_LABEL__

Field Value

Type	Description
string

__DEST_INFO_LABEL__

Declaration

protected static readonly string __DEST_INFO_LABEL__

Field Value

Type	Description
string

_category

Declaration

protected MessageCategory _category

Field Value

Type	Description
MessageCategory

_customDataLabel

Declaration

protected static object _customDataLabel

Field Value

Type	Description
object

_destIdsMap

Declaration

protected Dictionary<string, ComposerDestination> _destIdsMap

Field Value

Type	Description
Dictionary<string, ComposerDestination>

_destNumberMap

Declaration

protected Dictionary<string, Dictionary<string, object>> _destNumberMap

Field Value

Type	Description
Dictionary<string, Dictionary<string, object>>

_destinations

Declaration

protected List<ComposerDestination> _destinations

Field Value

Type	Description
List<ComposerDestination>

_userData

Declaration

protected UserData _userData

Field Value

Type	Description
UserData

Methods

addDestination(string, string, string, object)

Declaration

[ComVisible(false)]
protected NumberAddInfo addDestination(string phoneNumber, string countryCode, string messageId, object data)

Parameters

Type	Name	Description
string	phoneNumber
string	countryCode
string	messageId
object	data

Returns

Type	Description
NumberAddInfo

addDestination(ComposerDestination)

Declaration

[ComVisible(false)]
protected void addDestination(ComposerDestination cd)

Parameters

Type	Name	Description
ComposerDestination	cd

addDestination(ComposerDestination, string)

Declaration

[ComVisible(false)]
protected void addDestination(ComposerDestination cd, string countryCode)

Parameters

Type	Name	Description
ComposerDestination	cd
string	countryCode

addDestinationsList(List<ComposerDestination>, string)

Declaration

[ComVisible(false)]
protected void addDestinationsList(List<ComposerDestination> compDestList, string countryCode)

Parameters

Type	Name	Description
List<ComposerDestination>	compDestList
string	countryCode

createComposerDestination(string, string, DestinationMode, object)

Declaration

[ComVisible(false)]
protected ComposerDestination createComposerDestination(string phoneNumber, string messageId, DestinationMode mode, object data)

Parameters

Type	Name	Description
string	phoneNumber
string	messageId
DestinationMode	mode
object	data

Returns

Type	Description
ComposerDestination

createComposerDestination(string, string, DestinationMode, object, bool)

Declaration

[ComVisible(false)]
protected ComposerDestination createComposerDestination(string phoneNumber, string messageId, DestinationMode mode, object data, bool scheduled)

Parameters

Type	Name	Description
string	phoneNumber
string	messageId
DestinationMode	mode
object	data
bool	scheduled

Returns

Type	Description
ComposerDestination

createDestinationMap(string, string, DestinationMode, object, bool)

Declaration

[ComVisible(false)]
protected virtual Dictionary<string, object> createDestinationMap(string phoneNumber, string messageId, DestinationMode mode, object data, bool scheduled)

Parameters

Type	Name	Description
string	phoneNumber
string	messageId
DestinationMode	mode
object	data
bool	scheduled

Returns

Type	Description
Dictionary<string, object>

destinationIdExists(string)

Declaration

[ComVisible(true)]
protected bool destinationIdExists(string destId)

Parameters

Type	Name	Description
string	destId

Returns

Type	Description
bool

formatPhoneNumber(string)

Declaration

[ComVisible(true)]
protected string[] formatPhoneNumber(string phoneNumber)

Parameters

Type	Name	Description
string	phoneNumber

Returns

Type	Description
string[]

formatPhoneNumber(string, bool)

Declaration

[ComVisible(true)]
protected string[] formatPhoneNumber(string phoneNumber, bool throwEx)

Parameters

Type	Name	Description
string	phoneNumber
bool	throwEx

Returns

Type	Description
string[]

formattedDestinationExists(string)

Declaration

[ComVisible(true)]
protected bool formattedDestinationExists(string phoneNumber)

Parameters

Type	Name	Description
string	phoneNumber

Returns

Type	Description
bool

getComposerDestinationById(string)

Declaration

protected ComposerDestination getComposerDestinationById(string messageId)

Parameters

Type	Name	Description
string	messageId

Returns

Type	Description
ComposerDestination

getComposerDestinations(string)

Declaration

protected List<ComposerDestination> getComposerDestinations(string phoneNumber)

Parameters

Type	Name	Description
string	phoneNumber

Returns

Type	Description
List<ComposerDestination>

getDestinationCountryCode(string)

Declaration

[ComVisible(false)]
protected string getDestinationCountryCode(string phoneNumber)

Parameters

Type	Name	Description
string	phoneNumber

Returns

Type	Description
string

getMappedDestinationById(string)

Declaration

protected ComposerDestination getMappedDestinationById(string destId)

Parameters

Type	Name	Description
string	destId

Returns

Type	Description
ComposerDestination

getMappedDestinations(string)

Declaration

protected List<ComposerDestination> getMappedDestinations(string phoneNumber)

Parameters

Type	Name	Description
string	phoneNumber

Returns

Type	Description
List<ComposerDestination>

getPhoneNumberFromMessageId(string)

Declaration

[ComVisible(false)]
protected string getPhoneNumberFromMessageId(string messageId)

Parameters

Type	Name	Description
string	messageId

Returns

Type	Description
string

removeDestination(ComposerDestination)

Declaration

[ComVisible(false)]
protected bool removeDestination(ComposerDestination cd)

Parameters

Type	Name	Description
ComposerDestination	cd

Returns

Type	Description
bool

removeDestinationsList(string, List<ComposerDestination>)

Declaration

protected void removeDestinationsList(string phoneNumber, List<ComposerDestination> destsList)

Parameters

Type	Name	Description
string	phoneNumber
List<ComposerDestination>	destsList

setUserData(UserData)

Declaration

[ComVisible(false)]
public void setUserData(UserData ud)

Parameters

Type	Name	Description
UserData	ud

updateDestination(ComposerDestination, string)

Declaration

[ComVisible(false)]
protected bool updateDestination(ComposerDestination cd, string newPhoneNumber)

Parameters

Type	Name	Description
ComposerDestination	cd
string	newPhoneNumber

Returns

Type	Description
bool

validateCustomMessageId(string, bool)

Declaration

[ComVisible(false)]
protected NumberAddInfo validateCustomMessageId(string messageId, bool throwEx)

Parameters

Type	Name	Description
string	messageId
bool	throwEx

Returns

Type	Description
NumberAddInfo

validateDestinationUpdate(string, string)

Declaration

[ComVisible(false)]
protected virtual Dictionary<string, object> validateDestinationUpdate(string prePhoneNumber, string newPhoneNumber)

Parameters

Type	Name	Description
string	prePhoneNumber
string	newPhoneNumber

Returns

Type	Description
Dictionary<string, object>

Explicit Interface Implementations

addDestination(string)

Adds a phone number to the message destinations list.

Declaration

[ComVisible(false)]
virtual NumberAddInfo addDestination(string phoneNumber)

Parameters

Type	Name	Description
string	phoneNumber	The phone number to be added to the message destinations list

Returns

Type	Description
NumberAddInfo

Remarks

The phone number can be in local or international number format. By default, if phoneNumber is invalid or not permitted, System.Exception will be thrown

Exceptions

Type	Condition
Exception	Thrown if phoneNumber is invalid or not permitted

addDestination(string, bool)

Adds a phone number to the message destinations list.

Declaration

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

addDestination(string, bool, string)

Declaration

[ComVisible(false)]
virtual NumberAddInfo addDestination(string phoneNumber, bool throwEx, string messageId)

Parameters

Type	Name	Description
string	phoneNumber
bool	throwEx
string	messageId

Returns

Type	Description
NumberAddInfo

addDestination(string, string)

Declaration

[ComVisible(false)]
virtual NumberAddInfo addDestination(string phoneNumber, string messageId)

Parameters

Type	Name	Description
string	phoneNumber
string	messageId

Returns

Type	Description
NumberAddInfo

addDestinationEx(string, bool)

Adds a phone number to the message destinations list.

Declaration

[ComVisible(true)]
NumberAddInfo addDestinationEx(string phoneNumber, bool throwEx = true)

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

Remarks

This method is functionally the same as addDestination(string, bool). The main purpose for its introduction is to be called in VB and VBA applications for supplying optional arguments when adding destinations. It is a workaround to overcome the limitation of COM with regard to function overloading.

Although intended to be called in VB and VBA applications, it can also be called in other programming environments.

addDestinationWithId(string, string, bool)

Declaration

[ComVisible(true)]
NumberAddInfo addDestinationWithId(string phoneNumber, string messageId, bool throwEx = true)

Parameters

Type	Name	Description
string	phoneNumber
string	messageId
bool	throwEx

Returns

Type	Description
NumberAddInfo

addDestinationsFromCollection(List<string>)

Declaration

[ComVisible(false)]
int addDestinationsFromCollection(List<string> phoneNumbers)

Parameters

Type	Name	Description
List<string>	phoneNumbers

Returns

Type	Description
int

addDestinationsFromCollection(List<string>, bool)

Declaration

[ComVisible(false)]
int addDestinationsFromCollection(List<string> phoneNumbers, bool throwEx)

Parameters

Type	Name	Description
List<string>	phoneNumbers
bool	throwEx

Returns

Type	Description
int

addDestinationsFromCollection(string[])

Declaration

[ComVisible(false)]
int addDestinationsFromCollection(string[] phoneNumbers)

Parameters

Type	Name	Description
string[]	phoneNumbers

Returns

Type	Description
int

addDestinationsFromCollection(string[], bool)

Declaration

[ComVisible(false)]
int addDestinationsFromCollection(string[] phoneNumbers, bool throwEx)

Parameters

Type	Name	Description
string[]	phoneNumbers
bool	throwEx

Returns

Type	Description
int

addDestinationsFromCollectionEx(string[], bool)

Declaration

[ComVisible(true)]
int addDestinationsFromCollectionEx(string[] phoneNumbers, bool throwEx = false)

Parameters

Type	Name	Description
string[]	phoneNumbers
bool	throwEx

Returns

Type	Description
int

addDestinationsFromTextStream(string)

Declaration

[ComVisible(true)]
int addDestinationsFromTextStream(string str)

Parameters

Type	Name	Description
string	str

Returns

Type	Description
int

clearDestinations()

Declaration

[ComVisible(true)]
void clearDestinations()

destinationExists(string)

Declaration

[ComVisible(true)]
bool destinationExists(string phoneNumber)

Parameters

Type	Name	Description
string	phoneNumber

Returns

Type	Description
bool

getCategory()

Declaration

[ComVisible(true)]
MessageCategory getCategory()

Returns

Type	Description
MessageCategory

getDefaultDestinationCountry()

Declaration

[ComVisible(true)]
string[] getDefaultDestinationCountry()

Returns

Type	Description
string[]

getDefaultNumberPrefix()

Declaration

[ComVisible(true)]
string getDefaultNumberPrefix()

Returns

Type	Description
string

getDefaultTimeZone()

Declaration

[ComVisible(true)]
string[] getDefaultTimeZone()

Returns

Type	Description
string[]

getDestinationCountry(string)

Gets the country for the specified phone number

Declaration

[ComVisible(true)]
string getDestinationCountry(string phoneNumber)

Parameters

Type	Name	Description
string	phoneNumber

Returns

Type	Description
string	The country for which phoneNumber applies.

getDestinationWriteMode(string)

Declaration

[ComVisible(true)]
DestinationMode getDestinationWriteMode(string phoneNumber)

Parameters

Type	Name	Description
string	phoneNumber

Returns

Type	Description
DestinationMode

getDestinationWriteModeById(string)

Declaration

[ComVisible(true)]
DestinationMode getDestinationWriteModeById(string messageId)

Parameters

Type	Name	Description
string	messageId

Returns

Type	Description
DestinationMode

getDestinations()

Declaration

[ComVisible(true)]
ComposerDestinationsList getDestinations()

Returns

Type	Description
ComposerDestinationsList

getDestinationsCount()

Declaration

[ComVisible(true)]
int getDestinationsCount()

Returns

Type	Description
int

getRouteCountries()

Declaration

[ComVisible(false)]
List<string[]> getRouteCountries()

Returns

Type	Description
List<string[]>

getRouteCountriesEx()

Declaration

[ComVisible(true)]
object getRouteCountriesEx()

Returns

Type	Description
object

removeDestination(string)

Declaration

[ComVisible(true)]
virtual bool removeDestination(string phoneNumber)

Parameters

Type	Name	Description
string	phoneNumber

Returns

Type	Description
bool

removeDestinationById(string)

Declaration

[ComVisible(true)]
virtual bool removeDestinationById(string destId)

Parameters

Type	Name	Description
string	destId

Returns

Type	Description
bool

setDefaultNumberPrefix(string)

Declaration

[ComVisible(true)]
void setDefaultNumberPrefix(string dialCode)

Parameters

Type	Name	Description
string	dialCode

updateDestination(string, string)

Declaration

[ComVisible(true)]
bool updateDestination(string prePhoneNumber, string newPhoneNumber)

Parameters

Type	Name	Description
string	prePhoneNumber
string	newPhoneNumber

Returns

Type	Description
bool

updateDestinationById(string, string)

Declaration

[ComVisible(true)]
virtual bool updateDestinationById(string destId, string newPhoneNumber)

Parameters

Type	Name	Description
string	destId
string	newPhoneNumber

Returns

Type	Description
bool

Implements

IComposer