com.objectxp.msg.ems
Class EMSUserPromptIndicator

java.lang.Object
  com.objectxp.msg.ems.EMSElement
      com.objectxp.msg.ems.EMSUserPromptIndicator

All Implemented Interfaces:

java.io.Serializable

public class EMSUserPromptIndicator
extends EMSElement

This class represents a EMS User Prompt Indicator. The User Prompt Indicator (UPI) makes it possible for content providers to create so called Download Messages which can include EMS objects that are larger than would fit in a normal EMS message.

The UPI indicator may be assigned to the following EMS elements:

• User-defined pictures; small, large or variable size
• Melodies

The user stores the object received in the Download message, in the usual storage location for the object type. The object can be used, for example, as a background picture or as a ring signal in the phone.

The object can be split over several Short Messages in a Concatenated Message. When all parts are received, the phone assembles the object automatically without user interaction. This is referred to as stitching.

Note: It is important to see the difference of Concatenated Messages with and without the use of UPI. For example, no single EMS element in a Concatenated Message without UPI can be larger than to fit in a single message segment. However, the use of UPI allows phone users to download one large object which is assembled from all the segments of a Concatenated Message.

Since:

jSMS 1.7

See Also:

EMSMessage, Serialized Form

Constructor Summary

EMSUserPromptIndicator(EMSElement element)
Construct a new EMS User Prompt Indicator.

Method Summary

void	add(EMSElement element) Add another EMS element.
java.lang.String	toString()

Methods inherited from class java.lang.Object

equals, getClass, hashCode, notify, notifyAll, wait, wait, wait

Constructor Detail

EMSUserPromptIndicator

public EMSUserPromptIndicator(EMSElement element)
                       throws java.lang.IllegalArgumentException

Construct a new EMS User Prompt Indicator.

Parameters:

element - the element for download

Throws:

java.lang.IllegalArgumentException - if the element is null or not a EMSSound or EMSPicture.

Method Detail

add

public void add(EMSElement element)
         throws java.lang.IllegalArgumentException

Add another EMS element.

Throws:

java.lang.IllegalArgumentException - if the element is null, not a EMSSound or EMSPicture or not all elements for this UPI are the same type.

toString

public java.lang.String toString()

Overrides:

toString in class java.lang.Object