iberbox  2.1.2
iberbox::SubscriptionInfoData Class Reference

The Subscription Info Data class. More...

Collaboration diagram for iberbox::SubscriptionInfoData:

Public Types

enum  FeatureType { FEATURE_BMAIL = 0x01, FEATURE_BACKUP = 0x02, FEATURE_CLOUD = 0x04, FEATURE_SECRETS = 0x08 }
 The Feature Type enum. More...
 
enum  SubscriptionPeriod { SP_NONE = 0, SP_MONTHLY = 1, SP_YEARLY = 2 }
 The Subscription Period enum. More...
 

Public Member Functions

int getAmount () const
 Gets the fee of the subscription for the current period. 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...
 
int getId () const
 Gets the identifier of the subscription. More...
 
std::string getName () const
 Gets the name of the subscription option. More...
 
int getPeriod () const
 Gets the subscription period. More...
 
uint64_t getStorage () const
 Gets the contracted storage with the subscription. More...
 
int getTotal () const
 Gets the total price of the subscription for the current period. More...
 
int getType () const
 Gets the type of the subscription. More...
 
 SubscriptionInfoData ()
 Constructs a new Subscription Info Data object. More...
 
virtual ~SubscriptionInfoData ()
 Destroys the Subscription Info Data object. More...
 

Detailed Description

The Subscription Info Data class.

Member Enumeration Documentation

◆ FeatureType

The Feature Type enum.

Describes the different features an account may have.

Enumerator
FEATURE_BMAIL 

Bmail feature.

FEATURE_BACKUP 

Backup feature.

FEATURE_CLOUD 

Cloud feature.

FEATURE_SECRETS 

Secret spaces feature.

◆ SubscriptionPeriod

The Subscription Period enum.

Describes the different periods of subscription available.

Enumerator
SP_NONE 

No subscription period.

SP_MONTHLY 

Monthly subscription.

SP_YEARLY 

Yearly subscription.

Constructor & Destructor Documentation

◆ SubscriptionInfoData()

iberbox::SubscriptionInfoData::SubscriptionInfoData ( )

Constructs a new Subscription Info Data object.

◆ ~SubscriptionInfoData()

virtual iberbox::SubscriptionInfoData::~SubscriptionInfoData ( )
virtual

Destroys the Subscription Info Data object.

Member Function Documentation

◆ getAmount()

int iberbox::SubscriptionInfoData::getAmount ( ) const

Gets the fee of the subscription for the current period.

Returns
The fee of the subscription.

◆ getDiscount()

int iberbox::SubscriptionInfoData::getDiscount ( ) const

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

Returns
The discount price.

◆ getFeatures()

uint32_t iberbox::SubscriptionInfoData::getFeatures ( ) const

Gets account features bitmap.

Returns
The account features bitmap.

◆ getId()

int iberbox::SubscriptionInfoData::getId ( ) const

Gets the identifier of the subscription.

Returns
The supscription identifier.

◆ getName()

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

Gets the name of the subscription option.

Returns
The name of the subscription option.

◆ getPeriod()

int iberbox::SubscriptionInfoData::getPeriod ( ) const

Gets the subscription period.

The valid period values are described by the SubscriptionPeriod enum.

Returns
The subcription period.

◆ getStorage()

uint64_t iberbox::SubscriptionInfoData::getStorage ( ) const

Gets the contracted storage with the subscription.

Returns
The contracted storage.

◆ getTotal()

int iberbox::SubscriptionInfoData::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.

◆ getType()

int iberbox::SubscriptionInfoData::getType ( ) const

Gets the type of the subscription.

Returns
The subscription type.

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