Send UI API: API Description

Send UI API is a library API. It offers a simple way to incorporate messaging functionality into an application. It is not part of the Messaging architecture but provides an interface to available messaging MTMs and appropriate ECom plug-ins.

Use cases

The most important use cases of the Send UI API are the following:

• Creating an instance of CSendUi
• Creating a message to be sent
• Displaying a list of available messaging services for the user to choose from
• Sending a message using a specified MTM
• Validating a message service
• Launching a messaging editor to allow the user to complete and send a message

API Class structure

The main class of the SendUI API is called CSendUi. Each consumer application should create an instance of that class in order to launch the messaging functionality provided through this API. It also defines a class, CMessageData, to encapsulate the message data to be sent, while CMessageAddress encapsulates recipient details.

CServiceInfo encapsulates an ECom sending service, allowing information such as the name of the service and its capabilities to be retrieved.

TSendingCapabilities has public member data members that are used to define the capabilities of a service in terms of message attributes.

The classes of the Send UI API are shown in Figure 1: