iberbox  2.1.2
iberbox::ActionData Class Reference

The Action Data class. More...

Collaboration diagram for iberbox::ActionData:

Public Types

enum  ActionType {
  TEST, ADD_CONTACT, VERIFY_EMAIL, FORGOT_PASSWORD,
  CREATE_ACCOUNT, CHANGE_PASSWORD, RECOVERY_KEY, MANAGE_2FA,
  LOGIN, GET_NODES, GET_ROOT, GET_CHILDREN,
  GET_NODE, GET_PATH, ADD_NODES, DELETE_NODE,
  RENAME_NODE, MOVE_NODE, COPY_NODE, CREATE_LINK,
  GET_LINK_INFO, USER_INFO, ACCOUNT_INFO, LOG_EVENT,
  TEST_PROXY, SET_PROXY, UPLOAD, DOWNLOAD,
  DOWNLOAD_ZIP, STREAM, BACKUP, UPLOAD_METADATA,
  DOWNLOAD_METADATA, GET_TRANSFERS, CLEAR_FINISHED_TRANSFERS, CANCEL_TRANSFERS,
  SET_TRANSFER_SPEED_LIMIT, GET_TRANSFER_SPEED_LIMIT, REGISTER_DEVICE, SELECT_DEVICE,
  GET_CURRENT_DEVICE, GET_DEVICE, GET_DEVICES, RENAME_DEVICE,
  DELETE_DEVICE, GET_BACKUP, GET_BACKUPS, CREATE_BACKUP,
  MODIFY_BACKUP, RENAME_BACKUP, CHANGE_BACKUP_SCHEDULE, CHANGE_BACKUP_PATH,
  CHANGE_BACKUP_STATUS, DELETE_BACKUP, AUTHORIZE_BACKUP, GET_SNAPSHOTS,
  GET_NEXT_SNAPSHOTS, GET_NEXT_SNAPSHOTS_BY_DEVICE, GET_NEXT_SNAPSHOTS_BY_BACKUP, GET_NEXT_SNAPSHOTS_BY_ACCOUNT,
  GET_NEXT_SNAPSHOTS_BY_SCHEDULE, GET_LAST_SNAPSHOTS, GET_LAST_SNAPSHOTS_BY_DEVICE, GET_LAST_SNAPSHOTS_BY_BACKUP,
  GET_LAST_SNAPSHOTS_BY_ACCOUNT, CREATE_INBOX, SET_INBOX_INFO, GET_INBOX_INFO,
  LOGIN_LINK, SET_RECORD_INFO, UPLOAD_TO_RECORD, REMOVE_FROM_RECORD,
  GET_RECORD_INFO, SET_RECORD_STATUS, SUBSCRIPTION_OPTIONS, PAYMENT_INFO,
  REMOVE_PAYMENT_METHOD, SET_INVOICING_ADDRESS, INVOICING_INFO, GET_INVOICE,
  SESSION_INFO, LOGOUT_LINK, CRASH_REPORT, UPDATE,
  LOGOUT, CURRENT_EMAIL, NEW_SESSION, DESTROY,
  REFERRALS_INFO, BALANCES_INFO, COUPONS, ADD_PAYMENT_METHOD,
  JOIN_LINK, DEFAULT_ACCOUNT, REVOKE_ACCOUNT_ACCESS, MANAGE_SECRETS,
  MANAGE_CONTACTS, MANAGE_OUTBOXES, MANAGE_SENT_RECORDS, GET_NODE_TREE,
  SET_ACCOUNT_VALUE, DELETE_ACCOUNT, SET_ACCESS_LEVEL, MANAGE_SHARED_DRIVES,
  DELETE_LINK, MANAGE_MEETINGS, MANAGE_NODE_TAG, GET_COMMANDS_LOG,
  VERIFY_HASH, NOTICE_CREDENTIALS, MANAGE_FOLDER_SYNC, LAST
}
 The action type enum. More...
 
enum  Manage2faOperation { GENERATE_2FA = 1, ENABLE_2FA = 2, DISABLE_2FA = 3 }
 The manage 2-Factor Authentication operation enum. More...
 

Public Member Functions

NodeHandle getAccountHandle () const
 Gets the account handle. More...
 
uint64_t getAccountId () const
 Gets the account identifier. More...
 
AccountInfo getAccountInfo () const
 Gets the account info. More...
 
PermissionInfoList getAccountPermissions () const
 Gets the permissions a user has in every joined account. More...
 
const std::string getAccountStringHandle () const
 Gets the account string handle. More...
 
ActionList getActionList () const
 Gets the action list. More...
 
const char * getActionName () const
 Gets the name of the action. More...
 
const std::string getActionNameString () const
 Gets the name of the action. More...
 
SessionInfoList getActiveSessions () const
 Gets the active sessions. More...
 
BalancesInfo getBalancesInfo () const
 Gets the balances info. More...
 
uint64_t getCompletedSize () const
 Gets the completed size. More...
 
CouponInfo getCoupon () const
 Gets the coupon. More...
 
CouponInfoList getCoupons () const
 Gets the coupons. More...
 
const std::string getCustomData () const
 Get custom data set by the app. More...
 
std::vector< uint8_t > * getData ()
 Gets the data. More...
 
const char * getEmail () const
 Gets the email. More...
 
const std::string getEmailString () const
 Gets the email. More...
 
Error getError () const
 Gets the error. More...
 
const char * getErrorName () const
 Gets the error name. More...
 
const std::string getErrorNameString () const
 Gets the error name. More...
 
int getErrorType () const
 Gets the error type. More...
 
SessionInfoList getInactiveSessions () const
 Gets the inactive sessions. More...
 
int getIntValue () const
 Gets the int value. More...
 
InvoicingInfo getInvoicingInfo () const
 Gets the invoicing info. More...
 
const char * getLastName () const
 Gets the last name. More...
 
const std::string getLastNameString () const
 Gets the last name. More...
 
const char * getLink () const
 Gets the link. More...
 
const std::string getLinkString () const
 Gets the link. More...
 
int getLocalTag () const
 Gets the local tag of an action. More...
 
CommandLogList getLog () const
 Gets the commands log for the current account. More...
 
long getLongValue () const
 Gets the long value. More...
 
const char * getName () const
 Gets the name. More...
 
const std::string getNameString () const
 Gets the name. More...
 
Node getNode () const
 Gets the node. More...
 
NodeHandle getNodeHandle () const
 Gets the node identifier. More...
 
uint64_t getNodeId () const
 Gets the node identifier. More...
 
NodeList getNodeList () const
 Gets the node list. More...
 
NumberList getNumberList () const
 Gets the number list. More...
 
uint64_t getParentId () const
 Gets the parent node identifier. More...
 
const char * getPassword () const
 Gets the password. More...
 
const std::string getPasswordString () const
 Gets the password. More...
 
PaymentInfo getPaymentInfo () const
 Gets the payment info. More...
 
const char * getSession () const
 Gets the session. More...
 
const std::string getSessionString () const
 Gets the session. More...
 
int getStatus () const
 Gets the status. More...
 
StringList getStringList () const
 Gets the string list. More...
 
SubscriptionInfoList getSubscriptionInfoList () const
 Gets the subscription info list. More...
 
int getTag () const
 Gets the Tag object. More...
 
const char * getText () const
 Gets the text. More...
 
const std::string getTextString () const
 Gets the text. More...
 
uint64_t getTotalSize () const
 Gets the total size. More...
 
Transfer getTransfer () const
 Gets the transfer. More...
 
TransferList getTransferList () const
 Gets the transfer list. More...
 
int getType () const
 Gets the type of the action. More...
 
uint64_t getUserId () const
 Gets the user identifier. More...
 
UserInfo getUserInfo () const
 Gets the user info. More...
 
PermissionInfoList getUserPermissions () const
 Gets the permissions every joined user has for the current account. More...
 
bool isFinished () const
 Gets whether the action is finished or not. More...
 
bool isProcessed () const
 Gets whether the action is processed or not. More...
 
virtual ~ActionData ()
 

Static Public Member Functions

static const char * getTypeName (unsigned type)
 Gets the event type name. More...
 
static const std::string getTypeNameString (unsigned type)
 Gets the event type name. More...
 

Detailed Description

The Action Data class.

Member Enumeration Documentation

◆ ActionType

The action type enum.

Enumerator
TEST 

Test action.

ADD_CONTACT 

Add contact action.

VERIFY_EMAIL 

Verify email action.

FORGOT_PASSWORD 

Forgot password action.

CREATE_ACCOUNT 

Create account action.

CHANGE_PASSWORD 

Change password action.

RECOVERY_KEY 
MANAGE_2FA 
LOGIN 
GET_NODES 

Get nodes action.

GET_ROOT 

Get root nodes action.

GET_CHILDREN 

Get children action.

GET_NODE 

Get node action.

GET_PATH 

Get path aciton.

ADD_NODES 

Add nodea action.

DELETE_NODE 

Delete node action.

RENAME_NODE 

Rename node action.

MOVE_NODE 

Move node action.

COPY_NODE 

Copy node action.

CREATE_LINK 

Create link action.

GET_LINK_INFO 

Get link info action.

USER_INFO 

User info actions.

ACCOUNT_INFO 

Account info actions.

LOG_EVENT 
TEST_PROXY 
SET_PROXY 
UPLOAD 
DOWNLOAD 
DOWNLOAD_ZIP 
STREAM 
BACKUP 
UPLOAD_METADATA 
DOWNLOAD_METADATA 
GET_TRANSFERS 
CLEAR_FINISHED_TRANSFERS 
CANCEL_TRANSFERS 
SET_TRANSFER_SPEED_LIMIT 
GET_TRANSFER_SPEED_LIMIT 
REGISTER_DEVICE 
SELECT_DEVICE 
GET_CURRENT_DEVICE 
GET_DEVICE 
GET_DEVICES 
RENAME_DEVICE 
DELETE_DEVICE 
GET_BACKUP 
GET_BACKUPS 
CREATE_BACKUP 
MODIFY_BACKUP 
RENAME_BACKUP 
CHANGE_BACKUP_SCHEDULE 
CHANGE_BACKUP_PATH 
CHANGE_BACKUP_STATUS 
DELETE_BACKUP 
AUTHORIZE_BACKUP 
GET_SNAPSHOTS 
GET_NEXT_SNAPSHOTS 
GET_NEXT_SNAPSHOTS_BY_DEVICE 
GET_NEXT_SNAPSHOTS_BY_BACKUP 
GET_NEXT_SNAPSHOTS_BY_ACCOUNT 
GET_NEXT_SNAPSHOTS_BY_SCHEDULE 
GET_LAST_SNAPSHOTS 
GET_LAST_SNAPSHOTS_BY_DEVICE 
GET_LAST_SNAPSHOTS_BY_BACKUP 
GET_LAST_SNAPSHOTS_BY_ACCOUNT 
CREATE_INBOX 
SET_INBOX_INFO 
GET_INBOX_INFO 
LOGIN_LINK 
SET_RECORD_INFO 
UPLOAD_TO_RECORD 
REMOVE_FROM_RECORD 
GET_RECORD_INFO 
SET_RECORD_STATUS 
SUBSCRIPTION_OPTIONS 
PAYMENT_INFO 
REMOVE_PAYMENT_METHOD 
SET_INVOICING_ADDRESS 
INVOICING_INFO 
GET_INVOICE 
SESSION_INFO 
LOGOUT_LINK 
CRASH_REPORT 
UPDATE 
LOGOUT 
CURRENT_EMAIL 
NEW_SESSION 
DESTROY 
REFERRALS_INFO 
BALANCES_INFO 
COUPONS 
ADD_PAYMENT_METHOD 
JOIN_LINK 

Create and check join links as well as joining an account.

DEFAULT_ACCOUNT 

Replace default account.

REVOKE_ACCOUNT_ACCESS 

Revoke account access.

MANAGE_SECRETS 

Manage secret spaces.

MANAGE_CONTACTS 

Manage contacts.

MANAGE_OUTBOXES 

Manage outboxes.

MANAGE_SENT_RECORDS 

Manage sent records.

GET_NODE_TREE 

Get the tree of descendants of a node.

SET_ACCOUNT_VALUE 

Set a configuration value of the account.

DELETE_ACCOUNT 
SET_ACCESS_LEVEL 
MANAGE_SHARED_DRIVES 

Manage shared drives.

DELETE_LINK 
MANAGE_MEETINGS 
MANAGE_NODE_TAG 
GET_COMMANDS_LOG 

Get commands log.

VERIFY_HASH 

Verify file hash.

NOTICE_CREDENTIALS 

Get notice email credentials.

MANAGE_FOLDER_SYNC 

Manager folder sync flag.

LAST 

◆ Manage2faOperation

The manage 2-Factor Authentication operation enum.

Enumerator
GENERATE_2FA 
ENABLE_2FA 
DISABLE_2FA 

Constructor & Destructor Documentation

◆ ~ActionData()

virtual iberbox::ActionData::~ActionData ( )
virtual

Referenced by getTypeNameString().

Member Function Documentation

◆ getAccountHandle()

NodeHandle iberbox::ActionData::getAccountHandle ( ) const

Gets the account handle.

Returns
The account handle.

Referenced by getTypeNameString().

◆ getAccountId()

uint64_t iberbox::ActionData::getAccountId ( ) const

Gets the account identifier.

Returns
The account identifier.

Referenced by getTypeNameString().

◆ getAccountInfo()

AccountInfo iberbox::ActionData::getAccountInfo ( ) const

Gets the account info.

Returns
The account info.

Referenced by getTypeNameString().

◆ getAccountPermissions()

PermissionInfoList iberbox::ActionData::getAccountPermissions ( ) const

Gets the permissions a user has in every joined account.

Returns
The permissions a user has in every joined account.

Referenced by getTypeNameString().

◆ getAccountStringHandle()

const std::string iberbox::ActionData::getAccountStringHandle ( ) const

Gets the account string handle.

Returns
The account string handle.

Referenced by getTypeNameString().

◆ getActionList()

ActionList iberbox::ActionData::getActionList ( ) const

Gets the action list.

Returns
The action list.

Referenced by getTypeNameString().

◆ getActionName()

const char* iberbox::ActionData::getActionName ( ) const

Gets the name of the action.

Returns
The action name as a char array.

Referenced by getTypeNameString().

◆ getActionNameString()

const std::string iberbox::ActionData::getActionNameString ( ) const

Gets the name of the action.

Returns
The action name as a string.

Referenced by getTypeNameString().

◆ getActiveSessions()

SessionInfoList iberbox::ActionData::getActiveSessions ( ) const

Gets the active sessions.

Returns
The active sessions.

Referenced by getTypeNameString().

◆ getBalancesInfo()

BalancesInfo iberbox::ActionData::getBalancesInfo ( ) const

Gets the balances info.

Returns
The balances info.

Referenced by getTypeNameString().

◆ getCompletedSize()

uint64_t iberbox::ActionData::getCompletedSize ( ) const

Gets the completed size.

Returns
The completed size.

Referenced by getTypeNameString().

◆ getCoupon()

CouponInfo iberbox::ActionData::getCoupon ( ) const

Gets the coupon.

Returns
The coupon.

Referenced by getTypeNameString().

◆ getCoupons()

CouponInfoList iberbox::ActionData::getCoupons ( ) const

Gets the coupons.

Returns
The coupons.

Referenced by getTypeNameString().

◆ getCustomData()

const std::string iberbox::ActionData::getCustomData ( ) const

Get custom data set by the app.

Returns
Custom data set by the app

Referenced by getTypeNameString().

◆ getData()

std::vector<uint8_t>* iberbox::ActionData::getData ( )

Gets the data.

Returns
The data.

Referenced by getTypeNameString().

◆ getEmail()

const char* iberbox::ActionData::getEmail ( ) const

Gets the email.

Returns
The email as a char array.

Referenced by getTypeNameString().

◆ getEmailString()

const std::string iberbox::ActionData::getEmailString ( ) const

Gets the email.

Returns
The email as a string.

Referenced by getTypeNameString().

◆ getError()

Error iberbox::ActionData::getError ( ) const

Gets the error.

Returns
The error.

Referenced by getTypeNameString().

◆ getErrorName()

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

Gets the error name.

Returns
The error name as a char array.

Referenced by getTypeNameString().

◆ getErrorNameString()

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

Gets the error name.

Returns
The error name as a string.

Referenced by getTypeNameString().

◆ getErrorType()

int iberbox::ActionData::getErrorType ( ) const

Gets the error type.

Returns
The error type.

Referenced by getTypeNameString().

◆ getInactiveSessions()

SessionInfoList iberbox::ActionData::getInactiveSessions ( ) const

Gets the inactive sessions.

Returns
The inactive sessions.

Referenced by getTypeNameString().

◆ getIntValue()

int iberbox::ActionData::getIntValue ( ) const

Gets the int value.

Returns
The int value

Referenced by getTypeNameString().

◆ getInvoicingInfo()

InvoicingInfo iberbox::ActionData::getInvoicingInfo ( ) const

Gets the invoicing info.

Returns
The invoicing info.

Referenced by getTypeNameString().

◆ getLastName()

const char* iberbox::ActionData::getLastName ( ) const

Gets the last name.

Returns
The last name as a char array.

Referenced by getTypeNameString().

◆ getLastNameString()

const std::string iberbox::ActionData::getLastNameString ( ) const

Gets the last name.

Returns
The last name as a string.

Referenced by getTypeNameString().

◆ getLink()

const char* iberbox::ActionData::getLink ( ) const

Gets the link.

Returns
The link as a char array.

Referenced by getTypeNameString().

◆ getLinkString()

const std::string iberbox::ActionData::getLinkString ( ) const

Gets the link.

Returns
The link as a string.

Referenced by getTypeNameString().

◆ getLocalTag()

int iberbox::ActionData::getLocalTag ( ) const

Gets the local tag of an action.

The local tag uniquely identifies an action within a callback dispatcher.

Returns
The local tag.

Referenced by getTypeNameString().

◆ getLog()

CommandLogList iberbox::ActionData::getLog ( ) const

Gets the commands log for the current account.

Returns
The commands log for the current account.

Referenced by getTypeNameString().

◆ getLongValue()

long iberbox::ActionData::getLongValue ( ) const

Gets the long value.

Returns
The long value.

Referenced by getTypeNameString().

◆ getName()

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

Gets the name.

Returns
The name as a char array.

Referenced by getTypeNameString().

◆ getNameString()

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

Gets the name.

Returns
The name as a string.

Referenced by getTypeNameString().

◆ getNode()

Node iberbox::ActionData::getNode ( ) const

Gets the node.

Returns
The node.

Referenced by getTypeNameString().

◆ getNodeHandle()

NodeHandle iberbox::ActionData::getNodeHandle ( ) const

Gets the node identifier.

Returns
The node identifier.

Referenced by getTypeNameString().

◆ getNodeId()

uint64_t iberbox::ActionData::getNodeId ( ) const

Gets the node identifier.

Returns
The node identifier.

Referenced by getTypeNameString().

◆ getNodeList()

NodeList iberbox::ActionData::getNodeList ( ) const

Gets the node list.

Returns
The node list.

Referenced by getTypeNameString().

◆ getNumberList()

NumberList iberbox::ActionData::getNumberList ( ) const

Gets the number list.

Returns
The number list.

Referenced by getTypeNameString().

◆ getParentId()

uint64_t iberbox::ActionData::getParentId ( ) const

Gets the parent node identifier.

Returns
The parent node identifier.

Referenced by getTypeNameString().

◆ getPassword()

const char* iberbox::ActionData::getPassword ( ) const

Gets the password.

Returns
The password as a char array.

Referenced by getTypeNameString().

◆ getPasswordString()

const std::string iberbox::ActionData::getPasswordString ( ) const

Gets the password.

Returns
The password as a string.

Referenced by getTypeNameString().

◆ getPaymentInfo()

PaymentInfo iberbox::ActionData::getPaymentInfo ( ) const

Gets the payment info.

Returns
PaymentInfo

Referenced by getTypeNameString().

◆ getSession()

const char* iberbox::ActionData::getSession ( ) const

Gets the session.

Returns
The session as a char array.

Referenced by getTypeNameString().

◆ getSessionString()

const std::string iberbox::ActionData::getSessionString ( ) const

Gets the session.

Returns
The session as a string.

Referenced by getTypeNameString().

◆ getStatus()

int iberbox::ActionData::getStatus ( ) const

Gets the status.

Returns
The status.

Referenced by getTypeNameString().

◆ getStringList()

StringList iberbox::ActionData::getStringList ( ) const

Gets the string list.

Returns
The string list.

Referenced by getTypeNameString().

◆ getSubscriptionInfoList()

SubscriptionInfoList iberbox::ActionData::getSubscriptionInfoList ( ) const

Gets the subscription info list.

Returns
The subscription info list.

Referenced by getTypeNameString().

◆ getTag()

int iberbox::ActionData::getTag ( ) const

Gets the Tag object.

Returns
int

Referenced by getTypeNameString().

◆ getText()

const char* iberbox::ActionData::getText ( ) const

Gets the text.

Returns
The text as a char array.

Referenced by getTypeNameString().

◆ getTextString()

const std::string iberbox::ActionData::getTextString ( ) const

Gets the text.

Returns
The text as a string.

Referenced by getTypeNameString().

◆ getTotalSize()

uint64_t iberbox::ActionData::getTotalSize ( ) const

Gets the total size.

Returns
The total size.

Referenced by getTypeNameString().

◆ getTransfer()

Transfer iberbox::ActionData::getTransfer ( ) const

Gets the transfer.

Returns
The transfer.

Referenced by getTypeNameString().

◆ getTransferList()

TransferList iberbox::ActionData::getTransferList ( ) const

Gets the transfer list.

Returns
The transfer list.

Referenced by getTypeNameString().

◆ getType()

int iberbox::ActionData::getType ( ) const

Gets the type of the action.

The valid type values are described by ActionType enum.

Returns
The action type.

Referenced by getTypeNameString().

◆ getTypeName()

static const char* iberbox::ActionData::getTypeName ( unsigned  type)
inlinestatic

Gets the event type name.

type valid values are described in EventType enum

Parameters
typeThe event type.
Returns
The event type name as a char array.

References LAST.

Referenced by getTypeNameString().

◆ getTypeNameString()

◆ getUserId()

uint64_t iberbox::ActionData::getUserId ( ) const

Gets the user identifier.

Returns
The user identifier.

Referenced by getTypeNameString().

◆ getUserInfo()

UserInfo iberbox::ActionData::getUserInfo ( ) const

Gets the user info.

Returns
The user info.

Referenced by getTypeNameString().

◆ getUserPermissions()

PermissionInfoList iberbox::ActionData::getUserPermissions ( ) const

Gets the permissions every joined user has for the current account.

Returns
The permissions every joined user has for the current account.

Referenced by getTypeNameString().

◆ isFinished()

bool iberbox::ActionData::isFinished ( ) const

Gets whether the action is finished or not.

Returns
true if the action is finished.
false if the action is not finished.

Referenced by getTypeNameString().

◆ isProcessed()

bool iberbox::ActionData::isProcessed ( ) const

Gets whether the action is processed or not.

Returns
true if the action is processed.
false if the action is not processed.

Referenced by getTypeNameString().


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