com.objectxp.mms
Interface MMSReport

All Known Subinterfaces:

MM7DeliveryReport, MM7ReadReport, MMSDeliveryReport, MMSReadReport

public interface MMSReport

Base interface for MMS read- and delivery reports.

MMS provides two types of reports:

• Read Reports
• Delivery Reports

If a multimedia message has been delivered to its destination, the MMSC sends a Delivery Report to the originating sender. Likewise, if a multimedia message has been read by the recipient, a Read Report is returned to the sender.

Please note that you must enable reception of reports by calling the setDeliveryReport(true) and/or setReadReport(true) methods on the MMS Message before sending it.

Notice: Provisioning of a Read Report is up to the recipient of the multimedia message. Most MMS capable mobile phones will not provide a Read Report.

MMS Reports are passed to your application through the MMSListener interface. When a MMSService receives a Delivery Report from the MMSC, it will pass the report to your MMSListener implementation (provided that you have registered your listener with the service using the MMSService#setListener method).

Since:

jSMS 2.2

See Also:

MMSListener.handleReadReport(MMSService, MMSReadReport), MMSListener.handleDeliveryReport(MMSService, MMSDeliveryReport)

Method Summary

java.lang.String	getApplicationId() Identification of the application this read report is intended for.
java.lang.String	getAuxApplicationInfo() Auxiliary application information for internal use of the destination application.
java.util.Date	getDate() Get the Date and time the message was handled (fetched, expired, etc.) by the recipient or MMS Proxy-Relay
java.lang.String	getMessageId() This is the ID of the corresponding multimedia-message.
java.lang.String	getReplyApplicationId() Identification of a 'reply path' to this read report.
MMSAddress	getTO() Get the address of the recipient to whom the original message was delivered.

Method Detail

getMessageId

public java.lang.String getMessageId()

This is the ID of the corresponding multimedia-message. The ID can be used to match delivery reports with previously sent messages.

Returns:

the message ID.

getTO

public MMSAddress getTO()

Get the address of the recipient to whom the original message was delivered.

Returns:

the recipient address (if available).

getDate

public java.util.Date getDate()

Get the Date and time the message was handled (fetched, expired, etc.) by the recipient or MMS Proxy-Relay

getApplicationId

public java.lang.String getApplicationId()

Identification of the application this read report is intended for.

Returns:

the application ID or null if not available.

getReplyApplicationId

public java.lang.String getReplyApplicationId()

Identification of a 'reply path' to this read report.

Returns:

reply path identification or null if not available.

getAuxApplicationInfo

public java.lang.String getAuxApplicationInfo()

Auxiliary application information for internal use of the destination application.

Returns:

the auxiliary information or null if not available.