javax.wireless.messaging
Interface TextMessage

All Superinterfaces:

Message

public interface TextMessage
extends Message

An interface representing a text message. This is a subinterface of Message which contains methods to get and set the text payload. The TextMessage.setPayloadText(String) method sets the value of the payload in the data container without any checking whether the value is valid in any way. Methods for manipulating the address portion of the message are inherited from Message.

Object instances implementing this interface are just containers for the data that is passed in.

Character Encoding Considerations

Text messages using this interface deal with strings encoded in Java. The underlying implementation will convert the strings into a suitable encoding for the messaging protocol in question. Different protocols recognize different character sets. To ensure that characters are transmitted correctly across the network, an application should use the character set(s) recognized by the protocol. If an application is unaware of the protocol, or uses a character set that the protocol does not recognize, then some characters might be transmitted incorrectly.

This interface is defined in JSR 205: Wireless Messaging API 2.0, which extends and enhances JSR 120: Wireless Messaging API

Since:

BlackBerry API 4.0.0

Method Summary
String	getPayloadText() Returns the message payload data as a String.
void	setPayloadText(String data) Sets the payload data of this message.

Methods inherited from interface javax.wireless.messaging.Message

getAddress, getTimestamp, setAddress

Method Detail

getPayloadText

String getPayloadText()

Returns the message payload data as a String.

Returns:

the payload of this message, or null if the payload for the message is not set.

See Also:

TextMessage.setPayloadText(String)

Since:

BlackBerry API 4.0.0

setPayloadText

void setPayloadText(String data)

Sets the payload data of this message. The payload data may be null.

Parameters:

data - payload data as a String.

See Also:

TextMessage.getPayloadText()

Since:

BlackBerry API 4.0.0