Photon C++ Client API
Public Member Functions | List of all members
Channel Class Reference
Inheritance diagram for Channel:
Inheritance graph
Collaboration diagram for Channel:
Collaboration graph

Public Member Functions

void clearMessages (void)
const Common::JStringgetName (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::JStringtoString (Common::JString &retStr, bool withTypes=false) const
- Public Member Functions inherited from Base
virtual ~Base (void)
- Public Member Functions inherited from ToString
virtual ~ToString (void)
virtual JString typeToString (void) const
JString toString (bool withTypes=false) const

Additional Inherited Members

- Static Public Member Functions inherited from Base
static void setListener (const BaseListener *baseListener)
static int getDebugOutputLevel (void)
static bool setDebugOutputLevel (int debugLevel)
static const LogFormatOptionsgetLogFormatOptions (void)
static void setLogFormatOptions (const LogFormatOptions &options)

Detailed Description

Represents channel or private chat (channel with 2 users)

Member Function Documentation

§ toString()

JString & toString ( Common::JString retStr,
bool  withTypes = false 
) const
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.
retStrreference 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
withTypesset to true, to include type information in the generated string
a JString representation of the instance and its contents for debugging purposes.

Implements ToString.