SDK  2.1.4 [async]
CloudBackend Software Development Kit - SDK API for C++
Container.h
1 /*
2  Copyright © CloudBackend AB 2020 - 2023.
3 */
4 
5 #ifndef INCLUDE_CBE_CONTAINER_H_
6 #define INCLUDE_CBE_CONTAINER_H_
7 
8 #include "cbe/Types.h"
9 #include "cbe/delegate/container/MoveDelegate.h"
10 #include "cbe/delegate/container/RenameDelegate.h"
11 #include "cbe/delegate/container/RemoveDelegate.h"
12 #include "cbe/delegate/AclDelegate.h"
13 #include "cbe/delegate/CreateContainerDelegate.h"
14 #include "cbe/delegate/CreateObjectDelegate.h"
15 #include "cbe/delegate/Error.h"
16 #include "cbe/delegate/PublishDelegate.h"
17 #include "cbe/delegate/PublishSuccess.h"
18 #include "cbe/delegate/ShareDelegate.h"
19 #include "cbe/delegate/UnPublishDelegate.h"
20 #include "cbe/delegate/UnShareDelegate.h"
21 #include "cbe/delegate/UnSubscribeDelegate.h"
22 #include "cbe/delegate/UploadDelegate.h"
23 #include "cbe/delegate/QueryDelegate.h"
24 #include "cbe/delegate/QueryJoinDelegate.h"
25 
26 #ifndef CBE_NO_SYNC
27 #include "cbe/delegate/ProgressEventFn.h"
28 #endif
29 
30 #include "cbe/util/Context.h"
31 #include "cbe/util/ErrorInfo.h"
32 #include "cbe/util/Exception.h"
33 #include "cbe/util/Optional.h"
34 
35 #include "cbe/Item.h"
36 #include "cbe/Object.h"
37 #include "cbe/Types.h"
38 
39 namespace CBI {
40 class Container;
41 using ContainerPtr = std::shared_ptr<CBI::Container>;
42 class ItemEventProtocol;
43 using ItemDelegatePtr = std::shared_ptr<ItemEventProtocol>;
44 } // namespace CBI
45 
46 namespace cbe
47 {
48 class QueryChainExt;
49 class QueryChainSync;
50 
51 namespace delegate {
52  class AclDelegate;
53  class ShareDelegate;
54  class UnShareDelegate;
55 }
56 
57 class Filter;
58 
62 class Container : public cbe::Item
63 {
64 public:
70  using CreateContainerDelegatePtr = delegate::CreateContainerDelegatePtr;
79  cbe::Container createContainer(const std::string& name,
80  CreateContainerDelegatePtr delegate);
81 #ifndef CBE_NO_SYNC
85  using CreateContainerException = delegate::CreateContainerDelegate::Exception;
100  cbe::Container createContainer(const std::string& name);
101 
108  using CreateContainerError = delegate::CreateContainerDelegate::ErrorInfo;
130  cbe::util::Optional<cbe::Container> createContainer(
131  const std::string& name,
132  CreateContainerError& error);
133 #endif // #ifndef CBE_NO_SYNC
134  // - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - -
140  using MoveDelegatePtr = delegate::container::MoveDelegatePtr;
150  void move(cbe::ContainerId dstId, MoveDelegatePtr delegate);
151 
152 #ifndef CBE_NO_SYNC
156  using MoveException = delegate::container::MoveDelegate::Exception;
171  cbe::Container move(cbe::ContainerId dstId);
172 
179  using MoveError = delegate::container::MoveDelegate::ErrorInfo;
201  cbe::util::Optional<cbe::Container> move(
202  cbe::ContainerId dstId,
203  MoveError& error);
204 #endif // #ifndef CBE_NO_SYNC
205  // - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - -
211  using RenameDelegatePtr = delegate::container::RenameDelegatePtr;
220  void rename(const std::string& name, RenameDelegatePtr delegate);
221 
222 #ifndef CBE_NO_SYNC
226  using RenameException = delegate::container::RenameDelegate::Exception;
241  cbe::Container rename(const std::string& name);
242 
249  using RenameError = delegate::container::RenameDelegate::ErrorInfo;
271  cbe::util::Optional<cbe::Container> rename(const std::string& name,
272  RenameError& error);
273 #endif // #ifndef CBE_NO_SYNC
274  // - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - -
280  using RemoveDelegatePtr = delegate::container::RemoveDelegatePtr;
289  void remove(RemoveDelegatePtr delegate);
290 #ifndef CBE_NO_SYNC
294  using RemoveException = delegate::container::RemoveDelegate::Exception;
309  delegate::container::RemoveSuccess remove();
310 
317  using RemoveError = delegate::container::RemoveDelegate::ErrorInfo;
339  cbe::util::Optional<delegate::container::RemoveSuccess> remove(
340  RemoveError& error);
341 #endif // #ifndef CBE_NO_SYNC
342  // - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - -
348  using CreateObjectDelegatePtr = delegate::CreateObjectDelegatePtr;
366  cbe::Object createObject(std::string name,
367  cbe::KeyValues keyValues,
368  CreateObjectDelegatePtr delegate);
373  cbe::Object createObject(std::string name,
374  CreateObjectDelegatePtr delegate);
375 
376 #ifndef CBE_NO_SYNC
380  using CreateObjectException = delegate::CreateObjectDelegate::Exception;
395  cbe::Object createObject(std::string name,
396  cbe::KeyValues keyValues);
397 
404  using CreateObjectError = delegate::CreateObjectDelegate::ErrorInfo;
426  cbe::util::Optional<cbe::Object> createObject(
427  std::string name,
428  cbe::KeyValues keyValues,
429  CreateObjectError& error);
430 #endif // #ifndef CBE_NO_SYNC
431  // - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - -
441  using UploadDelegatePtr = delegate::UploadDelegatePtr;
457  cbe::Object upload(const std::string& filePath,
458  UploadDelegatePtr delegate);
459 
480  cbe::Object upload(const std::string& name,
481  const std::string& path,
482  UploadDelegatePtr delegate);
483 
493  cbe::Object upload(const std::string& name,
494  std::uint64_t length,
495  const char* byteData,
496  UploadDelegatePtr delegate);
497 #ifndef CBE_NO_SYNC
510  using UploadException = delegate::UploadDelegate::Exception;
541  cbe::Object upload(
542  const std::string& filePath,
543  delegate::ProgressEventFn&& progressEventFn);
544 
552  cbe::Object upload(
553  const std::string& filePath);
554 
572  cbe::Object upload(
573  const std::string& name,
574  const std::string& path,
575  delegate::ProgressEventFn&& progressEventFn);
584  cbe::Object upload(
585  const std::string& name,
586  const std::string& path);
587 
605  cbe::Object upload(
606  const std::string& name,
607  std::uint64_t length,
608  const char* byteData,
609  delegate::ProgressEventFn&& progressEventFn);
617  cbe::Object upload(
618  const std::string& name,
619  std::uint64_t length,
620  const char* byteData);
634  using UploadError = delegate::UploadDelegate::ErrorInfo;
635 
668  cbe::util::Optional<cbe::Object> upload(
669  const std::string& filePath,
670  delegate::ProgressEventFn&& progressEventFn,
671  UploadError& error);
679  cbe::util::Optional<cbe::Object> upload(
680  const std::string& filePath,
681  UploadError& error);
682 
703  cbe::util::Optional<cbe::Object> upload(
704  const std::string& name,
705  const std::string& path,
706  delegate::ProgressEventFn&& progressEventFn,
707  UploadError& error);
716  cbe::util::Optional<cbe::Object> upload(
717  const std::string& name,
718  const std::string& path,
719  UploadError& error);
720 
736  cbe::util::Optional<cbe::Object> upload(
737  const std::string& name,
738  std::uint64_t length,
739  const char* byteData,
740  delegate::ProgressEventFn&& progressEventFn,
741  UploadError& error);
750  cbe::util::Optional<cbe::Object> upload(
751  const std::string& name,
752  std::uint64_t length,
753  const char* byteData,
754  UploadError& error);
755 #endif // #ifndef CBE_NO_SYNC
756  // - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - -
762  using QueryDelegatePtr = delegate::QueryDelegatePtr;
771  cbe::QueryChain query(QueryDelegatePtr queryDelegate);
780  cbe::QueryChain query(Filter filter,
781  QueryDelegatePtr delegate);
782 
788  using QueryJoinDelegatePtr = std::shared_ptr<delegate::QueryJoinDelegate>;
797  cbe::QueryChainExt query(delegate::QueryJoinDelegatePtr delegate);
806  cbe::QueryChainExt query(Filter filter,
807  delegate::QueryJoinDelegatePtr delegate);
808 
809 #ifndef CBE_NO_SYNC
811  using QueryException = delegate::QueryDelegate::Exception;
822  cbe::QueryChainSync query();
833  cbe::QueryChainSync query(Filter filter);
834 
836  using QueryJoinError = delegate::QueryJoinDelegate::ErrorInfo;
837 
846  cbe::QueryChainSync query(QueryJoinError& error);
855  cbe::QueryChainSync query(Filter filter,
856  QueryJoinError& error);
857  // - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - -
859  using QueryError = delegate::QueryDelegate::ErrorInfo;
860 #endif // #ifndef CBE_NO_SYNC
861  // - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - -
881  cbe::QueryChain queryWithPath(std::string relativePath,
882  QueryDelegatePtr delegate);
883 #ifndef CBE_NO_SYNC
887  using queryWithPathException = delegate::QueryDelegate::Exception;
902  cbe::QueryResult queryWithPath(std::string relativePath);
903 
910  using queryWithPathError = delegate::QueryDelegate::ErrorInfo;
932  cbe::util::Optional<cbe::QueryResult> queryWithPath(
933  std::string relativePath,
934  queryWithPathError& error);
935 #endif // #ifndef CBE_NO_SYNC
936  // - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - -
959  cbe::QueryResult search(std::string tags, QueryDelegatePtr delegate);
960 
961 #ifndef CBE_NO_SYNC
965  using SearchException = delegate::QueryDelegate::Exception;
980  cbe::QueryResult search(std::string tags);
981 
988  using SearchError = delegate::QueryDelegate::ErrorInfo;
1010  cbe::util::Optional<cbe::QueryResult> search(std::string tags,
1011  SearchError& error);
1012 #endif // #ifndef CBE_NO_SYNC
1013  // - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - -
1033  cbe::QueryResult search(cbe::Filter filter, QueryDelegatePtr delegate);
1040 #ifndef CBE_NO_SYNC
1055  cbe::QueryResult search(cbe::Filter);
1056 
1078  cbe::util::Optional<cbe::QueryResult> search(cbe::Filter filter,
1079  SearchError& error);
1080 #endif // #ifndef CBE_NO_SYNC
1081  // - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - -
1087  using SetAclDelegatePtr = delegate::AclDelegatePtr;
1101  void setAcl(cbe::AclMap aclMap,
1102  SetAclDelegatePtr delegate);
1103 
1104 #ifndef CBE_NO_SYNC
1108  using SetAclException = delegate::AclDelegate::Exception;
1123  cbe::AclMap setAcl(cbe::AclMap aclMap);
1124 
1131  using SetAclError = delegate::AclDelegate::ErrorInfo;
1153  cbe::util::Optional<cbe::AclMap> setAcl(
1154  cbe::AclMap aclMap,
1155  SetAclError& error);
1156 #endif // #ifndef CBE_NO_SYNC
1157  // - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - -
1163  using GetAclDelegatePtr = delegate::AclDelegatePtr;
1171  void getAcl(GetAclDelegatePtr delegate);
1172 
1173 #ifndef CBE_NO_SYNC
1177  using GetAclException = delegate::AclDelegate::Exception;
1192  cbe::AclMap getAcl();
1193 
1200  using GetAclError = delegate::AclDelegate::ErrorInfo;
1222  cbe::util::Optional<cbe::AclMap> getAcl(GetAclError& error);
1223 #endif // #ifndef CBE_NO_SYNC
1224  // - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - -
1230  using ShareDelegatePtr = delegate::ShareDelegatePtr;
1244  void share(cbe::UserId toUserGroup,
1245  std::string description,
1246  ShareDelegatePtr delegate);
1247 
1248 #ifndef CBE_NO_SYNC
1252  using ShareException = delegate::ShareDelegate::Exception;
1267  delegate::ShareDelegate::Success share(cbe::UserId toUserGroup,
1268  std::string description);
1269 
1276  using ShareError = delegate::ShareDelegate::ErrorInfo;
1298  cbe::util::Optional<delegate::ShareDelegate::Success> share(
1299  cbe::UserId toUserGroup,
1300  std::string description,
1301  ShareError& error);
1302 #endif // #ifndef CBE_NO_SYNC
1303  // - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - -
1309  using UnShareDelegatePtr = std::shared_ptr<delegate::UnShareDelegate>;
1321  void unShare(cbe::ShareId shareId, UnShareDelegatePtr delegate);
1322 
1323 #ifndef CBE_NO_SYNC
1327  using UnShareException = delegate::UnShareDelegate::Exception;
1342  delegate::UnShareDelegate::Success unShare(cbe::ShareId shareId);
1343 
1350  using UnShareError = delegate::UnShareDelegate::ErrorInfo;
1372  cbe::util::Optional<delegate::UnShareDelegate::Success> unShare(
1373  cbe::ShareId shareId,
1374  UnShareError& error);
1375 #endif // #ifndef CBE_NO_SYNC
1376  // - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - -
1382  using PublishDelegatePtr = delegate::PublishDelegatePtr;
1397  void publish(cbe::PublishAccess security,
1398  cbe::PublishVisibility privacy,
1399  std::string description,
1400  std::string password,
1401  PublishDelegatePtr delegate);
1402 
1403 #ifndef CBE_NO_SYNC
1407  using PublishException = delegate::PublishDelegate::Exception;
1423  delegate::PublishSuccess publish(cbe::PublishAccess security,
1424  cbe::PublishVisibility privacy,
1425  std::string description,
1426  std::string password);
1427 
1435  using PublishError = delegate::PublishDelegate::ErrorInfo;
1458  cbe::util::Optional<delegate::PublishSuccess> publish(
1459  cbe::PublishAccess security,
1460  cbe::PublishVisibility privacy,
1461  std::string description,
1462  std::string password,
1463  PublishError& error);
1464 #endif // #ifndef CBE_NO_SYNC
1465  // - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - -
1466 
1472  using UnPublishDelegatePtr = delegate::UnPublishDelegatePtr;
1483  void unPublish(UnPublishDelegatePtr delegate);
1490 #ifndef CBE_NO_SYNC
1494  using UnPublishException = delegate::UnPublishDelegate::Exception;
1509  delegate::UnPublishSuccess unPublish();
1510 
1517  using UnPublishError = delegate::UnPublishDelegate::ErrorInfo;
1539  cbe::util::Optional<delegate::UnPublishSuccess> unPublish(
1540  UnPublishError& error);
1541 #endif // #ifndef CBE_NO_SYNC
1542  // - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - -
1548  using UnSubscribeDelegatePtr = delegate::UnSubscribeDelegatePtr;
1560  void unSubscribe(UnSubscribeDelegatePtr delegate);
1561 
1562 #ifndef CBE_NO_SYNC
1566  using UnSubscribeException = delegate::UnSubscribeDelegate::Exception;
1581  delegate::UnSubscribeSuccess unSubscribe();
1582 
1589  using UnSubscribeError = delegate::UnSubscribeDelegate::ErrorInfo;
1611  cbe::util::Optional<delegate::UnSubscribeSuccess> unSubscribe(
1612  UnSubscribeError& error);
1613 #endif // #ifndef CBE_NO_SYNC
1614  // - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - -
1615  Container(cbe::DefaultCtor);
1616 private:
1617  struct Impl;
1618  Impl& getImpl() const;
1619 
1620  friend class Account;
1621  friend class CloudBackend;
1622  friend class Database;
1623  friend class Filter;
1624  friend class Group;
1625  friend class QueryChain;
1626 
1627  Container(CBI::ContainerPtr cbiPeerPtr);
1628  // CBI::Container& getCbiPeer() const;
1629  CBI::ContainerPtr getCbiPeerPtr() const;
1630 }; // class Container
1631 
1632 } // namespace cbe
1633 
1634 #endif // INCLUDE_CBE_CONTAINER_H_
cbe::Account
Login account information.
Definition: Account.h:26
cbe::CloudBackend
The session that holds the connection with the cloud.
Definition: CloudBackend.h:47
cbe::Container
A collection of Item, can also represent a table or folder.
Definition: Container.h:63
cbe::Container::GetAclDelegatePtr
delegate::AclDelegatePtr GetAclDelegatePtr
Definition: Container.h:1163
cbe::Container::SetAclDelegatePtr
delegate::AclDelegatePtr SetAclDelegatePtr
Definition: Container.h:1087
cbe::Container::CreateObjectDelegatePtr
delegate::CreateObjectDelegatePtr CreateObjectDelegatePtr
Definition: Container.h:348
cbe::Container::getAcl
void getAcl(GetAclDelegatePtr delegate)
Retrieves its ACL map.
cbe::Container::unShare
void unShare(cbe::ShareId shareId, UnShareDelegatePtr delegate)
Revoke a previous share.
cbe::Container::query
cbe::QueryChainExt query(Filter filter, delegate::QueryJoinDelegatePtr delegate)
Select list of objects using filter, for join.
cbe::Container::query
cbe::QueryChain query(Filter filter, QueryDelegatePtr delegate)
Select list of objects using filter.
cbe::Container::upload
cbe::Object upload(const std::string &name, const std::string &path, UploadDelegatePtr delegate)
Create an object in current container by uploading a file.
cbe::Container::RenameDelegatePtr
delegate::container::RenameDelegatePtr RenameDelegatePtr
Definition: Container.h:211
cbe::Container::RemoveDelegatePtr
delegate::container::RemoveDelegatePtr RemoveDelegatePtr
Definition: Container.h:280
cbe::Container::UnPublishDelegatePtr
delegate::UnPublishDelegatePtr UnPublishDelegatePtr
Definition: Container.h:1472
cbe::Container::createObject
cbe::Object createObject(std::string name, cbe::KeyValues keyValues, CreateObjectDelegatePtr delegate)
Create a new object.
cbe::Container::rename
void rename(const std::string &name, RenameDelegatePtr delegate)
Change the name of the container.
cbe::Container::unSubscribe
void unSubscribe(UnSubscribeDelegatePtr delegate)
UnSubscribes from this container.
cbe::Container::UnShareDelegatePtr
std::shared_ptr< delegate::UnShareDelegate > UnShareDelegatePtr
Definition: Container.h:1309
cbe::Container::setAcl
void setAcl(cbe::AclMap aclMap, SetAclDelegatePtr delegate)
set ACL.
cbe::Container::search
cbe::QueryResult search(cbe::Filter filter, QueryDelegatePtr delegate)
Search using filter.
cbe::Container::ShareDelegatePtr
delegate::ShareDelegatePtr ShareDelegatePtr
Definition: Container.h:1230
cbe::Container::unPublish
void unPublish(UnPublishDelegatePtr delegate)
UnPublishes this container.
cbe::Container::query
cbe::QueryChain query(QueryDelegatePtr queryDelegate)
Select list of objects.
cbe::Container::query
cbe::QueryChainExt query(delegate::QueryJoinDelegatePtr delegate)
Select list of objects, for join.
cbe::Container::search
cbe::QueryResult search(std::string tags, QueryDelegatePtr delegate)
Search by tags.
cbe::Container::upload
cbe::Object upload(const std::string &name, std::uint64_t length, const char *byteData, UploadDelegatePtr delegate)
Upload from local memory to an object.
cbe::Container::remove
void remove(RemoveDelegatePtr delegate)
Delete the container.
cbe::Container::publish
void publish(cbe::PublishAccess security, cbe::PublishVisibility privacy, std::string description, std::string password, PublishDelegatePtr delegate)
Publishes a container and its content to any user.
cbe::Container::MoveDelegatePtr
delegate::container::MoveDelegatePtr MoveDelegatePtr
Definition: Container.h:140
cbe::Container::PublishDelegatePtr
delegate::PublishDelegatePtr PublishDelegatePtr
Definition: Container.h:1382
cbe::Container::share
void share(cbe::UserId toUserGroup, std::string description, ShareDelegatePtr delegate)
Make accessible by other user.
cbe::Container::CreateContainerDelegatePtr
delegate::CreateContainerDelegatePtr CreateContainerDelegatePtr
Definition: Container.h:70
cbe::Container::createContainer
cbe::Container createContainer(const std::string &name, CreateContainerDelegatePtr delegate)
Create a container.
cbe::Container::UnSubscribeDelegatePtr
delegate::UnSubscribeDelegatePtr UnSubscribeDelegatePtr
Definition: Container.h:1548
cbe::Container::QueryJoinDelegatePtr
std::shared_ptr< delegate::QueryJoinDelegate > QueryJoinDelegatePtr
Definition: Container.h:788
cbe::Container::UploadDelegatePtr
delegate::UploadDelegatePtr UploadDelegatePtr
Definition: Container.h:441
cbe::Container::upload
cbe::Object upload(const std::string &filePath, UploadDelegatePtr delegate)
Upload object to container with file given by filePath.
cbe::Container::queryWithPath
cbe::QueryChain queryWithPath(std::string relativePath, QueryDelegatePtr delegate)
Select list of objects in hierarchy.
cbe::Container::move
void move(cbe::ContainerId dstId, MoveDelegatePtr delegate)
Move a container to a different parent.
cbe::Container::createObject
cbe::Object createObject(std::string name, CreateObjectDelegatePtr delegate)
cbe::Container::QueryDelegatePtr
delegate::QueryDelegatePtr QueryDelegatePtr
Definition: Container.h:762
cbe::Database
A database.
Definition: Database.h:27
cbe::Filter
Use to select Item that meets specific criterias when doing a query.
Definition: Filter.h:40
cbe::Group
A group of members.
Definition: Group.h:42
cbe::Item
A set made up of Container and Object.
Definition: Item.h:36
cbe::Item::path
std::string path() const
cbe::Item::aclMap
AclMap aclMap() const
cbe::Item::description
std::string description() const
cbe::Item::name
std::string name() const
cbe::Object
Holder of a set of data, can represent a table row.
Definition: Object.h:64
cbe::QueryChainExt
Extension of class QueryChain.
Definition: QueryChain.h:150
cbe::QueryChain
To do a search for Object combining more than one Container table.
Definition: QueryChain.h:32
cbe::QueryResult
resultset of data retrieved.
Definition: QueryResult.h:51
cbe::delegate::AclDelegate
Definition: AclDelegate.h:22
cbe::delegate::PublishSuccess
Convenience type that bundles the parameter passed to method cbe::delegate::ShareDelegate::onShareSuc...
Definition: PublishSuccess.h:14
cbe::delegate::QueryJoinDelegate::ErrorInfo
QueryDelegate::ErrorInfo ErrorInfo
Definition: QueryJoinDelegate.h:47
cbe::delegate::ShareDelegate
Definition: ShareDelegate.h:20
cbe::delegate::ShareSuccess
Convenience type that bundles the parameter passed to method cbe::delegate::ShareDelegate::onShareSuc...
Definition: ShareDelegate.h:77
cbe::delegate::UnPublishSuccess
Convenience type that bundles all parameters passed to method cbe::delegate::UnPublishDelegate::onUnP...
Definition: UnPublishDelegate.h:77
cbe::delegate::UnShareDelegate
Definition: UnShareDelegate.h:20
cbe::delegate::UnShareSuccess
Convenience type that bundles the parameter passed to method cbe::delegate::ShareDelegate::onShareSuc...
Definition: UnShareDelegate.h:73
cbe::delegate::UnSubscribeSuccess
Convenience type that bundles all parameters passed to method cbe::delegate::UnSubscribeDelegate::onU...
Definition: UnSubscribeDelegate.h:76
cbe::delegate::container::RemoveSuccess
Convenience type that bundles all parameters passed to method cbe::delegate::container::RemoveDelegat...
Definition: RemoveDelegate.h:74
cbe::util::Optional
Class template Optional manages an optional contained value - i.e., a value that is either present or...
Definition: Optional.h:20
cbe::delegate::container::RemoveDelegatePtr
std::shared_ptr< RemoveDelegate > RemoveDelegatePtr
Definition: RemoveDelegate.h:67
cbe::delegate::container::RenameDelegatePtr
std::shared_ptr< RenameDelegate > RenameDelegatePtr
Definition: RenameDelegate.h:64
cbe::delegate::container::MoveDelegatePtr
std::shared_ptr< MoveDelegate > MoveDelegatePtr
Definition: MoveDelegate.h:64
cbe::delegate::ProgressEventFn
std::function< void(const ChunkTransferred &)> ProgressEventFn
Callback interface function that the CloudBackend SDK uses to indicate the progress of an upload/down...
Definition: ProgressEventFn.h:19
cbe::delegate::UnPublishDelegatePtr
std::shared_ptr< UnPublishDelegate > UnPublishDelegatePtr
Definition: UnPublishDelegate.h:70
cbe::delegate::ShareDelegatePtr
std::shared_ptr< ShareDelegate > ShareDelegatePtr
Definition: ShareDelegate.h:70
cbe::delegate::PublishDelegatePtr
std::shared_ptr< PublishDelegate > PublishDelegatePtr
Definition: PublishDelegate.h:66
cbe::delegate::CreateContainerDelegatePtr
std::shared_ptr< CreateContainerDelegate > CreateContainerDelegatePtr
Definition: CreateContainerDelegate.h:67
cbe::delegate::QueryJoinDelegatePtr
std::shared_ptr< QueryJoinDelegate > QueryJoinDelegatePtr
Definition: QueryJoinDelegate.h:76
cbe::delegate::AclDelegatePtr
std::shared_ptr< AclDelegate > AclDelegatePtr
Definition: AclDelegate.h:68
cbe::delegate::QueryDelegatePtr
std::shared_ptr< QueryDelegate > QueryDelegatePtr
Definition: QueryDelegate.h:100
cbe::delegate::CreateObjectDelegatePtr
std::shared_ptr< CreateObjectDelegate > CreateObjectDelegatePtr
Definition: CreateObjectDelegate.h:63
cbe::delegate::UploadDelegatePtr
std::shared_ptr< UploadDelegate > UploadDelegatePtr
Definition: UploadDelegate.h:83
cbe::delegate::UnSubscribeDelegatePtr
std::shared_ptr< UnSubscribeDelegate > UnSubscribeDelegatePtr
Definition: UnSubscribeDelegate.h:69
cbe
Root namespace for the CloudBackend SDK API.
Definition: Account.h:22
cbe::AclMap
std::map< cbe::AclGroupId, std::pair< cbe::Permissions, AclScope > > AclMap
ACL map (Access Control List) relating to users and groups.
Definition: Types.h:390
cbe::ShareId
std::uint64_t ShareId
Uniquely identifies a sharing of a cbe::Container or cbe::Object.
Definition: Types.h:113
cbe::UserId
std::uint64_t UserId
Uniquely identifies the CBE user number.
Definition: Types.h:126
cbe::ContainerId
std::uint64_t ContainerId
Unique Id of a cbe::Container.
Definition: Types.h:60
cbe::DefaultCtor
DefaultCtor
Default constructor marker.
Definition: Types.h:204
cbe::PublishVisibility
PublishVisibility
Definition: Types.h:357
cbe::PublishAccess
PublishAccess
Definition: Types.h:342
cbe::KeyValues
std::map< std::string, std::pair< std::string, bool > > KeyValues
Map with key/value pairs, a.k.a. metadata.
Definition: Types.h:417
cbe::delegate::AclDelegate::ErrorInfo
Definition: AclDelegate.h:41
cbe::delegate::CreateContainerDelegate::ErrorInfo
Definition: CreateContainerDelegate.h:41
cbe::delegate::CreateObjectDelegate::ErrorInfo
Definition: CreateObjectDelegate.h:41
cbe::delegate::PublishDelegate::ErrorInfo
Definition: PublishDelegate.h:38
cbe::delegate::QueryDelegate::ErrorInfo
Definition: QueryDelegate.h:61
cbe::delegate::ShareDelegate::ErrorInfo
Definition: ShareDelegate.h:42
cbe::delegate::UnPublishDelegate::ErrorInfo
Definition: UnPublishDelegate.h:42
cbe::delegate::UnShareDelegate::ErrorInfo
Definition: UnShareDelegate.h:38
cbe::delegate::UnSubscribeDelegate::ErrorInfo
Definition: UnSubscribeDelegate.h:41
cbe::delegate::UploadDelegate::ErrorInfo
Definition: UploadDelegate.h:57