org.jivesoftware.spark.ui
Interface ChatRoomListener

All Known Implementing Classes:

ChatRoomListenerAdapter, ChatTranscriptPlugin, ConferenceRoomInfo, SoundPlugin

public interface ChatRoomListener

The ChatRoomListener interface is one of the interfaces extension writers use to add functionality to Spark.

In general, you implement this interface in order to listen for ChatRoom activity, such as a ChatRoom opening, closing, or being activated.

Method Summary

void	chatRoomActivated(ChatRoom room) Invoked by ChatRooms when a ChatRoom has been activated.
void	chatRoomClosed(ChatRoom room) Invoke by ChatRooms when a ChatRoom has been closed.
void	chatRoomLeft(ChatRoom room) Invoked by ChatRooms when a ChatRoom has been left, but not closed.
void	chatRoomOpened(ChatRoom room) Invoked by ChatRooms when a new ChatRoom has been opened.
void	userHasJoined(ChatRoom room, java.lang.String userid) Invoked by ChatRooms when a person has joined a chat room.
void	userHasLeft(ChatRoom room, java.lang.String userid) Invoked by ChatRooms when a person has left a chat room.

Method Detail

chatRoomOpened

void chatRoomOpened(ChatRoom room)

Invoked by ChatRooms when a new ChatRoom has been opened.

Parameters:

room - - the ChatRoom that has been opened.

See Also:

ChatContainer

chatRoomLeft

void chatRoomLeft(ChatRoom room)

Invoked by ChatRooms when a ChatRoom has been left, but not closed.

Parameters:

room - - the ChatRoom that has been left.

See Also:

ChatContainer

chatRoomClosed

void chatRoomClosed(ChatRoom room)

Invoke by ChatRooms when a ChatRoom has been closed.

Parameters:

room - - the ChatRoom that has been closed.

chatRoomActivated

void chatRoomActivated(ChatRoom room)

Invoked by ChatRooms when a ChatRoom has been activated. i.e. it has already been opened, but was deactivated when the user selected a new chat room, but now has selected the old one.

Parameters:

room - - the ChatRoom that has been selected.

userHasJoined

void userHasJoined(ChatRoom room,
                   java.lang.String userid)

Invoked by ChatRooms when a person has joined a chat room.

Parameters:

room - - the chat room the person has joined

userid - - the userid of the person who has joined

userHasLeft

void userHasLeft(ChatRoom room,
                 java.lang.String userid)

Invoked by ChatRooms when a person has left a chat room.

Parameters:

room - - the chat room the person has left

userid - - the userid of the person who has left