SDK  2.1.4 [async]
CloudBackend Software Development Kit - SDK API for C++
All Classes Namespaces Functions Variables Typedefs Enumerations Friends Pages
cbe::GroupManager Class Reference

For managing the groups. More...

#include <GroupManager.h>

Public Types

using ListGroupsDelegatePtr = delegate::ListGroupsDelegatePtr
 
using SearchGroupsDelegatePtr = delegate::SearchGroupsDelegatePtr
 

Public Member Functions

void listGroups (ListGroupsDelegatePtr delegate)
 
void searchGroups (cbe::GroupFilter filter, SearchGroupsDelegatePtr delegate, cbe::GroupId parentGroupId=0)
 
cbe::GroupId getTenantId () const
 
 GroupManager (cbe::DefaultCtor)
 Default constructor. More...
 
 operator bool () const
 Checks if the current instance is real. More...
 

Friends

class CloudBackend
 

Detailed Description

For managing the groups.

Member Typedef Documentation

◆ ListGroupsDelegatePtr

◆ SearchGroupsDelegatePtr

Constructor & Destructor Documentation

◆ GroupManager()

cbe::GroupManager::GroupManager ( cbe::DefaultCtor  )

Default constructor.

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

Member Function Documentation

◆ getTenantId()

cbe::GroupId cbe::GroupManager::getTenantId ( ) const

Pointer to cbe::delegate::SearchGroupsDelegate that is passed into asynchronous version of method searchGroups() Returns the tenant id of the Tenant user group that the user is in.

◆ listGroups()

void cbe::GroupManager::listGroups ( ListGroupsDelegatePtr  delegate)

List all current joined groups.

Parameters
delegatePointer to a delegate::ListGroupsDelegate instance that is implemented by the user.

◆ operator bool()

cbe::GroupManager::operator bool ( ) const
explicit

Checks if the current instance is real.

An "unreal" instance implies typically a failed event.

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

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

◆ searchGroups()

void cbe::GroupManager::searchGroups ( cbe::GroupFilter  filter,
SearchGroupsDelegatePtr  delegate,
cbe::GroupId  parentGroupId = 0 
)

Search for open public groups.

Parameters
filteris a group filter to set search criteria for open public groups. Look att class GroupFilter for more information.
delegatePointer to a delegate::SearchGroupsDelegate instance that is implemented by the user.
parentGroupIdis the id of the group to be searched within. If this is not set the tenant id will be used.

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