Class ComposeRequest

Inheritance

object

NotifyRequest

ComposeRequest

MessageRequest

Implements

IComposer

Inherited Members

NotifyRequest._requestResource

NotifyRequest._progressPercentage

NotifyRequest._httpRequest

NotifyRequest._requestData

NotifyRequest._authProfile

NotifyRequest._loadaps

NotifyRequest._isFileUpload

NotifyRequest._contentType

NotifyRequest._acceptType

NotifyRequest._authFragment

NotifyRequest._userSettings

NotifyRequest.onSubmitCompleted

NotifyRequest.onSubmitProgressChanged

NotifyRequest.validateAuthProfile(AuthProfile)

NotifyRequest.setHost(string)

NotifyRequest.setHttpPort(int)

NotifyRequest.setHttpsPort(int)

NotifyRequest.getAuthModel()

NotifyRequest.setAuthModel(AuthModel)

NotifyRequest.getAuthLogin()

NotifyRequest.setAuthLogin(string)

NotifyRequest.getAuthPassword()

NotifyRequest.setAuthPassword(string)

NotifyRequest.getAuthApiKey()

NotifyRequest.setAuthApiKey(string)

NotifyRequest.getRequestURL()

NotifyRequest.setRequestResource(string)

NotifyRequest.setRequestContentType(ContentType)

NotifyRequest.responseContentTypeSuppored(ContentType)

NotifyRequest.setResponseContentType(ContentType)

NotifyRequest.updateRequestSubmitProgress()

NotifyRequest.useSecureConnection(bool)

NotifyRequest.useSecureConnection(bool, int)

NotifyRequest.useSecureConnectionEx(bool, int)

NotifyRequest.createDataWriter()

NotifyRequest.initHttpRequest()

NotifyRequest.submit()

NotifyRequest.writeRequestStreamData(string)

NotifyRequest.pullAuthInfoFromProfile()

object.ToString()

object.Equals(object)

object.Equals(object, object)

object.ReferenceEquals(object, object)

object.GetHashCode()

object.GetType()

object.Finalize()

object.MemberwiseClone()

Namespace: Zenoph.Notify.Request

Assembly: Zenoph.Notify.dll

Syntax

[ComVisible(true)]
[Guid("E42456A0-86B4-463d-99D1-135280B8920E")]
public abstract class ComposeRequest : NotifyRequest, IComposer

Constructors

ComposeRequest()

Declaration

public ComposeRequest()

ComposeRequest(AuthProfile)

Declaration

public ComposeRequest(AuthProfile ap)

Parameters

Type	Name	Description
AuthProfile	ap

Fields

_composer

Declaration

protected Composer _composer

Field Value

Type	Description
Composer

Methods

assertComposer()

Declaration

[ComVisible(false)]
protected void assertComposer()

getComposer()

Declaration

[ComVisible(true)]
public Composer getComposer()

Returns

Type	Description
Composer

setAuthProfile(AuthProfile)

Declaration

public override void setAuthProfile(AuthProfile ap)

Parameters

Type	Name	Description
AuthProfile	ap

Overrides

NotifyRequest.setAuthProfile(AuthProfile)

submit(Delegate, Delegate)

Declaration

protected object submit(Delegate spea, Delegate scea)

Parameters

Type	Name	Description
Delegate	spea
Delegate	scea

Returns

Type	Description
object

validate()

Declaration

protected void validate()

Explicit Interface Implementations

addDestination(string)

Declaration

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

Parameters

Type	Name	Description
string	phoneNumber

Returns

Type	Description
NumberAddInfo

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

Parameters

Type	Name	Description
string	phoneNumber

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)]
bool removeDestination(string phoneNumber)

Parameters

Type	Name	Description
string	phoneNumber

Returns

Type	Description
bool

removeDestinationById(string)

Declaration

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

Parameters

Type	Name	Description
string	messageId

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 messageId, string newPhoneNumber)

Parameters

Type	Name	Description
string	messageId
string	newPhoneNumber

Returns

Type	Description
bool

Implements

IComposer