CBE::ShareEventProtocol Class Reference

#include <ShareEventProtocol.h>

Public Member Functions
virtual void	onListAvailableShares (CBE::QueryResultPtr result)
virtual void	onListMyShares (CBE::QueryResultPtr qResult)
virtual void	onContainerACLAdded (std::map< CBE::user_id_t, CBE::permission_status_t > ACLs)
virtual void	onObjectACLAdded (std::map< CBE::user_id_t, CBE::permission_status_t > ACLs)
virtual void	onContainerAclLoaded (std::vector< CBE::user_id_t > userIds, std::map< uint64_t, CBE::permission_status_t > ACLMap)
virtual void	onObjectAclLoaded (std::vector< CBE::user_id_t > userIds, std::map< uint64_t, CBE::permission_status_t > ACLMap)
virtual void	onContainerShared (uint64_t shareId)
virtual void	onContainerUnShared (std::string message)
virtual void	onObjectShared (uint64_t shareId)
virtual void	onObjectUnShared (std::string message)
virtual void	onShareError (CBE::item_t type, CBE::persistence_t operation, uint32_t code, std::string reason, std::string message)
virtual void	onACLError (CBE::item_t type, CBE::persistence_t operation, uint32_t code, std::string reason, std::string message)

Detailed Description

Protocol for implementing a Share delegate. Abstract base class which is used when you want notification about changes in folder and on documents.

Member Function Documentation

onListAvailableShares()

virtual void CBE::ShareEventProtocol::onListAvailableShares ( CBE::QueryResultPtr  result )

inlinevirtual

Gets called when a query for available shares that have been shared to you.

onListMyShares()

virtual void CBE::ShareEventProtocol::onListMyShares ( CBE::QueryResultPtr  qResult )

inlinevirtual

Gets called when a query for shares that you have shared to other accounts or groups.

onContainerACLAdded()

virtual void CBE::ShareEventProtocol::onContainerACLAdded ( std::map< CBE::user_id_t, CBE::permission_status_t >  ACLs )

inlinevirtual

Gets called when an Access Control List (std::map with user_id and permission) has been added to a Container

onObjectACLAdded()

virtual void CBE::ShareEventProtocol::onObjectACLAdded ( std::map< CBE::user_id_t, CBE::permission_status_t >  ACLs )

inlinevirtual

Gets called when an Access Control List (std::map with user_id and permission) has been added to an Object

onContainerAclLoaded()

virtual void CBE::ShareEventProtocol::onContainerAclLoaded ( std::vector< CBE::user_id_t >  userIds, std::map< uint64_t, CBE::permission_status_t >  ACLMap  )

inlinevirtual

Gets called when an Access Control List (std::map with user_id and permission) has been loaded for a Container

onObjectAclLoaded()

virtual void CBE::ShareEventProtocol::onObjectAclLoaded ( std::vector< CBE::user_id_t >  userIds, std::map< uint64_t, CBE::permission_status_t >  ACLMap  )

inlinevirtual

Gets called when an Access Control List (std::map with user_id and permission) has been loaded for an Object

onContainerShared()

virtual void CBE::ShareEventProtocol::onContainerShared ( uint64_t  shareId )

inlinevirtual

Gets called when a Container has been shared

Parameters

shareId

is the id of the share and is needed when unSharing and can be used to locate which user is tied to that share.

onContainerUnShared()

virtual void CBE::ShareEventProtocol::onContainerUnShared ( std::string  message )

inlinevirtual

Gets called when a Container has been unShared, message will be OK else an shareError will be thrown.

onObjectShared()

virtual void CBE::ShareEventProtocol::onObjectShared ( uint64_t  shareId )

inlinevirtual

Gets called when an Object has been shared.

onObjectUnShared()

virtual void CBE::ShareEventProtocol::onObjectUnShared ( std::string  message )

inlinevirtual

Gets called when an Object has been unshared, massage will be OK, if not ok there will be a shareError thrown.

onShareError()

virtual void CBE::ShareEventProtocol::onShareError ( CBE::item_t  type, CBE::persistence_t  operation, uint32_t  code, std::string  reason, std::string  message  )

inlinevirtual

Errors regarding share and list share calls onShareError.

onACLError()

virtual void CBE::ShareEventProtocol::onACLError ( CBE::item_t  type, CBE::persistence_t  operation, uint32_t  code, std::string  reason, std::string  message  )

inlinevirtual

Gets called when errors regarding ACLs have occured, outcome of a get or setACL that has failed.

Parameters

type	is either Container or Object.
operation	is set or getACL for either Container or Object.
code	is according to w3 standards, for more information look at cloudbackend website or look at RFC 7231
reason	is from server/edge why the error occured.
message	of the error can be something like 403, forbidden, permission denied where permission denied is the message telling you that the ACL:s you've set is not allowing the other user to access the Object or Container.

---

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

• ShareEventProtocol.h