The Account Info Data class. More...

Collaboration diagram for iberbox::AccountInfoData:

Public Types
enum	AccessLevel { RW_ACCESS = 0, RO_ACCESS = 1 }

Public Member Functions
	AccountInfoData ()
	Constructs a new Account Info Data object. More...

uint8_t	getAccessLevel () const

int	getAmount () const
	Gets the fee of the subscription for the current period. More...

int	getBalance () const
	Gets the balance of the account. More...

uint64_t	getCreationTime () const
	Gets the time when the account was created. More...

unsigned	getCrypto () const
	Gets the default cryto scheme. More...

int	getDiscount () const
	Gets the discount price over the fee of the subscription for the current period. More...

uint32_t	getFeatures () const
	Gets account features bitmap. More...

const AccountHandle &	getHandle () const
	Gets the handle of the account. More...

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

std::string	getName () const
	Gets the name of the account holder. More...

std::string	getNIF () const
	Gets the NIF of the account. More...

int	getPeriod () const
	Gets the period of the account subscription. More...

std::string	getPlan () const
	Gets the plan name. More...

std::string	getReferrerCode () const
	Gets the referrer code. More...

uint64_t	getRenewTime () const
	Gets the time when the account should be renewed. More...

uint64_t	getStatusId () const
	Gets the status identifier of the account. More...

const std::string &	getStringHandle () const
	Gets the string handle of the account. More...

int	getTotal () const
	Gets the total price of the subscription for the current period. More...

uint64_t	getTotalStorage () const
	Gets the total storage of the account. More...

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

int	getUpgrades () const
	Gets the upgrades of the account. More...

uint64_t	getUsedStorage () const
	Gets the used storage of the account. More...

bool	hasCredit () const
	Gets whether the account has credit or not. More...

bool	hasPaymentMethod () const
	Checks if the account has set up a payment method. More...

bool	isReseller () const
	Gets whether the account corresponds to a reseller or not. More...

virtual	~AccountInfoData ()
	Destroys the Account Info Data object. More...

Static Public Attributes
static const AccountHandle	INVALID_HANDLE

static const uint64_t	INVALID_ID

Detailed Description

The Account Info Data class.

Member Enumeration Documentation

◆ AccessLevel

enum iberbox::AccountInfoData::AccessLevel

Enumerator
RW_ACCESS
RO_ACCESS

Constructor & Destructor Documentation

◆ AccountInfoData()

iberbox::AccountInfoData::AccountInfoData ( )

Constructs a new Account Info Data object.

◆ ~AccountInfoData()

virtual iberbox::AccountInfoData::~AccountInfoData ( )

virtual

Destroys the Account Info Data object.

Member Function Documentation

◆ getAccessLevel()

uint8_t iberbox::AccountInfoData::getAccessLevel ( ) const

◆ getAmount()

int iberbox::AccountInfoData::getAmount ( ) const

Gets the fee of the subscription for the current period.

Returns: The fee of the subscription.

◆ getBalance()

int iberbox::AccountInfoData::getBalance ( ) const

Gets the balance of the account.

Returns: The account balance.

◆ getCreationTime()

uint64_t iberbox::AccountInfoData::getCreationTime ( ) const

Gets the time when the account was created.

Returns: The time when the account was created.

◆ getCrypto()

unsigned iberbox::AccountInfoData::getCrypto ( ) const

Gets the default cryto scheme.

◆ getDiscount()

int iberbox::AccountInfoData::getDiscount ( ) const

Gets the discount price over the fee of the subscription for the current period.

Returns: The discount price.

◆ getFeatures()

uint32_t iberbox::AccountInfoData::getFeatures ( ) const

Gets account features bitmap.

Returns: The account features bitmap.

◆ getHandle()

const AccountHandle& iberbox::AccountInfoData::getHandle ( ) const

Gets the handle of the account.

Returns: The account handle.

◆ getId()

uint64_t iberbox::AccountInfoData::getId ( ) const

Gets the identifier of the account.

Returns: The account identifier.

◆ getName()

std::string iberbox::AccountInfoData::getName ( ) const

Gets the name of the account holder.

The invoicing name (full name or company name).

Returns: The name of the account holder.

◆ getNIF()

std::string iberbox::AccountInfoData::getNIF ( ) const

Gets the NIF of the account.

Returns: The NIF of the account.

◆ getPeriod()

int iberbox::AccountInfoData::getPeriod ( ) const

Gets the period of the account subscription.

The valid period values are described by the SubscriptionPeriod enum.

Returns: The period of the account subscription.

◆ getPlan()

std::string iberbox::AccountInfoData::getPlan ( ) const

Gets the plan name.

Returns: The plan name.

◆ getReferrerCode()

std::string iberbox::AccountInfoData::getReferrerCode ( ) const

Gets the referrer code.

Returns: The referrer code.

◆ getRenewTime()

uint64_t iberbox::AccountInfoData::getRenewTime ( ) const

Gets the time when the account should be renewed.

Returns: The time when the account should be renewed.

◆ getStatusId()

uint64_t iberbox::AccountInfoData::getStatusId ( ) const

Gets the status identifier of the account.

Returns: The status identifier of the account

◆ getStringHandle()

const std::string& iberbox::AccountInfoData::getStringHandle ( ) const

Gets the string handle of the account.

Returns: The account string handle.

◆ getTotal()

int iberbox::AccountInfoData::getTotal ( ) const

Gets the total price of the subscription for the current period.

The total price is worked out subtracting the discount from the amount.

Returns: The total price.

◆ getTotalStorage()

uint64_t iberbox::AccountInfoData::getTotalStorage ( ) const

Gets the total storage of the account.

Returns: The total storage of the account.

◆ getType()

int iberbox::AccountInfoData::getType ( ) const

Gets the type of the account.

Returns: The account type.

◆ getUpgrades()

int iberbox::AccountInfoData::getUpgrades ( ) const

Gets the upgrades of the account.

Returns: The account upgrades.

◆ getUsedStorage()

uint64_t iberbox::AccountInfoData::getUsedStorage ( ) const

Gets the used storage of the account.

Returns: The used storage of the account.

◆ hasCredit()

bool iberbox::AccountInfoData::hasCredit ( ) const

Gets whether the account has credit or not.

Todo:

Returns: true if the account has any credit left.; false if the account has run out of credit.

◆ hasPaymentMethod()

bool iberbox::AccountInfoData::hasPaymentMethod ( ) const

Checks if the account has set up a payment method.

Returns: true if the account has set up a payment method.; false if the account has not set up a payment method.

◆ isReseller()

bool iberbox::AccountInfoData::isReseller ( ) const

Gets whether the account corresponds to a reseller or not.

Returns: true if the account corresponds to a reseller.; false if the account does not correspond to a reseller.

Member Data Documentation

◆ INVALID_HANDLE

const AccountHandle iberbox::AccountInfoData::INVALID_HANDLE

static

◆ INVALID_ID

const uint64_t iberbox::AccountInfoData::INVALID_ID