cbe::Member Class Reference

A of member of a Group. More...

#include <Member.h>

Public Types
using	KickDelegatePtr = delegate::KickDelegatePtr
using	BanDelegatePtr = delegate::BanDelegatePtr
using	UnBanDelegatePtr = delegate::UnBanDelegatePtr

Public Member Functions
void	kick (std::string kickComment, KickDelegatePtr delegate)
void	ban (std::string banComment, BanDelegatePtr delegate)
void	unBan (UnBanDelegatePtr delegate)
cbe::MemberId	memberId () const
std::string	name () const
cbe::Visibility	visibility () const
cbe::GroupId	groupId () const
cbe::MemberBanInfo	getMemberBanInfo ()
	Gets the member ban info map.
	Member (cbe::DefaultCtor)
	Default constructor. More...
	operator bool () const
	Checks if the current instance is real. More...

Friends
class	Group
class	Role

Detailed Description

A of member of a Group.

Member Typedef Documentation

BanDelegatePtr

using cbe::Member::BanDelegatePtr = delegate::BanDelegatePtr

Pointer to cbe::delegate::KickDelegate that is passed into asynchronous version of method kick() Pointer to BanDelegate that is passed into:

• cbe::Member::ban(std::string,BanDelegatePtr)

KickDelegatePtr

using cbe::Member::KickDelegatePtr = delegate::KickDelegatePtr

Pointer to KickDelegate that is passed into:

• cbe::Member::kick(std::string,KickDelegatePtr)

UnBanDelegatePtr

using cbe::Member::UnBanDelegatePtr = delegate::UnBanDelegatePtr

Pointer to cbe::delegate::BanDelegate that is passed into asynchronous version of method ban() Pointer to UnBanDelegate that is passed into:

• cbe::Member::unBan(UnBanDelegatePtr)

Constructor & Destructor Documentation

Member()

cbe::Member::Member

(

cbe::DefaultCtor

)

Default constructor.

Construct a new object with the DefaultCtor to enable the operator bool() test

Member Function Documentation

ban()

void cbe::Member::ban	(	std::string	banComment,
		BanDelegatePtr	delegate
	)

Ban or evict a member from a group

Parameters

banComment	Free text describing the reason for this decision
delegate	Shared pointer to the class in which you implement cbe::delegate::BanDelegate to receive the callback upon completion of this request.

groupId()

cbe::GroupId cbe::Member::groupId

(

)

const

the group id number

kick()

void cbe::Member::kick	(	std::string	kickComment,
		KickDelegatePtr	delegate
	)

Kick out a member from a group

Parameters

kickComment	free text describing the reason for this decision
delegate	a shared pointer to the class in which you implement cbe::delegate::KickDelegate to receive the callback on server completion.

memberId()

cbe::MemberId cbe::Member::memberId

(

)

const

Pointer to cbe::delegate::UnBanDelegate that is passed into asynchronous version of method unBan() the member id number

name()

std::string cbe::Member::name

(

)

const

Returns the member name.

operator bool()

cbe::Member::operator bool ( ) const

explicit

Checks if the current instance is real.

An "unreal" instance implies typically a failed event.

Relies on the Default constructor Member(cbe::DefaultCtor)

Returns

true : is real

false : unreal; got nullptr; if current instance is unbound/undefined. I.e., if it is only default constructed.

unBan()

void cbe::Member::unBan

(

UnBanDelegatePtr

delegate

)

Revoke a ban of a member from a group

Parameters

delegate

a shared pointer to the class in which you implement cbe::delegate::UnBanDelegate to receive the callback on server completion.

visibility()

cbe::Visibility cbe::Member::visibility

(

)

const

see the enum Visibility in Types.h

---

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

• include/cbe/Member.h