Inheritance diagram for Channel:

Collaboration diagram for Channel:

Public Member Functions
void	clearMessages (void)

const Common::JString &	getName (void) const

const int	getID (void) const

unsigned int	getMessageCount (void) const

const Common::JVector< Common::JString > &	getSenders (void) const

const Common::JVector< Common::Object > &	getMessages (void) const

bool	getIsPrivate (void) const

const Common::Dictionary< Common::Object, Common::Object > &	getCustomProperties () 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

Represents channel or private chat (channel with 2 users)

Member Function Documentation

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

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.

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.