Easemob Windows SDK
Public Types | Public Member Functions | Protected Member Functions | Friends | List of all members
easemob::EMCmdMessageBody Class Reference
Inheritance diagram for easemob::EMCmdMessageBody:
Inheritance graph
Collaboration diagram for easemob::EMCmdMessageBody:
Collaboration graph

Public Types

typedef std::pair< std::string, std::string > EMCmdParam
 
typedef std::vector< EMCmdParam > EMCmdParams
 
- Public Types inherited from easemob::EMMessageBody
enum  EMMessageBodyType {
  TEXT, IMAGE, VIDEO, LOCATION,
  VOICE, FILE, COMMAND
}
 

Public Member Functions

 EMCmdMessageBody (const std::string &action)
 Command message body constructor. More...
 
virtual ~EMCmdMessageBody ()
 Class destructor. More...
 
const std::string & action () const
 Get command action. More...
 
void setAction (const std::string &action)
 Set command action. More...
 
const EMCmdParams & params () const
 Get command parameters. More...
 
void setParams (const EMCmdParams &)
 Set command parameters. More...
 
- Public Member Functions inherited from easemob::EMMessageBody
 EMMessageBody (EMMessageBodyType=TEXT)
 Message body constructor. More...
 
virtual ~EMMessageBody ()
 Class destructor. More...
 
EMMessageBodyType type () const
 Get message body type. More...
 
- Public Member Functions inherited from easemob::EMBaseObject
template<typename T >
T * cast ()
 

Protected Member Functions

 EMCmdMessageBody ()
 Protected constructor. More...
 

Friends

class EMCmdMessageBodyPrivate
 
class EMMessageEncoder
 

Additional Inherited Members

- Protected Attributes inherited from easemob::EMMessageBody
EMMessageBodyPrivate * mBodyPrivate
 
EMMessageBodyType mType
 

Constructor & Destructor Documentation

§ EMCmdMessageBody() [1/2]

easemob::EMCmdMessageBody::EMCmdMessageBody ( const std::string &  action)

Command message body constructor.

Parameters
Commandaction
Commandparameters
Returns
NA

§ ~EMCmdMessageBody()

virtual easemob::EMCmdMessageBody::~EMCmdMessageBody ( )
virtual

Class destructor.

Parameters
NA
Returns
NA

§ EMCmdMessageBody() [2/2]

easemob::EMCmdMessageBody::EMCmdMessageBody ( )
protected

Protected constructor.

Parameters
NA
Returns
NA

Member Function Documentation

§ action()

const std::string& easemob::EMCmdMessageBody::action ( ) const

Get command action.

Parameters
NA
Returns
The command action.

§ params()

const EMCmdParams& easemob::EMCmdMessageBody::params ( ) const

Get command parameters.

Parameters
NA
Returns
The command parameters.

§ setAction()

void easemob::EMCmdMessageBody::setAction ( const std::string &  action)
inline

Set command action.

Parameters
Thecommand action.
Returns
NA

§ setParams()

void easemob::EMCmdMessageBody::setParams ( const EMCmdParams &  )

Set command parameters.

Note: User should not use command parameters any more, and use EMMessage's attribute instead.

Parameters
Thecommand parameters.
Returns
NA

The documentation for this class was generated from the following file: