|
||||||||||
PREV CLASS NEXT CLASS | FRAMES NO FRAMES | |||||||||
SUMMARY: NESTED | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD |
java.lang.ObjectAbstractChatInfo
FullRoomInfo
A data structure containing details about an OSCAR chat room. These details include the exchange on which the room resides, and possibly a "cookie" to be passed to a service request to join the room.
Field Summary | |
static int |
INSTANCE_LAST
Represents the "last instance" of a given room. |
Constructor Summary | |
protected |
FullRoomInfo(ByteBlock block)
Generates a room info object from the given block. |
|
FullRoomInfo(int exchange,
java.lang.String name)
Creates a chat room information object with the given properties. |
|
FullRoomInfo(int exchange,
java.lang.String name,
java.lang.String charset1,
java.lang.String language1)
Creates a chat room information object with the given properties. |
|
FullRoomInfo(int exchange,
java.lang.String name,
java.lang.String charset1,
java.lang.String language1,
java.lang.String contentType)
Creates a chat room information object with the given properties. |
Method Summary | |
java.lang.String |
getCookie()
The service request cookie associated with this room. |
int |
getExchange()
Returns the number of the exchange on which this room resides. |
int |
getInstance()
Returns the "instance" of the chat room. |
java.lang.String |
getRoomName()
The full name of the chat room. |
int |
getType()
Returns the type of room information block that this object represents. |
static FullRoomInfo |
readRoomInfo(ByteBlock block)
Reads a room information block from the given data block. |
java.lang.String |
toString()
|
void |
write(java.io.OutputStream out)
Writes a representation of this object to the given stream. |
Methods inherited from class AbstractChatInfo |
getBaseTlvCount, getCharset1, getCharset2, getContentType, getCreatePerms, getCreationDate, getFlags, getLanguage1, getLanguage2, getMaxMsgLen, getMaxOccupancy, getName, getSomething, readBaseInfo, writeBaseInfo |
Methods inherited from class java.lang.Object |
clone, equals, finalize, getClass, hashCode, notify, notifyAll, wait, wait, wait |
Field Detail |
public static final int INSTANCE_LAST
Constructor Detail |
protected FullRoomInfo(ByteBlock block)
block
- the block of data containing a room info objectpublic FullRoomInfo(int exchange, java.lang.String name)
"us-ascii"
and the language
is set to the JVM's current default language. Using this constructor is
equivalent to using new
FullRoomInfo(exchange, name, "us-ascii",
Locale.getDefault().getLanguage())
.
exchange
- the exchange on which the chat room residesname
- the name of the chat roompublic FullRoomInfo(int exchange, java.lang.String name, java.lang.String charset1, java.lang.String language1)
JoinRoomCmd
s.
exchange
- the exchange on which the chat room residesname
- the name of the chat roomcharset1
- the charset associated with the given roomlanguage1
- the language associated with the given room, normally
a two-letter language code like "en" (for English)public FullRoomInfo(int exchange, java.lang.String name, java.lang.String charset1, java.lang.String language1, java.lang.String contentType)
JoinRoomCmd
s.
exchange
- the exchange on which the chat room residesname
- the name of the chat roomcharset1
- the charset associated with the given roomlanguage1
- the language associated with the given room, normally
a two-letter language code like "en" (for English)contentType
- a content type string, like ChatMsg.CONTENTTYPE_DEFAULT
Method Detail |
public static FullRoomInfo readRoomInfo(ByteBlock block)
block
- the data block from which to read the room information
public final int getExchange()
public final java.lang.String getCookie()
JoinRoomCmd
.
public final int getInstance()
public final int getType()
AbstractChatInfo.TYPE_SHORT
, AbstractChatInfo.TYPE_FULL
, AbstractChatInfo.TYPE_NAV_INSTANCE_INFO
, AbstractChatInfo.TYPE_NAV_SHORT_DESC
, and AbstractChatInfo.TYPE_INSTANCE_INFO
.
public final java.lang.String getRoomName()
public void write(java.io.OutputStream out) throws java.io.IOException
LiveWritable
write
in interface LiveWritable
out
- the stream to which to write
java.io.IOException
- if an I/O error occurspublic java.lang.String toString()
toString
in class AbstractChatInfo
|
||||||||||
PREV CLASS NEXT CLASS | FRAMES NO FRAMES | |||||||||
SUMMARY: NESTED | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD |