CBE::Group Class Reference

Public Member Functions
virtual std::string	name () const
virtual CBE::group_id_t	id () const
virtual CBE::group_id_t	parentId () const
virtual CBE::ContainerPtr	groupContainer () const
virtual CBE::visibility	getVisibility () const
virtual bool	joined () const
virtual std::vector< CBE::Request >	requests () const
virtual CBE::GroupPtr	createGroup (std::string name, std::string memberAlias, CBE::GroupDelegatePtr delegate, CBE::visibility visibility=CBE::Visibility::Public)
virtual void	join (std::string alias, CBE::GroupDelegatePtr delegate, CBE::visibility memberVisibility=CBE::Visibility::Public, std::string applicationComment="")
virtual void	leave (CBE::GroupDelegatePtr delegate)
virtual void	remove (CBE::GroupDelegatePtr delegate)
virtual void	rename (std::string newName, CBE::GroupDelegatePtr delegate)
virtual void	listMembers (CBE::GroupDelegatePtr delegate)
virtual void	listBannedMembers (CBE::GroupDelegatePtr delegate)

Member Function Documentation

name()

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

virtual

Returns the name of the group.

id()

virtual CBE::group_id_t CBE::Group::id ( ) const

virtual

Returns the id of the group.

parentId()

virtual CBE::group_id_t CBE::Group::parentId ( ) const

virtual

Group Parent id.

groupContainer()

virtual CBE::ContainerPtr CBE::Group::groupContainer ( ) const

virtual

Every group has a drive/container where resources can be shared with the members of the group. Works like a shared container.

getVisibility()

virtual CBE::visibility CBE::Group::getVisibility ( ) const

virtual

Visibility of the Group, Public is searchable and Private is not. In this early version you can create Private groups but the ability to invite has been blocked. (work in progress)

joined()

virtual bool CBE::Group::joined ( ) const

virtual

Searched groups is obtained through the GroupQuery response. This list of groups have non-joined and joined groups. Already joined groups can be found on the groupManager->groups() as well and are cached. The joined bool is used to easily sort out groups in the GroupQuery.

requests()

virtual std::vector<CBE::Request> CBE::Group::requests ( ) const

virtual

Requests to join the group. To retrive the list call listJoinRequests(CBE::GroupDelegatePtr delegate) on the group object.

createGroup()

virtual CBE::GroupPtr CBE::Group::createGroup ( std::string  name, std::string  memberAlias, CBE::GroupDelegatePtr  delegate, CBE::visibility  visibility = CBE::Visibility::Public  )

virtual

Create Group, can only be used by admin/owners to create new groups.

join()

virtual void CBE::Group::join ( std::string  alias, CBE::GroupDelegatePtr  delegate, CBE::visibility  memberVisibility = CBE::Visibility::Public, std::string  applicationComment = ""  )

virtual

Request to join a group, in this first version All members will be Public, meaning visable for other member inside the group. All groups will also be open so all join requests should be accepted directly.

leave()

virtual void CBE::Group::leave ( CBE::GroupDelegatePtr  delegate )

virtual

Leave group.

remove()

virtual void CBE::Group::remove ( CBE::GroupDelegatePtr  delegate )

virtual

Remove group (exlusive for group owners).

rename()

virtual void CBE::Group::rename ( std::string  newName, CBE::GroupDelegatePtr  delegate  )

virtual

Rename the Group, group id does not change.

listMembers()

virtual void CBE::Group::listMembers ( CBE::GroupDelegatePtr  delegate )

virtual

List all members in the group. After listing, all members will be available though a call to group->members().

listBannedMembers()

virtual void CBE::Group::listBannedMembers ( CBE::GroupDelegatePtr  delegate )

virtual

Lists all banned former members, or users.

---

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

• Group.h