org.eclipse.ecf.presence.im
Interface IChatMessage

All Superinterfaces:

org.eclipse.core.runtime.IAdaptable, IIMMessage, java.io.Serializable

All Known Subinterfaces:

IXHTMLChatMessage

All Known Implementing Classes:

ChatMessage, XHTMLChatMessage

public interface IChatMessage
extends IIMMessage

Chat message. This is the message received when another user sends a chat message to us.

Nested Class Summary

static class

IChatMessage.Type

Method Summary

java.lang.String	getBody() Get the message body for this message.
java.util.Map	getProperties() Get properties associated with this chat message
java.lang.String	getSubject() Get subject for this message.
ID	getThreadID() Get thread ID for this message.
IChatMessage.Type	getType() Get type for this message.

Methods inherited from interface org.eclipse.ecf.presence.IIMMessage

getFromID

Methods inherited from interface org.eclipse.core.runtime.IAdaptable

getAdapter

Method Detail

getThreadID

ID getThreadID()

Get thread ID for this message. If thread IDs are not supported, null will be returned.

Returns:

ID that identifies thread for this message. If threads are not supported by provider, will return null.

getSubject

java.lang.String getSubject()

Get subject for this message. If subjects are not supported, null will be returned.

Returns:

String that is the subject of this message. If subjects are not supported by provider, will return null.

getBody

java.lang.String getBody()

Get the message body for this message. Will not be null.

Returns:

String content/body of this message. Will not be null.

getType

IChatMessage.Type getType()

Get type for this message. Will not be null. Defaults to Type.CHAT.

Returns:

Type associated with this message. Defaults to Type.CHAT.

getProperties

java.util.Map getProperties()

Get properties associated with this chat message

Returns:

Map of properties. Will not be null.