de.fu_berlin.inf.dpp.communication.chat.IChat Interface Reference

Inheritance diagram for de.fu_berlin.inf.dpp.communication.chat.IChat:

List of all members.

Public Member Functions
JID	getJID ()
Set< JID >	getParticipants ()
String	getThreadID ()
void	sendMessage (Message message) throws XMPPException
void	sendMessage (String text) throws XMPPException
void	setCurrentState (ChatState newState) throws XMPPException
void	addHistoryEntry (ChatElement entry)
List< ChatElement >	getHistory ()
void	clearHistory ()
void	addChatListener (IChatListener chatListener)
void	removeChatListener (IChatListener chatListener)
boolean	isConnected ()
boolean	disconnect ()

---

Detailed Description

This interface is used to provide unified access to multiple chat types.

---

Member Function Documentation

void de.fu_berlin.inf.dpp.communication.chat.IChat.addChatListener

(

IChatListener

chatListener

)

Add chat listener to receive notifications on events.

Parameters:

chatListener

chat listener to add

Implemented in de.fu_berlin.inf.dpp.communication.chat.AbstractChat.

void de.fu_berlin.inf.dpp.communication.chat.IChat.addHistoryEntry

(

ChatElement

entry

)

Add ChatElement to this chat's history.

Parameters:

entry

chat element to add

Implemented in de.fu_berlin.inf.dpp.communication.chat.AbstractChat.

void de.fu_berlin.inf.dpp.communication.chat.IChat.clearHistory

(

)

Clears the current chat history.

Implemented in de.fu_berlin.inf.dpp.communication.chat.AbstractChat.

boolean de.fu_berlin.inf.dpp.communication.chat.IChat.disconnect

(

)

For internal use: use IChatService#destroyChat(IChat) to disconnect the chat

Implemented in de.fu_berlin.inf.dpp.communication.chat.muc.MultiUserChat, and de.fu_berlin.inf.dpp.communication.chat.single.SingleUserChat.

List<ChatElement> de.fu_berlin.inf.dpp.communication.chat.IChat.getHistory

(

)

Returns the chat history for this chat.

Returns:

the chat history for this chat

Implemented in de.fu_berlin.inf.dpp.communication.chat.AbstractChat.

JID de.fu_berlin.inf.dpp.communication.chat.IChat.getJID

(

)

Returns the JID of the local user.

Returns:

the JID of the local user

Implemented in de.fu_berlin.inf.dpp.communication.chat.muc.MultiUserChat, and de.fu_berlin.inf.dpp.communication.chat.single.SingleUserChat.

Set<JID> de.fu_berlin.inf.dpp.communication.chat.IChat.getParticipants

(

)

Returns the names of the user the chat is with.

Returns:

the names of the user the chat is with.

Implemented in de.fu_berlin.inf.dpp.communication.chat.muc.MultiUserChat, and de.fu_berlin.inf.dpp.communication.chat.single.SingleUserChat.

String de.fu_berlin.inf.dpp.communication.chat.IChat.getThreadID

(

)

Returns the thread id associated with this chat, which corresponds to the thread field of XMPP messages.

Returns:

the thread id associated with this chat, which corresponds to the thread field of XMPP messages.

Implemented in de.fu_berlin.inf.dpp.communication.chat.muc.MultiUserChat, and de.fu_berlin.inf.dpp.communication.chat.single.SingleUserChat.

boolean de.fu_berlin.inf.dpp.communication.chat.IChat.isConnected

(

)

Returns if it is possible to post messages to the chat.

Returns:

true if it is possible to post messages, otherwise false

Implemented in de.fu_berlin.inf.dpp.communication.chat.muc.MultiUserChat, and de.fu_berlin.inf.dpp.communication.chat.single.SingleUserChat.

void de.fu_berlin.inf.dpp.communication.chat.IChat.removeChatListener

(

IChatListener

chatListener

)

Remove chat listener so it will not receive notifications on events.

Parameters:

chatListener

Implemented in de.fu_berlin.inf.dpp.communication.chat.AbstractChat.

void de.fu_berlin.inf.dpp.communication.chat.IChat.sendMessage

(

String

text

)

throws XMPPException

Sends the specified text as a message to the other chat participants.

Parameters:

text	the specified text as a message to the other chat participant.

Exceptions:

XMPPException

Implemented in de.fu_berlin.inf.dpp.communication.chat.muc.MultiUserChat, and de.fu_berlin.inf.dpp.communication.chat.single.SingleUserChat.

void de.fu_berlin.inf.dpp.communication.chat.IChat.sendMessage

(

Message

message

)

throws XMPPException

Sends a message to the other chat participants.

Parameters:

message

the message to send

Exceptions:

XMPPException

Implemented in de.fu_berlin.inf.dpp.communication.chat.muc.MultiUserChat, and de.fu_berlin.inf.dpp.communication.chat.single.SingleUserChat.

void de.fu_berlin.inf.dpp.communication.chat.IChat.setCurrentState

(

ChatState

newState

)

throws XMPPException

Set this chat's ChatState and notify participants of the change.

Parameters:

newState

ChatState to set

Exceptions:

XMPPException

Implemented in de.fu_berlin.inf.dpp.communication.chat.muc.MultiUserChat, and de.fu_berlin.inf.dpp.communication.chat.single.SingleUserChat.