C++  1.4.6
CloudBackend Software Development Kit - SDK API for C++
Public Member Functions | List of all members
CBE::Member Class Reference

Public Member Functions

virtual void kick (std::string kickComment, CBE::GroupDelegatePtr delegate)
 
virtual void ban (std::string banComment, CBE::GroupDelegatePtr delegate)
 
virtual void unBan (CBE::GroupDelegatePtr delegate)
 
virtual uint64_t memberId () const
 
virtual std::string name () const
 
virtual CBE::Visibility visibility () const
 
virtual CBE::group_id_t groupId () const
 
virtual std::map< std::pair< uint64_t, uint64_t >, std::pair< uint64_t, std::string > > getMemberBanInfo ()
 

Member Function Documentation

◆ kick()

virtual void CBE::Member::kick ( std::string  kickComment,
CBE::GroupDelegatePtr  delegate 
)
virtual

kick out a member from the group.

Parameters
kickComment
delegate

◆ ban()

virtual void CBE::Member::ban ( std::string  banComment,
CBE::GroupDelegatePtr  delegate 
)
virtual

ban a user from joining a group.

Parameters
banComment
delegate

◆ unBan()

virtual void CBE::Member::unBan ( CBE::GroupDelegatePtr  delegate)
virtual

Lift the ban on a user.

Parameters
delegate

◆ memberId()

virtual uint64_t CBE::Member::memberId ( ) const
virtual

Get the member id number.

Returns
uint64_t

◆ name()

virtual std::string CBE::Member::name ( ) const
virtual

Returns the member name.

Returns
std::string

◆ visibility()

virtual CBE::Visibility CBE::Member::visibility ( ) const
virtual

Get the visibility set.

Returns
CBE::Visibility

◆ groupId()

virtual CBE::group_id_t CBE::Member::groupId ( ) const
virtual

Get the group id number.

Returns
CBE::group_id_t

◆ getMemberBanInfo()

virtual std::map<std::pair<uint64_t,uint64_t>,std::pair<uint64_t,std::string> > CBE::Member::getMemberBanInfo ( )
virtual

Get the Member Ban Info map.

Returns
std::map<std::pair<uint64_t,uint64_t>,std::pair<uint64_t,std::string>>

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