net.rim.device.api.system
Class SMSParameters

java.lang.Object
  net.rim.device.api.system.SMSParameters

Direct Known Subclasses:

SMSPacketHeader

public class SMSParameters
extends Object

SMS parameters. See GSM 03.40 for details.

Since:

BlackBerry API 4.0.0

Field Summary
static int	LANGUAGE_CHINESE Chinese language.
static int	LANGUAGE_ENGLISH English language.
static int	LANGUAGE_FRENCH French language.
static int	LANGUAGE_HEBREW Hebrew language.
static int	LANGUAGE_JAPANESE Japanese language.
static int	LANGUAGE_KOREAN Korean language.
static int	LANGUAGE_NONE No language.
static int	LANGUAGE_SPANISH Spanish language.
static int	LANGUAGE_UNSPECIFIED Unspecified language.
static int	MESSAGE_CLASS_0 Message class 0.
static int	MESSAGE_CLASS_1 Message class 1.
static int	MESSAGE_CLASS_2 Message class 2.
static int	MESSAGE_CLASS_3 Message class 3.
static int	MESSAGE_CLASS_NOT_GIVEN Unspecified message class.
static int	MESSAGE_CODING_8_BIT 8-bit (user-defined) message coding.
static int	MESSAGE_CODING_ASCII ASCII message coding.
static int	MESSAGE_CODING_DEFAULT Default message coding.
static int	MESSAGE_CODING_ISO8859_1 ISO 8859-1 coding.
static int	MESSAGE_CODING_KOREAN_KSX1001 KSX1001 (KSC5601) message coding.
static int	MESSAGE_CODING_UCS2 UCS2 message coding.
static int	NUM_ABBREVIATED Abbreviated number.
static int	NUM_ALPHANUMERIC Alphanumeric number.
static int	NUM_EMAIL Email address.
static int	NUM_INTERNATIONAL International number.
static int	NUM_NATIONAL Intra-national number.
static int	NUM_NETWORK_SPEC Network specifcation number.
static int	NUM_RESERVED Reserved number.
static int	NUM_SUBSCRIBER Subscriber number.
static int	NUM_UNKNOWN Unknown number.
static int	PERIOD_IMMEDIATE "Immediate" validity/delivery period.
static int	PERIOD_INDEFINITE "Indefinite" validity/delivery period.
static int	PERIOD_TILL_ACTIVE "TILL active" validity/delivery period.
static int	PERIOD_TILL_AREA "TILL area" validity/delivery period.
static int	PLAN_DATA Data plan.
static int	PLAN_ERMES ERMES plan.
static int	PLAN_ISDN ISDN plan.
static int	PLAN_NATIONAL National plan.
static int	PLAN_PRIVATE Private plan.
static int	PLAN_RESERVED Reserved plan.
static int	PLAN_TELEX TELEX plan.
static int	PLAN_UNKNOWN Unknown plan.
static int	PRIORITY_EMERGENCY Emergency message priority.
static int	PRIORITY_INTERACTIVE Interactive message priority.
static int	PRIORITY_NONE No message priority.
static int	PRIORITY_NORMAL Normal message priority.
static int	PRIORITY_URGENT Urgent message priority.
static int	PRIVACY_CONFIDENTIAL Confidential privacy level.
static int	PRIVACY_NONE No privacy level.
static int	PRIVACY_NORMAL Normal privacy level.
static int	PRIVACY_RESTRICTED Restricted privacy level.
static int	PRIVACY_SECRET Secret privacy level.
static int	PROTOCOL_ID_CSPDN_TELETEX CSPDN teletex protocl ID.
static int	PROTOCOL_ID_DEPERSONALIZATION_SM De-personalization SM protocol ID.
static int	PROTOCOL_ID_ERMES ERMES protocol ID.
static int	PROTOCOL_ID_GRP3_FAX Group 3 fax protocol ID.
static int	PROTOCOL_ID_GRP4_FAX Group 4 fax protocol ID.
static int	PROTOCOL_ID_GSM_MS GSM/MS protocol ID.
static int	PROTOCOL_ID_IMPLICIT Implicit protocol ID.
static int	PROTOCOL_ID_INTERNET_EMAIL Internet email protocol ID.
static int	PROTOCOL_ID_ISDN_TELETEX ISDN teletex protocol ID.
static int	PROTOCOL_ID_MSG_HANDLING Message handling protocol ID.
static int	PROTOCOL_ID_NAT_PAGING NAT paging protocol ID.
static int	PROTOCOL_ID_PSPDN_TELETEX PSPDN teletex protocol ID.
static int	PROTOCOL_ID_PSTN_TELETEX PSTN teletex protocol ID.
static int	PROTOCOL_ID_REPLACE_SM_TYPE1 Replace SM type 1 protocol ID.
static int	PROTOCOL_ID_REPLACE_SM_TYPE2 Replace SM type 2 protocol ID.
static int	PROTOCOL_ID_REPLACE_SM_TYPE3 Replace SM type 3 protocol ID.
static int	PROTOCOL_ID_REPLACE_SM_TYPE4 Replace SM type 4 protocol ID.
static int	PROTOCOL_ID_REPLACE_SM_TYPE5 Replace SM type 5 protocol ID.
static int	PROTOCOL_ID_REPLACE_SM_TYPE6 Replace SM type 6 protocol ID.
static int	PROTOCOL_ID_REPLACE_SM_TYPE7 Replace SM type 7 protocol ID.
static int	PROTOCOL_ID_RETURN_CALL_MSG Return call message protocol ID.
static int	PROTOCOL_ID_SC_SPECIFIC_1 SC-specific protocol ID.
static int	PROTOCOL_ID_SC_SPECIFIC_2 SC-specific protocol ID.
static int	PROTOCOL_ID_SC_SPECIFIC_3 SC-specific protocol ID.
static int	PROTOCOL_ID_SC_SPECIFIC_4 SC-specific protocol ID.
static int	PROTOCOL_ID_SC_SPECIFIC_5 SC-specific protocol ID.
static int	PROTOCOL_ID_SC_SPECIFIC_6 SC-specific protocol ID.
static int	PROTOCOL_ID_SC_SPECIFIC_7 SC-specific protocol ID.
static int	PROTOCOL_ID_SIM_DATA_DOWNLOAD SIM data download protocol ID.
static int	PROTOCOL_ID_SM_TYPE0 SM type 0 protocol ID.
static int	PROTOCOL_ID_TELEX Telex protocol ID.
static int	PROTOCOL_ID_UCI UCI protocol ID.
static int	PROTOCOL_ID_UNSPEC_TELETEX Unspecified teletex protocol ID.
static int	PROTOCOL_ID_VIDEOTEX Videotex protocol ID.
static int	PROTOCOL_ID_VOICE Voice protocol ID.
static int	PROTOCOL_ID_X400 X400 protocol ID.
static int	PROTOCOL_MEANING_RAW_DATA Protocol meaning raw data.
static int	PROTOCOL_MEANING_RESERVED Protocol meaning reserved.
static int	PROTOCOL_MEANING_SC_SPECIFIC Protocol meaning SC specific.
static int	PROTOCOL_MEANING_SM_AL_PROTOCOL Protocol meaning SM/AL protocol.
static int	PROTOCOL_MEANING_SM_FUNCTIONS Protocol meaning SM functions.
static int	PROTOCOL_MEANING_TELEMATIC_INTERWORK Protocol meaning telematic interwork.

Constructor Summary

SMSParameters()
Constructs a new SMSParameters instance.

Method Summary
String	getCallbackAddress() Retrieves the callback address.
int	getCallbackPlan() Retrieves the callback numbering plan.
int	getCallbackType() Retrieves the callback type of number.
int	getDeliveryPeriod() Retrieves the delivery period.
int	getLanguage() Retrieves the language used.
int	getMessageClass() Retrieves the message class.
int	getMessageCoding() Retrieves the message coding.
String	getPeerAddress() Retrieves the peer user's address.
int	getPeerPlan() Retrieves the peer user's plan type.
int	getPeerType() Retrieves the peer user's type.
int	getPriority() Retrieves the priority of the message.
int	getPrivacy() Retrieves the privacy setting.
int	getProtocolId() Retrieves the protocol ID for these parameters.
int	getProtocolMeaning() Retrieves the protocol meaning for these parameters.
String	getSCAddress() Retrieves the service centre address.
int	getSCPlan() Retrieves the service centre number plan.
int	getSCType() Retrieves the service centre number type.
int	getValidityPeriod() Retrieves the validity period.
void	reset() Resets these parameters to default values.
void	setCallbackAddress(String callbackAddress) Sets the callback address.
void	setCallbackAddress(String callbackAddress, int callbackType, int callbackPlan) Sets the callback address, type, and plan.
void	setDeliveryPeriod(int deliveryPeriod) Sets the delivery period for the message.
void	setLanguage(int language) Sets the language for the message.
void	setMessageClass(int messageClass) Sets the message class.
void	setMessageCoding(int messageCoding) Sets the message coding.
void	setPeerAddress(String peerAddress) Sets the peer user's address.
void	setPeerAddress(String peerAddress, int peerType, int peerPlan) Sets the peer user's address, type, and plan.
void	setPriority(int priority) Sets the priority for the message.
void	setPrivacy(int privacy) Sets the privacy for the message.
void	setProtocolId(int protocolId) Sets the protocol ID for these parameters.
void	setProtocolMeaning(int protocolMeaning) Sets the protocol meaning for these parameters.
void	setSCAddress(String scAddress) Sets the service centre address.
void	setSCAddress(String scAddress, int scType, int scPlan) Sets the service centre's address, type, and plan.
void	setValidityPeriod(int validityPeriod) Sets the validity period for the message.

Methods inherited from class java.lang.Object

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

Field Detail

NUM_UNKNOWN

public static final int NUM_UNKNOWN

Unknown number.

See Also:

Constant Field Values

Since:

BlackBerry API 4.0.0

NUM_INTERNATIONAL

public static final int NUM_INTERNATIONAL

International number.

See Also:

Constant Field Values

Since:

BlackBerry API 4.0.0

NUM_NATIONAL

public static final int NUM_NATIONAL

Intra-national number.

See Also:

Constant Field Values

Since:

BlackBerry API 4.0.0

NUM_NETWORK_SPEC

public static final int NUM_NETWORK_SPEC

Network specifcation number.

See Also:

Constant Field Values

Since:

BlackBerry API 4.0.0

NUM_SUBSCRIBER

public static final int NUM_SUBSCRIBER

Subscriber number.

See Also:

Constant Field Values

Since:

BlackBerry API 4.0.0

NUM_ALPHANUMERIC

public static final int NUM_ALPHANUMERIC

Alphanumeric number.

See Also:

Constant Field Values

Since:

BlackBerry API 4.0.0

NUM_ABBREVIATED

public static final int NUM_ABBREVIATED

Abbreviated number.

See Also:

Constant Field Values

Since:

BlackBerry API 4.0.0

NUM_RESERVED

public static final int NUM_RESERVED

Reserved number.

See Also:

Constant Field Values

Since:

BlackBerry API 4.0.0

NUM_EMAIL

public static final int NUM_EMAIL

Email address.

See Also:

Constant Field Values

Since:

BlackBerry API 4.0.2

PLAN_UNKNOWN

public static final int PLAN_UNKNOWN

Unknown plan.

See Also:

Constant Field Values

Since:

BlackBerry API 4.0.0

PLAN_ISDN

public static final int PLAN_ISDN

ISDN plan.

See Also:

Constant Field Values

Since:

BlackBerry API 4.0.0

PLAN_DATA

public static final int PLAN_DATA

Data plan.

See Also:

Constant Field Values

Since:

BlackBerry API 4.0.0

PLAN_TELEX

public static final int PLAN_TELEX

TELEX plan.

See Also:

Constant Field Values

Since:

BlackBerry API 4.0.0

PLAN_NATIONAL

public static final int PLAN_NATIONAL

National plan.

See Also:

Constant Field Values

Since:

BlackBerry API 4.0.0

PLAN_PRIVATE

public static final int PLAN_PRIVATE

Private plan.

See Also:

Constant Field Values

Since:

BlackBerry API 4.0.0

PLAN_ERMES

public static final int PLAN_ERMES

ERMES plan.

See Also:

Constant Field Values

Since:

BlackBerry API 4.0.0

PLAN_RESERVED

public static final int PLAN_RESERVED

Reserved plan.

See Also:

Constant Field Values

Since:

BlackBerry API 4.0.0

PROTOCOL_MEANING_SM_AL_PROTOCOL

public static final int PROTOCOL_MEANING_SM_AL_PROTOCOL

Protocol meaning SM/AL protocol.

See Also:

Constant Field Values

Since:

BlackBerry API 4.0.0

PROTOCOL_MEANING_TELEMATIC_INTERWORK

public static final int PROTOCOL_MEANING_TELEMATIC_INTERWORK

Protocol meaning telematic interwork.

See Also:

Constant Field Values

Since:

BlackBerry API 4.0.0

PROTOCOL_MEANING_SM_FUNCTIONS

public static final int PROTOCOL_MEANING_SM_FUNCTIONS

Protocol meaning SM functions.

See Also:

Constant Field Values

Since:

BlackBerry API 4.0.0

PROTOCOL_MEANING_RESERVED

public static final int PROTOCOL_MEANING_RESERVED

Protocol meaning reserved.

See Also:

Constant Field Values

Since:

BlackBerry API 4.0.0

PROTOCOL_MEANING_SC_SPECIFIC

public static final int PROTOCOL_MEANING_SC_SPECIFIC

Protocol meaning SC specific.

See Also:

Constant Field Values

Since:

BlackBerry API 4.0.0

PROTOCOL_MEANING_RAW_DATA

public static final int PROTOCOL_MEANING_RAW_DATA

Protocol meaning raw data.

See Also:

Constant Field Values

Since:

BlackBerry API 4.0.0

PROTOCOL_ID_IMPLICIT

public static final int PROTOCOL_ID_IMPLICIT

Implicit protocol ID.

See Also:

Constant Field Values

Since:

BlackBerry API 4.0.0

PROTOCOL_ID_TELEX

public static final int PROTOCOL_ID_TELEX

Telex protocol ID.

See Also:

Constant Field Values

Since:

BlackBerry API 4.0.0

PROTOCOL_ID_GRP3_FAX

public static final int PROTOCOL_ID_GRP3_FAX

Group 3 fax protocol ID.

See Also:

Constant Field Values

Since:

BlackBerry API 4.0.0

PROTOCOL_ID_GRP4_FAX

public static final int PROTOCOL_ID_GRP4_FAX

Group 4 fax protocol ID.

See Also:

Constant Field Values

Since:

BlackBerry API 4.0.0

PROTOCOL_ID_VOICE

public static final int PROTOCOL_ID_VOICE

Voice protocol ID.

See Also:

Constant Field Values

Since:

BlackBerry API 4.0.0

PROTOCOL_ID_ERMES

public static final int PROTOCOL_ID_ERMES

ERMES protocol ID.

See Also:

Constant Field Values

Since:

BlackBerry API 4.0.0

PROTOCOL_ID_NAT_PAGING

public static final int PROTOCOL_ID_NAT_PAGING

NAT paging protocol ID.

See Also:

Constant Field Values

Since:

BlackBerry API 4.0.0

PROTOCOL_ID_VIDEOTEX

public static final int PROTOCOL_ID_VIDEOTEX

Videotex protocol ID.

See Also:

Constant Field Values

Since:

BlackBerry API 4.0.0

PROTOCOL_ID_UNSPEC_TELETEX

public static final int PROTOCOL_ID_UNSPEC_TELETEX

Unspecified teletex protocol ID.

See Also:

Constant Field Values

Since:

BlackBerry API 4.0.0

PROTOCOL_ID_PSPDN_TELETEX

public static final int PROTOCOL_ID_PSPDN_TELETEX

PSPDN teletex protocol ID.

See Also:

Constant Field Values

Since:

BlackBerry API 4.0.0

PROTOCOL_ID_CSPDN_TELETEX

public static final int PROTOCOL_ID_CSPDN_TELETEX

CSPDN teletex protocl ID.

See Also:

Constant Field Values

Since:

BlackBerry API 4.0.0

PROTOCOL_ID_PSTN_TELETEX

public static final int PROTOCOL_ID_PSTN_TELETEX

PSTN teletex protocol ID.

See Also:

Constant Field Values

Since:

BlackBerry API 4.0.0

PROTOCOL_ID_ISDN_TELETEX

public static final int PROTOCOL_ID_ISDN_TELETEX

ISDN teletex protocol ID.

See Also:

Constant Field Values

Since:

BlackBerry API 4.0.0

PROTOCOL_ID_UCI

public static final int PROTOCOL_ID_UCI

UCI protocol ID.

See Also:

Constant Field Values

Since:

BlackBerry API 4.0.0

PROTOCOL_ID_MSG_HANDLING

public static final int PROTOCOL_ID_MSG_HANDLING

Message handling protocol ID.

See Also:

Constant Field Values

Since:

BlackBerry API 4.0.0

PROTOCOL_ID_X400

public static final int PROTOCOL_ID_X400

X400 protocol ID.

See Also:

Constant Field Values

Since:

BlackBerry API 4.0.0

PROTOCOL_ID_INTERNET_EMAIL

public static final int PROTOCOL_ID_INTERNET_EMAIL

Internet email protocol ID.

See Also:

Constant Field Values

Since:

BlackBerry API 4.0.0

PROTOCOL_ID_SC_SPECIFIC_1

public static final int PROTOCOL_ID_SC_SPECIFIC_1

SC-specific protocol ID.

See Also:

Constant Field Values

Since:

BlackBerry API 4.0.0

PROTOCOL_ID_SC_SPECIFIC_2

public static final int PROTOCOL_ID_SC_SPECIFIC_2

SC-specific protocol ID.

See Also:

Constant Field Values

Since:

BlackBerry API 4.0.0

PROTOCOL_ID_SC_SPECIFIC_3

public static final int PROTOCOL_ID_SC_SPECIFIC_3

SC-specific protocol ID.

See Also:

Constant Field Values

Since:

BlackBerry API 4.0.0

PROTOCOL_ID_SC_SPECIFIC_4

public static final int PROTOCOL_ID_SC_SPECIFIC_4

SC-specific protocol ID.

See Also:

Constant Field Values

Since:

BlackBerry API 4.0.0

PROTOCOL_ID_SC_SPECIFIC_5

public static final int PROTOCOL_ID_SC_SPECIFIC_5

SC-specific protocol ID.

See Also:

Constant Field Values

Since:

BlackBerry API 4.0.0

PROTOCOL_ID_SC_SPECIFIC_6

public static final int PROTOCOL_ID_SC_SPECIFIC_6

SC-specific protocol ID.

See Also:

Constant Field Values

Since:

BlackBerry API 4.0.0

PROTOCOL_ID_SC_SPECIFIC_7

public static final int PROTOCOL_ID_SC_SPECIFIC_7

SC-specific protocol ID.

See Also:

Constant Field Values

Since:

BlackBerry API 4.0.0

PROTOCOL_ID_GSM_MS

public static final int PROTOCOL_ID_GSM_MS

GSM/MS protocol ID.

See Also:

Constant Field Values

Since:

BlackBerry API 4.0.0

PROTOCOL_ID_SM_TYPE0

public static final int PROTOCOL_ID_SM_TYPE0

SM type 0 protocol ID.

See Also:

Constant Field Values

Since:

BlackBerry API 4.0.0

PROTOCOL_ID_REPLACE_SM_TYPE1

public static final int PROTOCOL_ID_REPLACE_SM_TYPE1

Replace SM type 1 protocol ID.

See Also:

Constant Field Values

Since:

BlackBerry API 4.0.0

PROTOCOL_ID_REPLACE_SM_TYPE2

public static final int PROTOCOL_ID_REPLACE_SM_TYPE2

Replace SM type 2 protocol ID.

See Also:

Constant Field Values

Since:

BlackBerry API 4.0.0

PROTOCOL_ID_REPLACE_SM_TYPE3

public static final int PROTOCOL_ID_REPLACE_SM_TYPE3

Replace SM type 3 protocol ID.

See Also:

Constant Field Values

Since:

BlackBerry API 4.0.0

PROTOCOL_ID_REPLACE_SM_TYPE4

public static final int PROTOCOL_ID_REPLACE_SM_TYPE4

Replace SM type 4 protocol ID.

See Also:

Constant Field Values

Since:

BlackBerry API 4.0.0

PROTOCOL_ID_REPLACE_SM_TYPE5

public static final int PROTOCOL_ID_REPLACE_SM_TYPE5

Replace SM type 5 protocol ID.

See Also:

Constant Field Values

Since:

BlackBerry API 4.0.0

PROTOCOL_ID_REPLACE_SM_TYPE6

public static final int PROTOCOL_ID_REPLACE_SM_TYPE6

Replace SM type 6 protocol ID.

See Also:

Constant Field Values

Since:

BlackBerry API 4.0.0

PROTOCOL_ID_REPLACE_SM_TYPE7

public static final int PROTOCOL_ID_REPLACE_SM_TYPE7

Replace SM type 7 protocol ID.

See Also:

Constant Field Values

Since:

BlackBerry API 4.0.0

PROTOCOL_ID_RETURN_CALL_MSG

public static final int PROTOCOL_ID_RETURN_CALL_MSG

Return call message protocol ID.

See Also:

Constant Field Values

Since:

BlackBerry API 4.0.0

PROTOCOL_ID_DEPERSONALIZATION_SM

public static final int PROTOCOL_ID_DEPERSONALIZATION_SM

De-personalization SM protocol ID.

See Also:

Constant Field Values

Since:

BlackBerry API 4.0.0

PROTOCOL_ID_SIM_DATA_DOWNLOAD

public static final int PROTOCOL_ID_SIM_DATA_DOWNLOAD

SIM data download protocol ID.

See Also:

Constant Field Values

Since:

BlackBerry API 4.0.0

PERIOD_IMMEDIATE

public static final int PERIOD_IMMEDIATE

"Immediate" validity/delivery period.

See Also:

Constant Field Values

Since:

BlackBerry API 4.0.0

PERIOD_INDEFINITE

public static final int PERIOD_INDEFINITE

"Indefinite" validity/delivery period.

See Also:

Constant Field Values

Since:

BlackBerry API 4.0.0

PERIOD_TILL_ACTIVE

public static final int PERIOD_TILL_ACTIVE

"TILL active" validity/delivery period.

See Also:

Constant Field Values

Since:

BlackBerry API 4.0.0

PERIOD_TILL_AREA

public static final int PERIOD_TILL_AREA

"TILL area" validity/delivery period.

See Also:

Constant Field Values

Since:

BlackBerry API 4.0.0

MESSAGE_CODING_DEFAULT

public static final int MESSAGE_CODING_DEFAULT

Default message coding.

The message is coded using the default 7-bit GSM alphabet, and can consist of up to 160 characters.

See Also:

Constant Field Values

Since:

BlackBerry API 4.0.0

MESSAGE_CODING_8_BIT

public static final int MESSAGE_CODING_8_BIT

8-bit (user-defined) message coding.

The message has user-defined coding, and can consist of up to 140 bytes.

See Also:

Constant Field Values

Since:

BlackBerry API 4.0.0

MESSAGE_CODING_UCS2

public static final int MESSAGE_CODING_UCS2

UCS2 message coding.

The message is coded using the UCS2 alphabet, and can consist of up to 70 UCS2 characters.

See Also:

Constant Field Values

Since:

BlackBerry API 4.0.0

MESSAGE_CODING_KOREAN_KSX1001

public static final int MESSAGE_CODING_KOREAN_KSX1001

KSX1001 (KSC5601) message coding.

The message is coded using the Korean alphabet, and can consist of up to 70 characters.

See Also:

Constant Field Values

Since:

BlackBerry API 4.3.0

MESSAGE_CODING_ASCII

public static final int MESSAGE_CODING_ASCII

ASCII message coding.

The message is coded using 7-bit ASCII, and can consist of up to 160 characters.

See Also:

Constant Field Values

Since:

BlackBerry API 4.0.0

MESSAGE_CODING_ISO8859_1

public static final int MESSAGE_CODING_ISO8859_1

ISO 8859-1 coding.

The message is coded using the 8-bit IS0 8859-1 Latin alphabet, and can consist of up to 160 characters.

See Also:

Constant Field Values

Since:

BlackBerry API 4.0.0

MESSAGE_CLASS_0

public static final int MESSAGE_CLASS_0

Message class 0.

See Also:

Constant Field Values

Since:

BlackBerry API 4.0.0

MESSAGE_CLASS_1

public static final int MESSAGE_CLASS_1

Message class 1.

See Also:

Constant Field Values

Since:

BlackBerry API 4.0.0

MESSAGE_CLASS_2

public static final int MESSAGE_CLASS_2

Message class 2.

See Also:

Constant Field Values

Since:

BlackBerry API 4.0.0

MESSAGE_CLASS_3

public static final int MESSAGE_CLASS_3

Message class 3.

See Also:

Constant Field Values

Since:

BlackBerry API 4.0.0

MESSAGE_CLASS_NOT_GIVEN

public static final int MESSAGE_CLASS_NOT_GIVEN

Unspecified message class.

See Also:

Constant Field Values

Since:

BlackBerry API 4.0.0

PRIORITY_NORMAL

public static final int PRIORITY_NORMAL

Normal message priority.

See Also:

Constant Field Values

Since:

BlackBerry API 4.0.0

PRIORITY_INTERACTIVE

public static final int PRIORITY_INTERACTIVE

Interactive message priority.

See Also:

Constant Field Values

Since:

BlackBerry API 4.0.0

PRIORITY_URGENT

public static final int PRIORITY_URGENT

Urgent message priority.

See Also:

Constant Field Values

Since:

BlackBerry API 4.0.0

PRIORITY_EMERGENCY

public static final int PRIORITY_EMERGENCY

Emergency message priority.

See Also:

Constant Field Values

Since:

BlackBerry API 4.0.0

PRIORITY_NONE

public static final int PRIORITY_NONE

No message priority.

See Also:

Constant Field Values

Since:

BlackBerry API 4.0.0

PRIVACY_NORMAL

public static final int PRIVACY_NORMAL

Normal privacy level.

See Also:

Constant Field Values

Since:

BlackBerry API 4.0.0

PRIVACY_RESTRICTED

public static final int PRIVACY_RESTRICTED

Restricted privacy level.

See Also:

Constant Field Values

Since:

BlackBerry API 4.0.0

PRIVACY_CONFIDENTIAL

public static final int PRIVACY_CONFIDENTIAL

Confidential privacy level.

See Also:

Constant Field Values

Since:

BlackBerry API 4.0.0

PRIVACY_SECRET

public static final int PRIVACY_SECRET

Secret privacy level.

See Also:

Constant Field Values

Since:

BlackBerry API 4.0.0

PRIVACY_NONE

public static final int PRIVACY_NONE

No privacy level.

See Also:

Constant Field Values

Since:

BlackBerry API 4.0.0

LANGUAGE_UNSPECIFIED

public static final int LANGUAGE_UNSPECIFIED

Unspecified language.

See Also:

Constant Field Values

Since:

BlackBerry API 4.0.0

LANGUAGE_ENGLISH

public static final int LANGUAGE_ENGLISH

English language.

See Also:

Constant Field Values

Since:

BlackBerry API 4.0.0

LANGUAGE_FRENCH

public static final int LANGUAGE_FRENCH

French language.

See Also:

Constant Field Values

Since:

BlackBerry API 4.0.0

LANGUAGE_SPANISH

public static final int LANGUAGE_SPANISH

Spanish language.

See Also:

Constant Field Values

Since:

BlackBerry API 4.0.0

LANGUAGE_JAPANESE

public static final int LANGUAGE_JAPANESE

Japanese language.

See Also:

Constant Field Values

Since:

BlackBerry API 4.0.0

LANGUAGE_KOREAN

public static final int LANGUAGE_KOREAN

Korean language.

See Also:

Constant Field Values

Since:

BlackBerry API 4.0.0

LANGUAGE_CHINESE

public static final int LANGUAGE_CHINESE

Chinese language.

See Also:

Constant Field Values

Since:

BlackBerry API 4.0.0

LANGUAGE_HEBREW

public static final int LANGUAGE_HEBREW

Hebrew language.

See Also:

Constant Field Values

Since:

BlackBerry API 4.0.0

LANGUAGE_NONE

public static final int LANGUAGE_NONE

No language.

See Also:

Constant Field Values

Since:

BlackBerry API 4.0.0

Constructor Detail

SMSParameters

public SMSParameters()

Constructs a new SMSParameters instance.

Since:

BlackBerry API 4.0.0

Method Detail

reset

public void reset()

Resets these parameters to default values.

Since:

BlackBerry API 4.0.0

getPeerAddress

public String getPeerAddress()

Retrieves the peer user's address.

Returns:

Peer address.

Since:

BlackBerry API 4.0.0

getPeerType

public int getPeerType()

Retrieves the peer user's type.

Returns:

Peer type.

Since:

BlackBerry API 4.0.0

getPeerPlan

public int getPeerPlan()

Retrieves the peer user's plan type.

One of this class's PLAN_* constants.

Returns:

Peer numbering plan.

Since:

BlackBerry API 4.0.0

setPeerAddress

public void setPeerAddress(String peerAddress)

Sets the peer user's address.

Parameters:

peerAddress - New address for the peer user.

Since:

BlackBerry API 4.0.0

setPeerAddress

public void setPeerAddress(String peerAddress,
                           int peerType,
                           int peerPlan)

Sets the peer user's address, type, and plan.

Parameters:

peerAddress - New address for the peer user.

peerType - Type for the peer user.

peerPlan - Plan type for the peer user.

Since:

BlackBerry API 4.0.0

getSCAddress

public String getSCAddress()

Retrieves the service centre address.

Returns:

Service centre address.

Since:

BlackBerry API 4.0.0

getSCType

public int getSCType()

Retrieves the service centre number type.

Returns:

Service centre number type.

Since:

BlackBerry API 4.0.0

getSCPlan

public int getSCPlan()

Retrieves the service centre number plan.

Returns:

Service centre numbering plan.

Since:

BlackBerry API 4.0.0

setSCAddress

public void setSCAddress(String scAddress)

Sets the service centre address.

Parameters:

scAddress - New service centre address.

Since:

BlackBerry API 4.0.0

setSCAddress

public void setSCAddress(String scAddress,
                         int scType,
                         int scPlan)

Sets the service centre's address, type, and plan.

Parameters:

scAddress - Service centre address.

scType - Service centre type.

scPlan - Service centre plan.

Since:

BlackBerry API 4.0.0

getProtocolMeaning

public int getProtocolMeaning()

Retrieves the protocol meaning for these parameters.

Returns:

One of the PROTOCOL_MEANING_* values.

Since:

BlackBerry API 4.0.0

setProtocolMeaning

public void setProtocolMeaning(int protocolMeaning)

Sets the protocol meaning for these parameters.

Parameters:

protocolMeaning - One of the PROTOCOL_MEANING_* values.

Since:

BlackBerry API 4.0.0

getProtocolId

public int getProtocolId()

Retrieves the protocol ID for these parameters.

Returns:

One of the PROTOCOL_ID_* values.

Since:

BlackBerry API 4.0.0

setProtocolId

public void setProtocolId(int protocolId)

Sets the protocol ID for these parameters.

Parameters:

protocolID - One of the PROTOCOL_ID_* values.

Since:

BlackBerry API 4.0.0

getMessageCoding

public int getMessageCoding()

Retrieves the message coding.

Returns:

One of the MESSAGE_CODING_* values.

Since:

BlackBerry API 4.0.0

setMessageCoding

public void setMessageCoding(int messageCoding)

Sets the message coding.

Parameters:

messageCoding - One of the MESSAGE_CODING_* values.

Since:

BlackBerry API 4.0.0

getMessageClass

public int getMessageClass()

Retrieves the message class.

Returns:

One of the MESSAGE_CLASS_* values.

Since:

BlackBerry API 4.0.0

setMessageClass

public void setMessageClass(int messageClass)

Sets the message class.

Parameters:

messageClass - One of the MESSAGE_CLASS_* values.

Since:

BlackBerry API 4.0.0

getValidityPeriod

public int getValidityPeriod()

Retrieves the validity period.

Returns:

Validity period (one of the PERIOD_* values).

Since:

BlackBerry API 4.0.0

setValidityPeriod

public void setValidityPeriod(int validityPeriod)

Sets the validity period for the message.

Parameters:

validityPeriod - New validity period (one of the PERIOD_* values).

Since:

BlackBerry API 4.0.0

getPrivacy

public int getPrivacy()

Retrieves the privacy setting.

Returns:

One of the PRIVACY_* values.

Since:

BlackBerry API 4.0.0

setPrivacy

public void setPrivacy(int privacy)

Sets the privacy for the message.

Parameters:

privacy - One of the PRIVACY_* values.

Since:

BlackBerry API 4.0.0

getPriority

public int getPriority()

Retrieves the priority of the message.

Returns:

One of the PRIORITY_* values.

Since:

BlackBerry API 4.0.0

setPriority

public void setPriority(int priority)

Sets the priority for the message.

Parameters:

priority - One of the PRIORITY_* values.

Since:

BlackBerry API 4.0.0

getLanguage

public int getLanguage()

Retrieves the language used.

Returns:

One of the LANGUAGE_* values.

Since:

BlackBerry API 4.0.0

setLanguage

public void setLanguage(int language)

Sets the language for the message.

Parameters:

language - One of the LANGUAGE_* values.

Since:

BlackBerry API 4.0.0

getCallbackAddress

public String getCallbackAddress()

Retrieves the callback address.

Returns:

Callback address.

Since:

BlackBerry API 4.0.0

getCallbackType

public int getCallbackType()

Retrieves the callback type of number.

Returns:

Callback type of number.

Since:

BlackBerry API 4.0.0

getCallbackPlan

public int getCallbackPlan()

Retrieves the callback numbering plan.

Returns:

Callback numbering plan.

Since:

BlackBerry API 4.0.0

setCallbackAddress

public void setCallbackAddress(String callbackAddress)

Sets the callback address.

Parameters:

Callback - address.

Since:

BlackBerry API 4.0.0

setCallbackAddress

public void setCallbackAddress(String callbackAddress,
                               int callbackType,
                               int callbackPlan)

Sets the callback address, type, and plan.

Parameters:

callbackAddress - Callback address.

callbackType - Callback type.

callbackPlan - Callback plan.

Since:

BlackBerry API 4.0.0

getDeliveryPeriod

public int getDeliveryPeriod()

Retrieves the delivery period.

Returns:

One of the delivery PERIOD_* values. If the radio layer blocks this feature, PERIOD_IMMEDIATE is returned.

Since:

BlackBerry API 4.0.0

setDeliveryPeriod

public void setDeliveryPeriod(int deliveryPeriod)

Sets the delivery period for the message.

Parameters:

deliveryPeriod - One of the delivery PERIOD_* values.

Since:

BlackBerry API 4.0.0