ShareEventProtocol

Declared In:

Introduction

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

public

virtual void onACLError(
    cbe::item_t type, 
    uint32_t code, 
    std::string reason, 
    std::string message);

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.

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

public

virtual void onContainerACLAdded( 
    std::map<cbe::UserId, cbe::permission_status_t>&& acls);

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

public

virtual void onContainerAclLoaded(
    std::map<uint64_t, cbe::permission_status_t>&& aclMap);

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

public

virtual void onContainerShared(
    uint64_t shareId);

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.

Gets called when a Container has been shared

public

virtual void onContainerUnShared(
    std::string message);

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

public

virtual void onListAvailableShares(
    cbe::QueryResult&& result);

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

public

virtual void onListMyShares(
    cbe::QueryResult&& qResult);

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

public

virtual void onObjectACLAdded( 
    std::map<cbe::UserId, cbe::permission_status_t>&& acls);

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

public

virtual void onObjectAclLoaded(
    std::map<uint64_t, cbe::permission_status_t>&& aclMap);

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

public

virtual void onObjectShared(
    uint64_t shareId);

Gets called when an Object has been shared.

public

virtual void onObjectUnShared(
    std::string message);

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

public

virtual void onShareError(
    cbe::item_t type, 
    uint32_t code, 
    std::string reason, 
    std::string message);

Errors regarding share and list share calls onShareError.

Last Updated: Wednesday, May 03, 2023