com.threerings.crowd.chat.client

Class MuteDirector

java.lang.Object

com.threerings.presents.client.BasicDirector

com.threerings.crowd.chat.client.MuteDirector

All Implemented Interfaces:

ChatFilter, SessionObserver

public class MuteDirector
extends BasicDirector
implements ChatFilter

Manages the mutelist. TODO: This class right now is pretty much just a placeholder.

Nested Class Summary

Nested Classes

Modifier and Type	Class and Description
static interface	MuteDirector.MuteObserver An interface that can be registered with the MuteDirector to receive notifications to the mutelist.

Constructor Summary

Constructors

Constructor and Description
MuteDirector(CrowdContext ctx) Should be instantiated after the ChatDirector.
MuteDirector(CrowdContext ctx, Name[] list) Set up the mute director with the specified list of initial mutees.

Method Summary

Modifier and Type	Method and Description
void	addMuteObserver(MuteDirector.MuteObserver obs) Add the specified mutelist observer.
String	filter(String msg, Name otherUser, boolean outgoing) Filter a chat message.
Name[]	getMuted()
boolean	isMuted(Name username) Check to see if the specified user is muted.
void	removeMuteObserver(MuteDirector.MuteObserver obs) Remove the specified mutelist observer.
void	setChatDirector(ChatDirector chatdir) Set the required ChatDirector.
void	setMuted(Name username, boolean mute) Mute or unmute the specified user.
void	shutdown() Called to shut down the mute director.

Methods inherited from class com.threerings.presents.client.BasicDirector

clientDidLogoff, clientDidLogon, clientObjectDidChange, clientWillLogon, isAvailableInStandalone, setAvailableInStandalone

Methods inherited from class java.lang.Object

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

Constructor Detail

MuteDirector

public MuteDirector(CrowdContext ctx)

Should be instantiated after the ChatDirector.

MuteDirector

public MuteDirector(CrowdContext ctx,
                    Name[] list)

Set up the mute director with the specified list of initial mutees.

Method Detail

shutdown

public void shutdown()

Called to shut down the mute director.

setChatDirector

public void setChatDirector(ChatDirector chatdir)

Set the required ChatDirector.

addMuteObserver

public void addMuteObserver(MuteDirector.MuteObserver obs)

Add the specified mutelist observer.

removeMuteObserver

public void removeMuteObserver(MuteDirector.MuteObserver obs)

Remove the specified mutelist observer.

isMuted

public boolean isMuted(Name username)

Check to see if the specified user is muted.

setMuted

public void setMuted(Name username,
                     boolean mute)

Mute or unmute the specified user.

getMuted

public Name[] getMuted()

Returns:

a list of the currently muted players. This list may be out of date immediately upon returning from this method.

filter

public String filter(String msg,
                     Name otherUser,
                     boolean outgoing)

Description copied from interface: ChatFilter

Filter a chat message.

Specified by:

filter in interface ChatFilter

Parameters:

msg - the message text to be filtered.

otherUser - an optional argument that represents the target or the speaker, depending on 'outgoing', and can be considered in filtering if it is provided.

outgoing - true if the message is going out to the server.

Returns:

the filtered message, or null to block it completely.