org.jivesoftware.smack.packet

Class Message

java.lang.Object

org.jivesoftware.smack.packet.Packet

org.jivesoftware.smack.packet.Message

public class Message
extends Packet

Represents XMPP message packets. A message can be one of several types:

• Message.Type.NORMAL -- (Default) a normal text message used in email like interface.
• Message.Type.CHAT -- a typically short text message used in line-by-line chat interfaces.
• Message.Type.GROUP_CHAT -- a chat message sent to a groupchat server for group chats.
• Message.Type.HEADLINE -- a text message to be displayed in scrolling marquee displays.
• Message.Type.ERROR -- indicates a messaging error.

For each message type, different message fields are typically used as follows:

	Message type
Field	Normal	Chat	Group Chat	Headline	XMPPError
subject	SHOULD	SHOULD NOT	SHOULD NOT	SHOULD NOT	SHOULD NOT
thread	OPTIONAL	SHOULD	OPTIONAL	OPTIONAL	SHOULD NOT
body	SHOULD	SHOULD	SHOULD	SHOULD	SHOULD NOT
error	MUST NOT	MUST NOT	MUST NOT	MUST NOT	MUST

Author:

Matt Tucker

Nested Class Summary

Nested Classes

Modifier and Type	Class and Description
static class	Message.Type Represents the type of a message.

Field Summary

Fields inherited from class org.jivesoftware.smack.packet.Packet

ID_NOT_AVAILABLE

Constructor Summary

Constructors

Constructor and Description
Message() Creates a new, "normal" message.
Message(java.lang.String to) Creates a new "normal" message to the specified recipient.
Message(java.lang.String to, Message.Type type) Creates a new message of the specified type to a recipient.

Method Summary

Methods

Modifier and Type	Method and Description
java.lang.String	getBody() Returns the body of the message, or null if the body has not been set.
java.lang.String	getSubject() Returns the subject of the message, or null if the subject has not been set.
java.lang.String	getThread() Returns the thread id of the message, which is a unique identifier for a sequence of "chat" messages.
Message.Type	getType() Returns the type of the message.
void	setBody(java.lang.String body) Sets the body of the message.
void	setSubject(java.lang.String subject) Sets the subject of the message.
void	setThread(java.lang.String thread) Sets the thread id of the message, which is a unique identifier for a sequence of "chat" messages.
void	setType(Message.Type type) Sets the type of the message.
java.lang.String	toXML() Returns the packet as XML.

Methods inherited from class org.jivesoftware.smack.packet.Packet

addExtension, deleteProperty, getError, getExtension, getExtensions, getExtensionsXML, getFrom, getPacketID, getProperty, getPropertyNames, getTo, removeExtension, setError, setFrom, setPacketID, setProperty, setProperty, setProperty, setProperty, setProperty, setProperty, setTo

Methods inherited from class java.lang.Object

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

Constructor Detail

Message

public Message()

Creates a new, "normal" message.

Message

public Message(java.lang.String to)

Creates a new "normal" message to the specified recipient.

Parameters:

to - the recipient of the message.

Message

public Message(java.lang.String to,
       Message.Type type)

Creates a new message of the specified type to a recipient.

Parameters:

to - the user to send the message to.

type - the message type.

Method Detail

getType

public Message.Type getType()

Returns the type of the message.

Returns:

the type of the message.

setType

public void setType(Message.Type type)

Sets the type of the message.

Parameters:

type - the type of the message.

getSubject

public java.lang.String getSubject()

Returns the subject of the message, or null if the subject has not been set. The subject is a short description of message contents.

Returns:

the subject of the message.

setSubject

public void setSubject(java.lang.String subject)

Sets the subject of the message. The subject is a short description of message contents.

Parameters:

subject - the subject of the message.

getBody

public java.lang.String getBody()

Returns the body of the message, or null if the body has not been set. The body is the main message contents.

Returns:

the body of the message.

setBody

public void setBody(java.lang.String body)

Sets the body of the message. The body is the main message contents.

Parameters:

body -

getThread

public java.lang.String getThread()

Returns the thread id of the message, which is a unique identifier for a sequence of "chat" messages. If no thread id is set, null will be returned.

Returns:

the thread id of the message, or null if it doesn't exist.

setThread

public void setThread(java.lang.String thread)

Sets the thread id of the message, which is a unique identifier for a sequence of "chat" messages.

Parameters:

thread - the thread id of the message.

toXML

public java.lang.String toXML()

Description copied from class: Packet

Returns the packet as XML. Every concrete extension of Packet must implement this method. In addition to writing out packet-specific data, every sub-class should also write out the error and the extensions data if they are defined.

Specified by:

toXML in class Packet

Returns:

the XML format of the packet as a String.