Interface IComposer

An interface for message container objects.

Namespace: Zenoph.Notify.Compose

Assembly: Zenoph.Notify.dll

Syntax

[ComVisible(true)]
[Guid("615901A6-E6F2-4b08-8D9A-908B943AC30A")]
public interface IComposer

Methods

addDestination(string)

Adds a phone number to the message destinations list.

Declaration

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

An interface for message container objects.

Declaration

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

An interface for message container objects.

Declaration

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

An interface for message container objects.

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

An interface for message container objects.

Declaration

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

Parameters

Type	Name	Description
List<string>	phoneNumbers

Returns

Type	Description
int

addDestinationsFromCollection(List<string>, bool)

An interface for message container objects.

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

An interface for message container objects.

Declaration

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

Parameters

Type	Name	Description
string[]	phoneNumbers

Returns

Type	Description
int

addDestinationsFromCollection(string[], bool)

An interface for message container objects.

Declaration

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

Parameters

Type	Name	Description
string[]	phoneNumbers
bool	throwEx

Returns

Type	Description
int

addDestinationsFromCollectionEx(string[], bool)

An interface for message container objects.

Declaration

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

Parameters

Type	Name	Description
string[]	phoneNumbers
bool	throwEx

Returns

Type	Description
int

addDestinationsFromTextStream(string)

Adds phone numbers to the message destinations list from a specified text stream

Declaration

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

Parameters

Type	Name	Description
string	str	The text stream from which phone numbers will be extracted and added to the message destinations list.

Returns

Type	Description
int	The count of phone numbers extracted and added to the message destinations list

Exceptions

Type	Condition
Exception	Thrown if str is null or empty

clearDestinations()

An interface for message container objects.

Declaration

[ComVisible(true)]
void clearDestinations()

destinationExists(string)

An interface for message container objects.

Declaration

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

Parameters

Type	Name	Description
string	phoneNumber

Returns

Type	Description
bool

getCategory()

An interface for message container objects.

Declaration

[ComVisible(true)]
MessageCategory getCategory()

Returns

Type	Description
MessageCategory

getDefaultDestinationCountry()

An interface for message container objects.

Declaration

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

Returns

Type	Description
string[]

getDefaultNumberPrefix()

An interface for message container objects.

Declaration

[ComVisible(true)]
string getDefaultNumberPrefix()

Returns

Type	Description
string

getDefaultTimeZone()

An interface for message container objects.

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)

An interface for message container objects.

Declaration

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

Parameters

Type	Name	Description
string	phoneNumber

Returns

Type	Description
DestinationMode

getDestinationWriteModeById(string)

An interface for message container objects.

Declaration

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

Parameters

Type	Name	Description
string	messageId

Returns

Type	Description
DestinationMode

getDestinations()

An interface for message container objects.

Declaration

[ComVisible(true)]
ComposerDestinationsList getDestinations()

Returns

Type	Description
ComposerDestinationsList

getDestinationsCount()

An interface for message container objects.

Declaration

[ComVisible(true)]
int getDestinationsCount()

Returns

Type	Description
int

getRouteCountries()

An interface for message container objects.

Declaration

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

Returns

Type	Description
List<string[]>

getRouteCountriesEx()

An interface for message container objects.

Declaration

[ComVisible(true)]
object getRouteCountriesEx()

Returns

Type	Description
object

removeDestination(string)

An interface for message container objects.

Declaration

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

Parameters

Type	Name	Description
string	phoneNumber

Returns

Type	Description
bool

removeDestinationById(string)

An interface for message container objects.

Declaration

[ComVisible(true)]
bool removeDestinationById(string messageId)

Parameters

Type	Name	Description
string	messageId

Returns

Type	Description
bool

setDefaultNumberPrefix(string)

An interface for message container objects.

Declaration

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

Parameters

Type	Name	Description
string	dialCode

updateDestination(string, string)

An interface for message container objects.

Declaration

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

Parameters

Type	Name	Description
string	prePhoneNumber
string	newPhoneNumber

Returns

Type	Description
bool

updateDestinationById(string, string)

An interface for message container objects.

Declaration

[ComVisible(true)]
bool updateDestinationById(string messageId, string newPhoneNumber)

Parameters

Type	Name	Description
string	messageId
string	newPhoneNumber

Returns

Type	Description
bool