org.jivesoftware.sparkimpl.plugin.transcripts
Class ChatTranscriptPlugin

java.lang.Object
  org.jivesoftware.sparkimpl.plugin.transcripts.ChatTranscriptPlugin

All Implemented Interfaces:

ChatRoomListener

public class ChatTranscriptPlugin
extends java.lang.Object
implements ChatRoomListener

The ChatTranscriptPlugin is responsible for transcript handling within Spark.

Author:

Derek DeMoro

Constructor Summary

ChatTranscriptPlugin()

Method Summary

boolean	canShutDown()
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	initialize() Register the listeners for transcript persistence.
void	persistConversations()
void	uninstall()
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.

Methods inherited from class java.lang.Object

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

Constructor Detail

ChatTranscriptPlugin

public ChatTranscriptPlugin()

Method Detail

initialize

public void initialize()

Register the listeners for transcript persistence.

persistConversations

public void persistConversations()

canShutDown

public boolean canShutDown()

chatRoomOpened

public void chatRoomOpened(ChatRoom room)

Description copied from interface: ChatRoomListener

Invoked by ChatRooms when a new ChatRoom has been opened.

Specified by:

chatRoomOpened in interface ChatRoomListener

Parameters:

room - - the ChatRoom that has been opened.

See Also:

ChatContainer

chatRoomLeft

public void chatRoomLeft(ChatRoom room)

Description copied from interface: ChatRoomListener

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

Specified by:

chatRoomLeft in interface ChatRoomListener

Parameters:

room - - the ChatRoom that has been left.

See Also:

ChatContainer

chatRoomClosed

public void chatRoomClosed(ChatRoom room)

Description copied from interface: ChatRoomListener

Invoke by ChatRooms when a ChatRoom has been closed.

Specified by:

chatRoomClosed in interface ChatRoomListener

Parameters:

room - - the ChatRoom that has been closed.

chatRoomActivated

public void chatRoomActivated(ChatRoom room)

Description copied from interface: ChatRoomListener

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.

Specified by:

chatRoomActivated in interface ChatRoomListener

Parameters:

room - - the ChatRoom that has been selected.

userHasJoined

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

Description copied from interface: ChatRoomListener

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

Specified by:

userHasJoined in interface ChatRoomListener

Parameters:

room - - the chat room the person has joined

userid - - the userid of the person who has joined

userHasLeft

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

Description copied from interface: ChatRoomListener

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

Specified by:

userHasLeft in interface ChatRoomListener

Parameters:

room - - the chat room the person has left

userid - - the userid of the person who has left

uninstall

public void uninstall()