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

Public Types

enum  EMGroupLeaveReason { BE_KICKED, DESTROYED }
 

Public Member Functions

const std::string & groupId () const
 Get group's ID. More...
 
const std::string & groupSubject () const
 Get group's subject. More...
 
const std::string & groupDescription () const
 Get group's description. More...
 
const std::string & groupOwner () const
 Get group's owner. More...
 
const EMGroupSettinggroupSetting () const
 Get group's setting. More...
 
int groupMembersCount () const
 Get current members count. More...
 
bool isPushEnabled () const
 Get whether push is enabled status. More...
 
bool isMessageBlocked () const
 Get whether group messages is blocked. More...
 
const EMGroupMemberList * groupMembers () const
 Get group's member list. More...
 
const EMGroupMemberList * groupBans () const
 Get group's bans. More...
 
- Public Member Functions inherited from easemob::EMBaseObject
template<typename T >
T * cast ()
 

Member Function Documentation

§ groupBans()

const EMGroupMemberList* easemob::EMGroup::groupBans ( ) const

Get group's bans.

Note: Will return nullptr if have not ever got group's bans.

Parameters
NA
Returns
Group's bans list.

§ groupDescription()

const std::string& easemob::EMGroup::groupDescription ( ) const

Get group's description.

Parameters
NA
Returns
Group's description

§ groupId()

const std::string& easemob::EMGroup::groupId ( ) const

Get group's ID.

Parameters
NA
Returns
Group's ID.

§ groupMembers()

const EMGroupMemberList* easemob::EMGroup::groupMembers ( ) const

Get group's member list.

Note: Will return nullptr if have not ever got group's members.

Parameters
NA
Returns
Group's member list.

§ groupMembersCount()

int easemob::EMGroup::groupMembersCount ( ) const

Get current members count.

Note: Will return 0 if have not ever got group's specification.

Parameters
NA
Returns
Members count

§ groupOwner()

const std::string& easemob::EMGroup::groupOwner ( ) const

Get group's owner.

Parameters
NA
Returns
Group's owner

§ groupSetting()

const EMGroupSetting* easemob::EMGroup::groupSetting ( ) const

Get group's setting.

Note: Will return nullptr if have not ever got group's specification.

Parameters
NA
Returns
Group's setting.

§ groupSubject()

const std::string& easemob::EMGroup::groupSubject ( ) const

Get group's subject.

Parameters
NA
Returns
Group's subject

§ isMessageBlocked()

bool easemob::EMGroup::isMessageBlocked ( ) const

Get whether group messages is blocked.

Note: Group owner can't block group message.

Parameters
NA
Returns
Group message block status.

§ isPushEnabled()

bool easemob::EMGroup::isPushEnabled ( ) const

Get whether push is enabled status.

Parameters
NA
Returns
Push status.

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