ymsg.network
Class YahooChatRoom

Object
  YahooChatRoom

public class YahooChatRoom

extends Object

Represents a single chat room, either public (Yahoo owned) or private (user owned). Each room is divided into multiple independent chat spaces, known as 'lobbies'.

Since:

1.0

Constructor Summary

YahooChatRoom()

Method Summary

long	getId() Returns the unique ID used to reference this room.
Vector	getLobbies() Returns a list of lobbies for this room.
String	getName() Returns the name (title) of this chat room.
boolean	isPublic() Returns true if this is a public room, false if private.
int	size() Returns the number of lobbies in this room.
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

YahooChatRoom

public YahooChatRoom()

Method Detail

getName

public String getName()

Returns the name (title) of this chat room.

Returns:

chatroom name

Since:

1.0

getId

public long getId()

Returns the unique ID used to reference this room. This is implementation detail, and would not normally be needed by API users.

Returns:

unqiue ID number

Since:

1.0

isPublic

public boolean isPublic()

Returns true if this is a public room, false if private.

Returns:

true if public room

Since:

1.0

getLobbies

public Vector getLobbies()

Returns a list of lobbies for this room. The list is in the form of a Vector of YahooChatLobby objects. The list should never be empty (barring accident!) - there will always be at least one lobby for each room.

Returns:

list of lobbies as a vector

Since:

1.0

size

public int size()

Returns the number of lobbies in this room. There should always be at least one.

Returns:

size of lobbies list

Since:

1.0

toString

public String toString()

Returns a string representation of this object.

Returns:

object as a string