ChatCodes

Overview

Package

Class

Tree

Deprecated

Index

Help

PREV CLASS NEXT CLASS

FRAMES NO FRAMES

SUMMARY: NESTED | FIELD | CONSTR | METHOD

DETAIL: FIELD | CONSTR | METHOD

com.threerings.crowd.chat.data
Interface ChatCodes

All Superinterfaces:: InvocationCodes

All Known Implementing Classes:: ChatDirector

public interface ChatCodes
extends InvocationCodes
extends InvocationCodes

Contains codes used by the chat invocation services.

Field Summary
`static Permission`	`BROADCAST_ACCESS` The access control identifier for broadcast chat privileges.
`static byte`	`BROADCAST_MODE` A `SpeakService.speak(com.threerings.presents.client.Client, java.lang.String, byte)` mode to indicate that a speak is actually a server-wide broadcast.
`static Permission`	`CHAT_ACCESS` The access control identifier for normal chat privileges.
`static String`	`CHAT_CHANNEL_NOTIFICATION` The message identifier for a chat channel notification message.
`static String`	`CHAT_NOTIFICATION` The message identifier for a chat notification message.
`static long`	`DEFAULT_IDLE_TIME` The default time after which a player is assumed idle.
`static byte`	`DEFAULT_MODE` The default mode used by `SpeakService.speak(com.threerings.presents.client.Client, java.lang.String, byte)` requests.
`static byte`	`EMOTE_MODE` A `SpeakService.speak(com.threerings.presents.client.Client, java.lang.String, byte)` mode to indicate that a speak is actually an emote.
`static String`	`IDLE_TIME_KEY` The configuration key for idle time.
`static byte`	`LAST_MODE` The last chat mode defined in the interface.
`static String`	`PLACE_CHAT_TYPE` The chat localtype code for chat messages delivered on the place object currently occupied by the client.
`static byte`	`SHOUT_MODE` A `SpeakService.speak(com.threerings.presents.client.Client, java.lang.String, byte)` mode to indicate that a speak is actually a shout.
`static String`	`SUCCESS` A return value used by the ChatDirector and possibly other entities to indicate successful processing of chat.
`static byte`	`THINK_MODE` A `SpeakService.speak(com.threerings.presents.client.Client, java.lang.String, byte)` mode to indicate that the user is thinking what they're saying, or is it that they're saying what they're thinking?
`static String`	`USER_CHAT_TYPE` The chat localtype for messages received on the user object.
`static String`	`USER_DISCONNECTED` An error code delivered when the user targeted for a tell notification is disconnected.
`static String`	`USER_NOT_ONLINE` An error code delivered when the user targeted for a tell notification is not online.
`static String[]`	`XLATE_MODES` String translations for the various chat modes.

Fields inherited from interface com.threerings.presents.data.InvocationCodes
`ACCESS_DENIED, E_ACCESS_DENIED, E_INTERNAL_ERROR, GLOBAL_GROUP, INTERNAL_ERROR`

Field Detail

SUCCESS

static final String SUCCESS

A return value used by the ChatDirector and possibly other entities to indicate successful processing of chat.

See Also:: Constant Field Values

CHAT_NOTIFICATION

static final String CHAT_NOTIFICATION

The message identifier for a chat notification message.

See Also:: Constant Field Values

CHAT_CHANNEL_NOTIFICATION

static final String CHAT_CHANNEL_NOTIFICATION

The message identifier for a chat channel notification message.

See Also:: Constant Field Values

CHAT_ACCESS

static final Permission CHAT_ACCESS

The access control identifier for normal chat privileges.

BROADCAST_ACCESS

static final Permission BROADCAST_ACCESS

The access control identifier for broadcast chat privileges.

IDLE_TIME_KEY

static final String IDLE_TIME_KEY

The configuration key for idle time.

See Also:: Constant Field Values

DEFAULT_IDLE_TIME

static final long DEFAULT_IDLE_TIME

The default time after which a player is assumed idle.

See Also:: Constant Field Values

PLACE_CHAT_TYPE

static final String PLACE_CHAT_TYPE

The chat localtype code for chat messages delivered on the place object currently occupied by the client. This is the only type of chat message that will be delivered unless the chat director is explicitly provided with other chat message sources via ChatDirector.addAuxiliarySource(com.threerings.presents.dobj.DObject, java.lang.String).

See Also:: Constant Field Values

USER_CHAT_TYPE

static final String USER_CHAT_TYPE

The chat localtype for messages received on the user object.

See Also:: Constant Field Values

DEFAULT_MODE

static final byte DEFAULT_MODE

The default mode used by SpeakService.speak(com.threerings.presents.client.Client, java.lang.String, byte) requests.

See Also:: Constant Field Values

THINK_MODE

static final byte THINK_MODE

A SpeakService.speak(com.threerings.presents.client.Client, java.lang.String, byte) mode to indicate that the user is thinking what they're saying, or is it that they're saying what they're thinking?