com.objectxp.msg.smart
Class Ringtone

java.lang.Object
  com.objectxp.msg.Message
      com.objectxp.msg.SmsMessage
          com.objectxp.msg.smart.SmartMessage
              com.objectxp.msg.smart.Ringtone

All Implemented Interfaces:

MultiPartMessage, java.io.Serializable, java.lang.Cloneable

public class Ringtone
extends SmartMessage

This class represents a Ringtone for SmartMessaging enabled phones. The Ringtone must be passed in RTX-Format. The Class converts the ringtone definition into a bitstring as described in Nokia's SmartMessaging® V3.0 - specification.

Example:

 ...
 SmsService service = new GsmSmsService();
 ...
 Ringtone rt = new Ringtone();
 rt.setRecipient("+41987654321");
 rt.setSender("+41123456789");
 rt.setMessage("Easy:d=4,o=5,b=63:8g4,32g,32d,32g,32g,32d,2p");

 service.sendMessage(rt);
 ...
 

See Also:

Serialized Form

Nested Class Summary

class

Ringtone.Note

Field Summary

Fields inherited from class com.objectxp.msg.SmsMessage

CLASS_0, CLASS_1, CLASS_2, CLASS_3, DC_8BIT, DC_DEFAULT, DC_GROUP_DATA, DC_GROUP_GENERAL, DC_GROUP_MSG_WAITING_DISCARD, DC_GROUP_MSG_WAITING_STORE, DC_UCS2, INDICATION_ACTIVE, INDICATION_INACTIVE, INDICATION_TYPE_EMAIL, INDICATION_TYPE_FAX, INDICATION_TYPE_OTHER, INDICATION_TYPE_VOICEMAIL, NO_CLASS

Fields inherited from class com.objectxp.msg.Message

ACK_TIME, MT_BINARY, MT_STATUS, MT_TEXT, SENDER_TYPE_ALPHA, SENDER_TYPE_GUESS, SENDER_TYPE_NUMBER

Constructor Summary

Ringtone()
Create a empty Ringtone SmartMessage.

Ringtone(byte[] data)
Create a new ringtone.

Ringtone(SmsService service)
Deprecated. since jSMS 1.7, use Ringtone()

Ringtone(SmsService service, java.lang.String rtx)
Deprecated. since jSMS 1.7, use Ringtone(String)

Ringtone(java.lang.String rtx)
Create a new Ringtone SmartMessage.

Method Summary

java.lang.String	getMessage() This method returns the Ringtone in RTX format or null if no RTX tone has ben set yet.
java.lang.String	getRtx() Deprecated. since jSMS 2.1.3, use getMessage()
void	setMessage(java.lang.String rtx) Sets the ringtone to to send to a mobile recipient.
java.lang.String	toString() Constructs a string representation of this Message

Methods inherited from class com.objectxp.msg.smart.SmartMessage

buildParts, buildParts, getParts

Methods inherited from class com.objectxp.msg.SmsMessage

containsUserDataHeader, copyFields, getAlphabet, getBytes, getCodingGroup, getDeferredDeliveryAsDate, getDeferredDeliveryInMinutes, getID, getIndicationState, getIndicationType, getMessageClass, getParent, getPID, getRecipient, getRecipientAddress, getSender, getSenderAddress, getType, getUserData, getUserDataHeader, getValidityPeriodAsDate, getValidityPeriodInMinutes, hasDeferredDelivery, hasMessageClass, hasValidityPeriod, isCompressed, isMMS, isRejectDuplicates, isRelativeDeferredDelivery, isRelativeValidityPeriod, isReplyPath, requestStatusReport, requestStatusReport, setAlphabet, setCodingGroup, setCompression, setDeferredDelivery, setDeferredDelivery, setIndicationState, setIndicationType, setMessage, setMessageClass, setMMS, setParent, setPID, setRecipient, setRecipientAddress, setRejectDuplicates, setReplyPath, setSender, setSenderAddress, setType, setUserData, setUserDataHeader, setUserDataHeader, setValidityPeriod, setValidityPeriod

Methods inherited from class com.objectxp.msg.Message

clone, getProperty, getSenderType, getTimestamp, setID, setProperty, setSenderType

Methods inherited from class java.lang.Object

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

Constructor Detail

Ringtone

public Ringtone()

Create a empty Ringtone SmartMessage. The Ringtone can be set by calling setMessage().

Since:

jSMS 1.7

Ringtone

public Ringtone(SmsService service)
         throws java.lang.IllegalArgumentException

Deprecated. since jSMS 1.7, use Ringtone()

Create a empty Ringtone SmartMessage. The Ringtone can be set by calling setMessage().

Throws:

java.lang.IllegalArgumentException

Ringtone

public Ringtone(java.lang.String rtx)

Create a new Ringtone SmartMessage.

Parameters:

rtx - the ringtone in RTX-Format.

Ringtone

public Ringtone(byte[] data)

Create a new ringtone. The byte[] passed to this constructor must be in the format defined in the Smart Messaging specification Revision 3.0.0. The ringtone will be converted to the RTX format and can be retrieved by calling @link #getRtx().

Please Note that only Temporary and Basic Song Types are supported.

Parameters:

data - the ringing tone data.

Throws:

java.lang.IllegalArgumentException - if the ringtone data cannot be parsed.

Ringtone

public Ringtone(SmsService service,
                java.lang.String rtx)

Deprecated. since jSMS 1.7, use Ringtone(String)

Create a new Ringtone SmartMessage.

Parameters:

rtx - the ringtone in RTX-Format.

Method Detail

setMessage

public void setMessage(java.lang.String rtx)

Sets the ringtone to to send to a mobile recipient. The ringtone must be in RTX format (Extended Ringtone Format) and will be converted to a bitstring as defined in Nokia's SmartMessaging-Specification.

Overrides:

setMessage in class SmsMessage

Parameters:

rtx - the ringtone in RTX-Format.

getMessage

public java.lang.String getMessage()

This method returns the Ringtone in RTX format or null if no RTX tone has ben set yet.

Overrides:

getMessage in class SmsMessage

Returns:

the User Data converted to a String object.

See Also:

SmsMessage.getUserData()

getRtx

public java.lang.String getRtx()

Deprecated. since jSMS 2.1.3, use getMessage()

Returns the ringtone in RTX-Format.

toString

public java.lang.String toString()

Description copied from class: Message

Constructs a string representation of this Message

Overrides:

toString in class SmsMessage