C++  1.4.6
CloudBackend Software Development Kit - SDK API for C++
Public Member Functions | List of all members
CBE::Item Class Reference
Inheritance diagram for CBE::Item:
Inheritance graph
[legend]

Public Member Functions

virtual std::map< uint64_t, std::vector< CBE::ShareData > > getShareIds () const
 
virtual CBE::share_id_t getShareFromUserId (user_id_t userId)
 
virtual CBE::user_id_t getUserFromShareId (user_id_t shareId)
 
virtual std::string aclTag () const
 
virtual std::string description () const
 
virtual CBE::item_id_t id () const
 
virtual CBE::container_id_t parentId () const
 
virtual CBE::container_id_t oldParentId () const
 
virtual std::string name () const
 
virtual std::string path () const
 
virtual CBE::user_id_t ownerId () const
 
virtual CBE::container_id_t driveId () const
 
virtual std::string username () const
 
virtual bool idLoaded () const
 
virtual bool dataLoaded () const
 
virtual CBE::date_t created () const
 
virtual CBE::date_t updated () const
 
virtual CBE::date_t deleted () const
 
virtual CBE::item_t type () const
 
virtual bool operator< (const CBE::Item &other) const
 
std::map< uint64_t, CBE::permission_status_t > ACLMap () const
 
virtual ~Item ()
 

Member Function Documentation

◆ getShareIds()

virtual std::map<uint64_t, std::vector<CBE::ShareData> > CBE::Item::getShareIds ( ) const
virtual

Get the Share Ids object.

Returns
std::map<uint64_t, std::vector<CBE::ShareData>>

◆ getShareFromUserId()

virtual CBE::share_id_t CBE::Item::getShareFromUserId ( user_id_t  userId)
virtual

Get the shareId from userId.

Returns
CBE::share_id_t

◆ getUserFromShareId()

virtual CBE::user_id_t CBE::Item::getUserFromShareId ( user_id_t  shareId)
virtual

Get the shareId from userId.

Returns
CBE::user_id_t

◆ aclTag()

virtual std::string CBE::Item::aclTag ( ) const
virtual

Get the ACL tag of the item.

Returns
std::string

◆ description()

virtual std::string CBE::Item::description ( ) const
virtual

Get a description of the item if it is available.

Returns
std::string

◆ id()

virtual CBE::item_id_t CBE::Item::id ( ) const
virtual

Returns an Items id.

Returns
CBE::item_id_t

◆ parentId()

virtual CBE::container_id_t CBE::Item::parentId ( ) const
virtual

Returns the id of the Items parent.

Returns
CBE::container_id_t

◆ oldParentId()

virtual CBE::container_id_t CBE::Item::oldParentId ( ) const
virtual

gets the numerical id of the old parent container in case it has moved.

Returns
CBE::container_id_t

◆ name()

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

Returns the name (title) of the item.

Returns
std::string

◆ path()

virtual std::string CBE::Item::path ( ) const
virtual

Returns the path if it is available.

Returns
std::string

◆ ownerId()

virtual CBE::user_id_t CBE::Item::ownerId ( ) const
virtual

Returns the owner id.

Returns
CBE::user_id_t

◆ driveId()

virtual CBE::container_id_t CBE::Item::driveId ( ) const
virtual

Returns which drive the container resides on. For future implementation.

Returns
CBE::container_id_t

◆ username()

virtual std::string CBE::Item::username ( ) const
virtual

Returns the username of a Containers' owner.

Returns
std::string

◆ idLoaded()

virtual bool CBE::Item::idLoaded ( ) const
virtual

has anything been loaded?

Returns
true
false

◆ dataLoaded()

virtual bool CBE::Item::dataLoaded ( ) const
virtual

data loaded

Returns
true
false

◆ created()

virtual CBE::date_t CBE::Item::created ( ) const
virtual

Returns the creation date and time in Epoch Unix timestamp.

Returns
CBE::date_t

◆ updated()

virtual CBE::date_t CBE::Item::updated ( ) const
virtual

Returns the updated date and time in Epoch Unix timestamp.

Returns
CBE::date_t

◆ deleted()

virtual CBE::date_t CBE::Item::deleted ( ) const
virtual

Returns the delete date and time in Epoch Unix timestamp if object was removed.

Returns
CBE::date_t

◆ type()

virtual CBE::item_t CBE::Item::type ( ) const
virtual

Container or Object.

Returns
CBE::item_t

◆ operator<()

virtual bool CBE::Item::operator< ( const CBE::Item other) const
virtual

operator <

Parameters
otherItem pointer
Returns
true
false

◆ ACLMap()

std::map<uint64_t, CBE::permission_status_t> CBE::Item::ACLMap ( ) const

Type definition of the ACL map.

Returns
std::map<uint64_t, CBE::permission_status_t>

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