ymsg.network
Class YahooChatLobby

Object
  YahooChatLobby

public class YahooChatLobby

extends Object

Represents a single chat lobby. Yahoo chatrooms consist of one or more numbered lobbies inside each public/private room. The name of room and the number of the lobby (separated by a colon) form the 'network name' of the lobby - used by Yahoo to identify uniquely a given chat 'space' on its systems. Each lobby has a count of users, a count of voice chat users, and a count of webcam users. These counts are populated by the methods which load category and room structures in YahooChatCategory - they are not updated after initially created.

Since:

1.0

Constructor Summary

YahooChatLobby()

Method Summary

int	getLobbyNumber() Returns the lobby number.
Vector	getMembers() Returns a list of all current members of this chatroom lobby.
String	getNetworkName() Returns the unique network name of this lobby.
YahooChatRoom	getParent() Returns the parent chatroom object.
int	getUserCount() Returns the initial user count.
int	getVoiceCount() Returns the initial voice user count.
int	getWebcamCount() Returns the initial webcam user count.
String	toString() Returns a string representation of this object.

Methods inherited from class Object

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

Constructor Detail

YahooChatLobby

public YahooChatLobby()

Method Detail

getLobbyNumber

public int getLobbyNumber()

Returns the lobby number. This number, together with the parent chatroom name, form the unique 'network name' which identifies this chat space.

Returns:

lobby number

Since:

1.0

getUserCount

public int getUserCount()

Returns the initial user count. The current version of the jYMSG API does not update this automatically, once a room is entered.

Returns:

chat user count

Since:

1.0

getVoiceCount

public int getVoiceCount()

Returns the initial voice user count. The current version of the jYMSG API does not update this automatically, once a room is entered.

Returns:

chat user count

Since:

1.0

getWebcamCount

public int getWebcamCount()

Returns the initial webcam user count. The current version of the jYMSG API does not update this automatically, once a room is entered.

Returns:

chat user count

Since:

1.0

getNetworkName

public String getNetworkName()

Returns the unique network name of this lobby. This is formed by adding the lobby number to the end of the parent room's name, separated by a colon. This data is implementation detail, and will usually not be needed by API users.

Returns:

network name of lobby.

Since:

1.0

getParent

public YahooChatRoom getParent()

Returns the parent chatroom object.

Returns:

chatroom object

Since:

1.0

getMembers

public Vector getMembers()

Returns a list of all current members of this chatroom lobby. Yahoo doesn't deliver this data as part of its chat rooms directory. The list of members in a room is not delivered until a session actually logs into a lobby, and will only be current for the duration of the session's stay in the lobby.

Note: this method constructs the list from the lobby's own internal hashtable, and as such must be considered expensive.

Returns:

hashtable: key=id, value=YahooUser object

Since:

1.0

toString

public String toString()

Returns a string representation of this object.

Returns:

object as a string