FriendInfo Class Reference

Inheritance diagram for FriendInfo:

Collaboration diagram for FriendInfo:

Public Member Functions
Common::JString	getUserID (void) const
bool	getIsOnline (void) const
Common::JString	getRoom (void) const
bool	getIsInRoom (void) const
virtual Common::JString &	toString (Common::JString &retStr, bool withTypes=false) const
virtual JString &	toString (JString &retStr, bool withTypes=false) const=0
JString	toString (bool withTypes=false) const
Public Member Functions inherited from ToString
virtual	~ToString (void)
virtual JString	typeToString (void) const
JString	toString (bool withTypes=false) const

Detailed Description

Used to store the information about a friend's online status and in which room he/she is active.

See also

Client::getFriendList(), Client::getFriendListAge(), Client::opFindFriends(), Listener::onFindFriendsResponse()

Member Function Documentation

getUserID()

JString getUserID

(

void

)

const

Returns

the user ID of the friend

getIsOnline()

bool getIsOnline

(

void

)

const

Returns

true if the friend is online, false otherwise

getRoom()

JString getRoom

(

void

)

const

Returns

the name of the room in which the friend currently is active in, or an empty string, if it is not active inside any room at all.

getIsInRoom()

bool getIsInRoom

(

void

)

const

Returns

true if the friend is active inside a room, false otherwise.

toString() [1/3]

JString & toString ( Common::JString &  retStr, bool  withTypes = false  ) const

virtual

Remarks

The cost of this function depends a lot on implementation details of the implementing subclasses, but for container classes this function can become quite expensive, if the instance contains huge amounts of data, as its cost for many container class implementations increases disproportionately high to the size of the payload.

Parameters

retStr	reference to a string, to store the return-value in; the information, which is generated by this function, will be attached at the end of any eventually existing previous content of the string
withTypes	set to true, to include type information in the generated string

Returns

a JString representation of the instance and its contents for debugging purposes.

Implements ToString.

toString() [2/3]

toString

Remarks

The cost of this function depends a lot on implementation details of the implementing subclasses, but for container classes this function can become quite expensive, if the instance contains huge amounts of data, as its cost for many container class implementations increases disproportionately high to the size of the payload.

Parameters

retStr	reference to a string, to store the return-value in; the information, which is generated by this function, will be attached at the end of any eventually existing previous content of the string
withTypes	set to true, to include type information in the generated string

Returns

a JString representation of the instance and its contents for debugging purposes.

toString() [3/3]

JString toString

This is an overloaded member function, provided for convenience. It differs from the above function only in what argument(s) it accepts.

Parameters

withTypes

set to true, to include type information in the generated string

Returns

a JString representation of the instance and its contents for debugging purposes.

See also

JString