mcloud  1.0.0
MCloud API library for cmcc cloud service
mcloud::api::CloudFolder Class Reference

CloudFolder represents a folder object on mcloud. More...

#include <cloudfolder.h>

+ Inheritance diagram for mcloud::api::CloudFolder:
+ Collaboration diagram for mcloud::api::CloudFolder:

Public Types

enum  Type {
  Type::Normal = 0,
  Type::Pictures,
  Type::Music,
  Type::Videos,
  Type::Message,
  Type::Docs,
  Type::App,
  Type::Sync
}
 
typedef std::shared_ptr< CloudFolderPtr
 
- Public Types inherited from mcloud::api::CloudResource
enum  Property {
  Property::Content,
  Property::Folder
}
 
typedef std::shared_ptr< CloudResourcePtr
 

Public Member Functions

virtual ~CloudFolder ()=default
 
const std::string & id () const override
 Returns a unique id of cloud folder object. More...
 
const std::string & name () const override
 Returns the name of cloud folder object. More...
 
const std::time_t & created_date () const override
 Returns the datetime when folder was created. More...
 
const std::time_t & updated_date () const override
 Returns the datetime when folder was updated. More...
 
const std::string & parent_catalog_id () const override
 Returns a unique id of the parent folder. More...
 
const std::string & etag () const override
 Returns etag of a folder object. More...
 
const std::string & owner () const override
 Returns owner id of a folder object. More...
 
CloudResource::Property property () const override
 Returns resource property of an object. More...
 
Type folder_type () const
 Returns type of this folder object. More...
 
const std::string & folder_path () const
 Returns a current folder's path. More...
 
- Public Member Functions inherited from mcloud::api::CloudResource
virtual ~CloudResource ()=default
 

Friends

class ClientPriv
 

Detailed Description

CloudFolder represents a folder object on mcloud.

Definition at line 37 of file cloudfolder.h.

Member Typedef Documentation

typedef std::shared_ptr<CloudFolder> mcloud::api::CloudFolder::Ptr

Definition at line 50 of file cloudfolder.h.

Member Enumeration Documentation

Enumerator
Normal 
Pictures 
Music 
Videos 
Message 
Docs 
App 
Sync 

Definition at line 39 of file cloudfolder.h.

Constructor & Destructor Documentation

virtual mcloud::api::CloudFolder::~CloudFolder ( )
virtualdefault

Member Function Documentation

const std::time_t& mcloud::api::CloudFolder::created_date ( ) const
overridevirtual

Returns the datetime when folder was created.

Implements mcloud::api::CloudResource.

const std::string& mcloud::api::CloudFolder::etag ( ) const
overridevirtual

Returns etag of a folder object.

Implements mcloud::api::CloudResource.

const std::string& mcloud::api::CloudFolder::folder_path ( ) const

Returns a current folder's path.

Type mcloud::api::CloudFolder::folder_type ( ) const

Returns type of this folder object.

See also
Type
const std::string& mcloud::api::CloudFolder::id ( ) const
overridevirtual

Returns a unique id of cloud folder object.

Implements mcloud::api::CloudResource.

const std::string& mcloud::api::CloudFolder::name ( ) const
overridevirtual

Returns the name of cloud folder object.

Implements mcloud::api::CloudResource.

const std::string& mcloud::api::CloudFolder::owner ( ) const
overridevirtual

Returns owner id of a folder object.

Implements mcloud::api::CloudResource.

const std::string& mcloud::api::CloudFolder::parent_catalog_id ( ) const
overridevirtual

Returns a unique id of the parent folder.

Implements mcloud::api::CloudResource.

CloudResource::Property mcloud::api::CloudFolder::property ( ) const
overridevirtual

Returns resource property of an object.

See also
CloudResource::Property

Implements mcloud::api::CloudResource.

const std::time_t& mcloud::api::CloudFolder::updated_date ( ) const
overridevirtual

Returns the datetime when folder was updated.

Implements mcloud::api::CloudResource.

Friends And Related Function Documentation

friend class ClientPriv
friend

Definition at line 109 of file cloudfolder.h.


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