com.threerings.crowd.chat.server

Class ChatHistory

java.lang.Object

com.threerings.crowd.chat.server.ChatHistory

public class ChatHistory
extends Object

Provides a server-wide history of chat messages.

Nested Class Summary

Nested Classes

Modifier and Type	Class and Description
static class	ChatHistory.Entry Recorded parcel of chat for historical purposes, maintained by record(ChatChannel, String, UserMessage, Name[]), get(Name), and clear(Name).

Field Summary

Fields

Modifier and Type	Field and Description
static long	HISTORY_EXPIRATION The amount of time before chat history becomes...

Constructor Summary

Constructors

Constructor and Description
ChatHistory() Creates a new chat history, automatically registering a message observer with SpeakUtil.

Method Summary

Modifier and Type	Method and Description
void	clear(Name username) Clears the chat history for the specified user.
List<ChatHistory.Entry>	get(Name username) Returns a list of ChatHistory.Entry objects, one for each message to which this user has been privy in the recent past.
void	hold(Name username) Causes the chat history for the given user to be held briefly after the clear(com.threerings.util.Name) call so that session observers can grab it.
void	record(ChatChannel channel, String source, UserMessage msg, Name... usernames) Records the specified channel and message to the specified users' chat histories.

Methods inherited from class java.lang.Object

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

Field Detail

HISTORY_EXPIRATION

public static final long HISTORY_EXPIRATION

The amount of time before chat history becomes... history.

See Also:

Constant Field Values

Constructor Detail

ChatHistory

public ChatHistory()

Creates a new chat history, automatically registering a message observer with SpeakUtil.

Method Detail

get

public List<ChatHistory.Entry> get(Name username)

Returns a list of ChatHistory.Entry objects, one for each message to which this user has been privy in the recent past. If the given name implements KeepNoHistory, null is returned.

clear

public void clear(Name username)

Clears the chat history for the specified user.

record

public void record(ChatChannel channel,
                   String source,
                   UserMessage msg,
                   Name... usernames)

Records the specified channel and message to the specified users' chat histories. If ChatMessage.timestamp is not already filled in, it will be.

hold

public void hold(Name username)

Causes the chat history for the given user to be held briefly after the clear(com.threerings.util.Name) call so that session observers can grab it.