Collaboration diagram for iberbox::NodeData:

Public Types
enum	BackupStatus { BACKUP_STATUS_ENABLED = 0x00, BACKUP_STATUS_DISABLED = 0x01, BACKUP_STATUS_PENDING = 0x02 }
	The backup status enum. More...

enum	MetadataType { META_SIGNATURE = 0, META_THUMBNAIL = 1, META_PREVIEW = 2, META_LAST }
	The metadata type enum. More...

enum	NodeType { INVALID = -1, CLOUD_ROOT = 0, BACKUP_ROOT, RUBBISH_ROOT, REGISTER_ROOT, SHARED_ROOT, LAST_REGULAR_ROOT, SECRET_ROOT, CONTACT_ROOT, SHARED_DRIVE_ROOT, LAST_ROOT, FILE = 20, FOLDER, LAST_REGULAR, DEVICE = 40, BACKUP, SNAPSHOT, INBOX, RECORD, SHARE, CONTACT, OUTBOX, LAST }
	The node type enum. More...

enum	TagType { TAG_UNSET = 0, TAG_PERSONAL = 1, TAG_PUBLIC = 2, TAG_GENERAL = 3, TAG_CONFIDENTIAL = 4, TAG_HIGHLY_CONFIDENTIAL = 5, TAG_LAST }
	The tag type enum. More...

Public Member Functions
const std::string	getBase64Handle () const
	Gets the Base64 Handle object. More...

AccountHandle	getContactAccountHandle () const
	Gets the contact account handle. More...

uint64_t	getContactAccountId () const
	Gets the contact account id. More...

uint64_t	getCreationTime () const
	Gets the Creation Time object. More...

const char *	getCronExpr () const
	Gets the Cron Expr object. More...

const std::string	getCronExprString () const
	Gets the Cron Expr String object. More...

unsigned	getCrypto () const
	Gets the Crypto object. More...

uint8_t	getDepth () const
	Gets the depth of the node. More...

const char *	getDevice () const
	Gets the Device object. More...

const std::string	getDeviceNameString () const
	Gets the Device Name String object. More...

Error	getError () const

const char *	getErrorName () const

const std::string	getErrorNameString () const

int	getErrorType () const

std::vector< uint8_t > *	getExtraData () const
	Gets the extra data vector. More...

uint64_t	getExtraNumber () const
	Gets the extra number. More...

uint64_t	getFileCount () const
	Gets the File Count object. More...

uint64_t	getFilesystem () const
	Gets the Filesystem object. More...

std::vector< uint8_t > *	getFingerprint () const
	Gets the Fingerprint object. More...

uint64_t	getFinishTime () const
	Gets the Finish Time object. More...

uint64_t	getFolderCount () const
	Gets the Folder Count object. More...

std::vector< uint8_t > *	getFullHash () const
	Gets the Full Hash object. More...

const NodeHandle &	getHandle () const
	Gets the Handle object. More...

std::string	getHumanHash () const
	Gets the Human Hash object. More...

std::string	getHumanKey () const
	Gets the Human Key object. More...

uint64_t	getId () const
	Gets the identifier of the node. More...

std::vector< uint8_t > *	getInboxKey () const

const char *	getInboxMessage () const
	Gets the Inbox Message object. More...

const std::string	getInboxMessageString () const
	Gets the Inbox Message String object. More...

std::vector< uint8_t > *	getKey () const
	Gets the Key object. More...

const char *	getLocalPath () const
	Gets the Local Path object. More...

const std::string	getLocalPathString () const
	Gets the Local Path String object. More...

int	getMaxSnapshots () const
	Gets the maximum number of snapshots of the backup will be stored at a time. More...

const char *	getMessage () const
	Gets the Message object. More...

const std::string	getMessageString () const
	Gets the Message String object. More...

uint64_t	getMetadataHandle (int type)
	Gets the Metadata Handle object. More...

std::string	getMetadataInfo () const
	Gets the Metadata Info object. More...

uint8_t	getMetadataServer (int type)
	Gets the Metadata Server object. More...

uint64_t	getModificationtime () const
	Gets the Modificationtime object. More...

const char *	getName () const
	Gets the Name object. More...

const std::string	getNameString () const
	Gets the Name String object. More...

uint64_t	getNumericId () const
	Gets the Numeric Id object. More...

const char *	getOutboxInboxLink () const
	Gets the link of the inbox which this outbox refers to. More...

const std::string	getOutboxInboxLinkString () const
	Gets the link of the inbox which this outbox refers to. More...

const NodeHandle &	getParentHandle () const
	Gets the Parent Handle object. More...

uint64_t	getParentId () const
	Gets the Parent Id object. More...

std::vector< uint8_t > *	getPublicHandle () const

const char *	getRecordContactInfo () const
	Gets the Record Contact Info object. More...

const std::string	getRecordContactInfoString () const
	Gets the Record Contact Info String object. More...

const char *	getRecordInboxName () const
	Gets the name of the inbox this record belongs to. More...

const std::string	getRecordInboxNameString () const
	Gets the name of the inbox this record belongs to. More...

const char *	getRecordLink () const
	Gets the link to this record object. More...

const std::string	getRecordLinkString () const
	Gets the link to this record object. More...

const char *	getRecordMessage () const
	Gets the Record Message object. More...

const std::string	getRecordMessageString () const
	Gets the Record Message String object. More...

const char *	getRecordSubject () const
	Gets the Record Subject object. More...

const std::string	getRecordSubjectString () const
	Gets the Record Subject String object. More...

uint64_t	getSize () const
	Gets the Size object. More...

AccountHandle	getSourceHandle () const
	Gets the handle of the account that shared the drive. More...

std::vector< uint8_t > *	getSparseHash () const
	Gets the Sparse Hash object. More...

uint64_t	getStartTime () const
	Gets the Start Time object. More...

int	getStatus () const
	Gets the status of the node. More...

uint8_t	getTag () const
	Gets the tag of the node (file/folder) More...

uint64_t	getTransferErrorCount () const
	Gets the Transfer Error Count object. More...

int	getType () const
	Gets the type of the node. More...

const NodeHandle &	getVirtualParentHandle () const
	Gets the Virtual Parent Handle object. More...

bool	hasMetadataType (int type)

bool	isArchived () const
	Gets whether the shared drive is archived or not. More...

bool	isEnabled () const
	Gets whether the backup is enabled or not. More...

bool	isExternal () const
	Gets whether the node belongs to another account. More...

bool	isFile () const
	Gets whether the node is a file or not. More...

bool	isFolder () const
	Gets whether the node is a folder or not. More...

bool	isFull () const
	Gets whether node's descendants, if any, have been loaded locally. More...

bool	isMultipleRoot () const
	Gets whether the node is a root node which may co-exist with many of its same type. More...

bool	isPending () const
	Gets whether the backup is pending or not. More...

bool	isPublic () const
	Gets whether the node is public or not. More...

bool	isRoot () const
	Gets whether the node is a root node or not. More...

bool	isSynced () const
	Gets whether the node is being synced in a configured device. More...

virtual	~NodeData ()

Static Public Attributes
static const unsigned	DEFAULT_CRYPTO

static const NodeHandle	INVALID_HANDLE

static const uint64_t	INVALID_ID

static const std::string	INVALID_NAME

static const uint8_t	METADATA_SIZE

Member Enumeration Documentation

◆ BackupStatus

enum iberbox::NodeData::BackupStatus

The backup status enum.

Enumerator
BACKUP_STATUS_ENABLED
BACKUP_STATUS_DISABLED
BACKUP_STATUS_PENDING

◆ MetadataType

enum iberbox::NodeData::MetadataType

The metadata type enum.

Enumerator
META_SIGNATURE
META_THUMBNAIL
META_PREVIEW
META_LAST

◆ NodeType

enum iberbox::NodeData::NodeType

The node type enum.

Enumerator
INVALID
CLOUD_ROOT
BACKUP_ROOT
RUBBISH_ROOT
REGISTER_ROOT
SHARED_ROOT
LAST_REGULAR_ROOT
SECRET_ROOT
CONTACT_ROOT
SHARED_DRIVE_ROOT
LAST_ROOT
FILE
FOLDER
LAST_REGULAR
DEVICE
BACKUP
SNAPSHOT
INBOX
RECORD
SHARE
CONTACT
OUTBOX
LAST

◆ TagType

enum iberbox::NodeData::TagType

The tag type enum.

Enumerator
TAG_UNSET
TAG_PERSONAL
TAG_PUBLIC
TAG_GENERAL
TAG_CONFIDENTIAL
TAG_HIGHLY_CONFIDENTIAL
TAG_LAST

Constructor & Destructor Documentation

◆ ~NodeData()

virtual iberbox::NodeData::~NodeData ( )

virtual

Member Function Documentation

◆ getBase64Handle()

const std::string iberbox::NodeData::getBase64Handle ( ) const

Gets the Base64 Handle object.

Todo:

Returns: const std::string&

◆ getContactAccountHandle()

AccountHandle iberbox::NodeData::getContactAccountHandle ( ) const

Gets the contact account handle.

Returns: AccountHandle

◆ getContactAccountId()

uint64_t iberbox::NodeData::getContactAccountId ( ) const

Gets the contact account id.

Returns: uint64_t

◆ getCreationTime()

uint64_t iberbox::NodeData::getCreationTime ( ) const

Gets the Creation Time object.

Todo:

Returns: uint64_t

◆ getCronExpr()

const char* iberbox::NodeData::getCronExpr ( ) const

Gets the Cron Expr object.

Todo:

Returns: const char*

◆ getCronExprString()

const std::string iberbox::NodeData::getCronExprString ( ) const

Gets the Cron Expr String object.

Todo:

Returns: const std::string

◆ getCrypto()

unsigned iberbox::NodeData::getCrypto ( ) const

Gets the Crypto object.

Todo:

Returns: unsigned

◆ getDepth()

uint8_t iberbox::NodeData::getDepth ( ) const

Gets the depth of the node.

Returns: uint8_t

◆ getDevice()

const char* iberbox::NodeData::getDevice ( ) const

Gets the Device object.

Todo:

Returns: const char*

◆ getDeviceNameString()

const std::string iberbox::NodeData::getDeviceNameString ( ) const

Gets the Device Name String object.

Todo:

Returns: const std::string

◆ getError()

Error iberbox::NodeData::getError ( ) const

◆ getErrorName()

const char* iberbox::NodeData::getErrorName ( ) const

◆ getErrorNameString()

const std::string iberbox::NodeData::getErrorNameString ( ) const

◆ getErrorType()

int iberbox::NodeData::getErrorType ( ) const

◆ getExtraData()

std::vector<uint8_t>* iberbox::NodeData::getExtraData ( ) const

Gets the extra data vector.

Returns: std::vector<uint8_t>*

◆ getExtraNumber()

uint64_t iberbox::NodeData::getExtraNumber ( ) const

Gets the extra number.

Returns: uint64_t

◆ getFileCount()

uint64_t iberbox::NodeData::getFileCount ( ) const

Gets the File Count object.

Todo:

Returns: uint64_t

◆ getFilesystem()

uint64_t iberbox::NodeData::getFilesystem ( ) const

Gets the Filesystem object.

Todo:

Returns: uint64_t

◆ getFingerprint()

std::vector<uint8_t>* iberbox::NodeData::getFingerprint ( ) const

Gets the Fingerprint object.

Todo:

Returns: std::vector<uint8_t>*

◆ getFinishTime()

uint64_t iberbox::NodeData::getFinishTime ( ) const

Gets the Finish Time object.

Todo:

Returns: uint64_t

◆ getFolderCount()

uint64_t iberbox::NodeData::getFolderCount ( ) const

Gets the Folder Count object.

Todo:

Returns: uint64_t

◆ getFullHash()

std::vector<uint8_t>* iberbox::NodeData::getFullHash ( ) const

Gets the Full Hash object.

Todo:

Returns: std::vector<uint8_t>*

◆ getHandle()

const NodeHandle& iberbox::NodeData::getHandle ( ) const

Gets the Handle object.

Todo:

Returns: const NodeHandle&

◆ getHumanHash()

std::string iberbox::NodeData::getHumanHash ( ) const

Gets the Human Hash object.

Todo:

Returns: std::string

◆ getHumanKey()

std::string iberbox::NodeData::getHumanKey ( ) const

Gets the Human Key object.

Todo:

Returns: std::string

◆ getId()

uint64_t iberbox::NodeData::getId ( ) const

Gets the identifier of the node.

Returns: The node identifier.

◆ getInboxKey()

std::vector<uint8_t>* iberbox::NodeData::getInboxKey ( ) const

◆ getInboxMessage()

const char* iberbox::NodeData::getInboxMessage ( ) const

Gets the Inbox Message object.

Todo:

Returns: const char*

◆ getInboxMessageString()

const std::string iberbox::NodeData::getInboxMessageString ( ) const

Gets the Inbox Message String object.

Todo:

Returns: const std::string

◆ getKey()

std::vector<uint8_t>* iberbox::NodeData::getKey ( ) const

Gets the Key object.

Todo:

Returns: std::vector<uint8_t>*

◆ getLocalPath()

const char* iberbox::NodeData::getLocalPath ( ) const

Gets the Local Path object.

Todo:

Returns: const char*

◆ getLocalPathString()

const std::string iberbox::NodeData::getLocalPathString ( ) const

Gets the Local Path String object.

Todo:

Returns: const std::string

◆ getMaxSnapshots()

int iberbox::NodeData::getMaxSnapshots ( ) const

Gets the maximum number of snapshots of the backup will be stored at a time.

Todo:

Returns: The maximum number of snapshots for a backup.

◆ getMessage()

const char* iberbox::NodeData::getMessage ( ) const

Gets the Message object.

Todo:

Returns: const char*

◆ getMessageString()

const std::string iberbox::NodeData::getMessageString ( ) const

Gets the Message String object.

Todo:

Returns: const std::string

◆ getMetadataHandle()

uint64_t iberbox::NodeData::getMetadataHandle ( int type )

Gets the Metadata Handle object.

Todo:

Parameters

type

Returns: uint64_t

◆ getMetadataInfo()

std::string iberbox::NodeData::getMetadataInfo ( ) const

Gets the Metadata Info object.

Todo:

Returns: std::string

◆ getMetadataServer()

uint8_t iberbox::NodeData::getMetadataServer ( int type )

Gets the Metadata Server object.

Todo:

Parameters

type

Returns: uint8_t

◆ getModificationtime()

uint64_t iberbox::NodeData::getModificationtime ( ) const

Gets the Modificationtime object.

Todo:

Returns: uint64_t

◆ getName()

const char* iberbox::NodeData::getName ( ) const

Gets the Name object.

Todo:

Returns: const char*

◆ getNameString()

const std::string iberbox::NodeData::getNameString ( ) const

Gets the Name String object.

Todo:

Returns: const std::string

◆ getNumericId()

uint64_t iberbox::NodeData::getNumericId ( ) const

Gets the Numeric Id object.

Todo:

Returns: uint64_t

◆ getOutboxInboxLink()

const char* iberbox::NodeData::getOutboxInboxLink ( ) const

Gets the link of the inbox which this outbox refers to.

Returns: const char*

◆ getOutboxInboxLinkString()

const std::string iberbox::NodeData::getOutboxInboxLinkString ( ) const

Gets the link of the inbox which this outbox refers to.

Returns: const std::string

◆ getParentHandle()

const NodeHandle& iberbox::NodeData::getParentHandle ( ) const

Gets the Parent Handle object.

Todo:

Returns: const NodeHandle&

◆ getParentId()

uint64_t iberbox::NodeData::getParentId ( ) const

Gets the Parent Id object.

Todo:

Returns: uint64_t

◆ getPublicHandle()

std::vector<uint8_t>* iberbox::NodeData::getPublicHandle ( ) const

◆ getRecordContactInfo()

const char* iberbox::NodeData::getRecordContactInfo ( ) const

Gets the Record Contact Info object.

Todo:

Returns: const char*

◆ getRecordContactInfoString()

const std::string iberbox::NodeData::getRecordContactInfoString ( ) const

Gets the Record Contact Info String object.

Todo:

Returns: const std::string

◆ getRecordInboxName()

const char* iberbox::NodeData::getRecordInboxName ( ) const

Gets the name of the inbox this record belongs to.

Returns: const char*

◆ getRecordInboxNameString()

const std::string iberbox::NodeData::getRecordInboxNameString ( ) const

Gets the name of the inbox this record belongs to.

Returns: const std::string

◆ getRecordLink()

const char* iberbox::NodeData::getRecordLink ( ) const

Gets the link to this record object.

Returns: const char*

◆ getRecordLinkString()

const std::string iberbox::NodeData::getRecordLinkString ( ) const

Gets the link to this record object.

Returns: const std::string

◆ getRecordMessage()

const char* iberbox::NodeData::getRecordMessage ( ) const

Gets the Record Message object.

Todo:

Returns: const char*

◆ getRecordMessageString()

const std::string iberbox::NodeData::getRecordMessageString ( ) const

Gets the Record Message String object.

Todo:

Returns: const std::string

◆ getRecordSubject()

const char* iberbox::NodeData::getRecordSubject ( ) const

Gets the Record Subject object.

Todo:

Returns: const char*

◆ getRecordSubjectString()

const std::string iberbox::NodeData::getRecordSubjectString ( ) const

Gets the Record Subject String object.

Todo:

Returns: const std::string

◆ getSize()

uint64_t iberbox::NodeData::getSize ( ) const

Gets the Size object.

Todo:

Returns: uint64_t

◆ getSourceHandle()

AccountHandle iberbox::NodeData::getSourceHandle ( ) const

Gets the handle of the account that shared the drive.

Node must be an external SHARED_DRIVE_ROOT.

Returns: The account handle

◆ getSparseHash()

std::vector<uint8_t>* iberbox::NodeData::getSparseHash ( ) const

Gets the Sparse Hash object.

Todo:

Returns: std::vector<uint8_t>*

◆ getStartTime()

uint64_t iberbox::NodeData::getStartTime ( ) const

Gets the Start Time object.

Todo:

Returns: uint64_t

◆ getStatus()

int iberbox::NodeData::getStatus ( ) const

Gets the status of the node.

Todo:

Returns: int

◆ getTag()

uint8_t iberbox::NodeData::getTag ( ) const

Gets the tag of the node (file/folder)

Returns: uint8_t

◆ getTransferErrorCount()

uint64_t iberbox::NodeData::getTransferErrorCount ( ) const

Gets the Transfer Error Count object.

Todo:

Returns: uint64_t

◆ getType()

int iberbox::NodeData::getType ( ) const

Gets the type of the node.

The valid node type values are described by NodeData::NodeType.

Returns: The node type.

◆ getVirtualParentHandle()

const NodeHandle& iberbox::NodeData::getVirtualParentHandle ( ) const

Gets the Virtual Parent Handle object.

Todo:

Returns: const NodeHandle&

◆ hasMetadataType()

bool iberbox::NodeData::hasMetadataType ( int type )

Todo:

Parameters

type

Returns: true; false

◆ isArchived()

bool iberbox::NodeData::isArchived ( ) const

Gets whether the shared drive is archived or not.

If the node is not a shared drive, then it cannot be archived.

Returns: true If the node is a shared drive and it is archived.; false If the node is not a shared drive or it is nor archived.

◆ isEnabled()

bool iberbox::NodeData::isEnabled ( ) const

Gets whether the backup is enabled or not.

Only used when the node represents a backup.

Returns: true if the backup is enabled.; false if the backup is not enabled.

◆ isExternal()

bool iberbox::NodeData::isExternal ( ) const

Gets whether the node belongs to another account.

Node must be a SHARED_DRIVE_ROOT.

Returns: true The shared drive node belongs to another account and was shared with the current account.; false The shared drive node belongs to the current account.

◆ isFile()

bool iberbox::NodeData::isFile ( ) const

Gets whether the node is a file or not.

Returns: true if the node is a file.; false if the node is not a file.

◆ isFolder()

bool iberbox::NodeData::isFolder ( ) const

Gets whether the node is a folder or not.

Returns: true if the node is a folder.; false if the node is not a folder.

◆ isFull()

bool iberbox::NodeData::isFull ( ) const

Gets whether node's descendants, if any, have been loaded locally.

Returns: true if node's descendants, if any, have been loaded locally.; false if node's descendants, if any, haven't been loaded locally yet.

◆ isMultipleRoot()

bool iberbox::NodeData::isMultipleRoot ( ) const

Gets whether the node is a root node which may co-exist with many of its same type.

Returns: true; false

◆ isPending()

bool iberbox::NodeData::isPending ( ) const

Gets whether the backup is pending or not.

Only used when the node represents a backup.

Returns: true if the backup is pending.; false if the backup is not pending.

◆ isPublic()

bool iberbox::NodeData::isPublic ( ) const

Gets whether the node is public or not.

Returns: true if the node is public.; false if the node is private.

◆ isRoot()

bool iberbox::NodeData::isRoot ( ) const

Gets whether the node is a root node or not.

Returns: true if the node is a root node.; false if the node is not a root node.

◆ isSynced()

bool iberbox::NodeData::isSynced ( ) const

Gets whether the node is being synced in a configured device.

Node must be a FOLDER.

Returns: true The folder is being synced in a configured device.; false The folder is not being synced in any device.

Member Data Documentation

◆ DEFAULT_CRYPTO

const unsigned iberbox::NodeData::DEFAULT_CRYPTO

static

◆ INVALID_HANDLE

const NodeHandle iberbox::NodeData::INVALID_HANDLE

static

◆ INVALID_ID

const uint64_t iberbox::NodeData::INVALID_ID

static

◆ INVALID_NAME

const std::string iberbox::NodeData::INVALID_NAME

static

◆ METADATA_SIZE

const uint8_t iberbox::NodeData::METADATA_SIZE

static

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

node.h

Public Types

Public Member Functions

Static Public Attributes

Member Enumeration Documentation

◆ BackupStatus

◆ MetadataType

◆ NodeType

◆ TagType

Constructor & Destructor Documentation

◆ ~NodeData()

Member Function Documentation

◆ getBase64Handle()

◆ getContactAccountHandle()

◆ getContactAccountId()

◆ getCreationTime()

◆ getCronExpr()

◆ getCronExprString()

◆ getCrypto()

◆ getDepth()

◆ getDevice()

◆ getDeviceNameString()

◆ getError()

◆ getErrorName()

◆ getErrorNameString()

◆ getErrorType()

◆ getExtraData()

◆ getExtraNumber()

◆ getFileCount()

◆ getFilesystem()

◆ getFingerprint()

◆ getFinishTime()

◆ getFolderCount()

◆ getFullHash()

◆ getHandle()

◆ getHumanHash()

◆ getHumanKey()

◆ getId()

◆ getInboxKey()

◆ getInboxMessage()

◆ getInboxMessageString()

◆ getKey()

◆ getLocalPath()

◆ getLocalPathString()

◆ getMaxSnapshots()

◆ getMessage()

◆ getMessageString()

◆ getMetadataHandle()

◆ getMetadataInfo()

◆ getMetadataServer()

◆ getModificationtime()

◆ getName()

◆ getNameString()

◆ getNumericId()

◆ getOutboxInboxLink()

◆ getOutboxInboxLinkString()

◆ getParentHandle()

◆ getParentId()

◆ getPublicHandle()

◆ getRecordContactInfo()

◆ getRecordContactInfoString()

◆ getRecordInboxName()

◆ getRecordInboxNameString()

◆ getRecordLink()

◆ getRecordLinkString()

◆ getRecordMessage()

◆ getRecordMessageString()

◆ getRecordSubject()

◆ getRecordSubjectString()

◆ getSize()

◆ getSourceHandle()

◆ getSparseHash()

◆ getStartTime()

◆ getStatus()

◆ getTag()

◆ getTransferErrorCount()

◆ getType()

◆ getVirtualParentHandle()

◆ hasMetadataType()

◆ isArchived()

◆ isEnabled()