iberbox  2.1.2
iberbox::Iberbox Class Reference

The Iberbox class. More...

Inheritance diagram for iberbox::Iberbox:
Collaboration diagram for iberbox::Iberbox:

Public Types

enum  CryptoSchemeType { AES256_CRYPTO_SCHEME = 0, AES128_CRYPTO_SCHEME = 2 }
 
enum  LogLevelType {
  LOG_LEVEL_TRACE = 0, LOG_LEVEL_DEBUG = 1, LOG_LEVEL_INFO = 2, LOG_LEVEL_WARN = 3,
  LOG_LEVEL_ERROR = 4, LOG_LEVEL_CRITICAL = 5, LOG_LEVEL_OFF = 6
}
 
enum  SortOrderType {
  SORT_ORDER_SIZE_R = -6, SORT_ORDER_MODIFICATION_TIME_R, SORT_ORDER_CREATION_TIME_R, SORT_ORDER_ALPHABETICAL_R,
  SORT_ORDER_NATURAL_R, SORT_ORDER_DEFAULT_R, SORT_ORDER_NONE = 0, SORT_ORDER_DEFAULT,
  SORT_ORDER_NATURAL, SORT_ORDER_ALPHABETICAL, SORT_ORDER_CREATION_TIME, SORT_ORDER_MODIFICATION_TIME,
  SORT_ORDER_SIZE, SORT_ORDER_LAST
}
 The SortOrderType enum. More...
 

Public Member Functions

void addActionListener (ActionListenerType listener)
 Adds a new action listener. More...
 
void addBankTransferAsPaymentMethod (ActionListenerType listener=nullptr)
 Adds bank transfer as a payment method for the currently logged-in user's account. More...
 
void addContact (NodeHandle account, const std::string &contactName, ActionListenerType listener=nullptr)
 Adds a new contact to the account of the currently logged-in user. More...
 
void addDirectDebitAsPaymentMethod (const std::string &iban, const std::string &holder, ActionListenerType listener=nullptr)
 Adds a bank account as the payment method for the currently logged-in user's account. More...
 
void addEventListener (EventListenerType listener)
 Adds a new event listener. More...
 
void addResellerCodeAsPaymentMethod (const std::string &code, ActionListenerType listener=nullptr)
 Adds a reseller code as the payment method for the currently logged-in user's account. More...
 
void archiveSharedDrive (NodeHandle sharedDrive, ActionListenerType listener=nullptr)
 Archives an owned shared drive removing every permission to other accounts. More...
 
void authorizeBackup (NodeHandle backupId, ActionListenerType listener=nullptr)
 Authorizes an existing backup. More...
 
void cancelTransferByTag (int tag, ActionListenerType listener=nullptr)
 Cancels the transfer identified by tag. More...
 
void cancelTransfers (ActionListenerType listener=nullptr)
 Cancels every transfer. More...
 
void cancelTransfersByType (int type, ActionListenerType listener=nullptr)
 Cancels every transfer that meets the type filter. More...
 
void changeBackupPath (NodeHandle backupId, const std::string &localPath, ActionListenerType listener=nullptr)
 Changes the path of a specified backup. More...
 
void changeBackupSchedule (NodeHandle backupId, unsigned long startTime, std::string cronExpr, ActionListenerType listener=nullptr)
 Changes the schedule of a specified backup. More...
 
void changeBackupStatus (NodeHandle backupId, int status, ActionListenerType listener=nullptr)
 Changes the status of a specified backup. More...
 
void changePassword (const std::string &password, ActionListenerType listener=nullptr)
 Changes the password of the currently logged-in user. More...
 
void checkJoinLink (const std::string &link, const std::string &email, ActionListenerType listener=nullptr)
 Checks a previously created join link using createJoinLink method. More...
 
void checkPassword (const std::string &password, ActionListenerType listener=nullptr)
 Checks user's password against a given one. More...
 
void checkUpdate (const std::string &appName, int version, ActionListenerType listener=nullptr)
 
void clearFinishedTransferByTag (int tag, ActionListenerType listener=nullptr)
 Clears the transfer identified by tag if it has finished. More...
 
void clearFinishedTransfers (ActionListenerType listener=nullptr)
 Clears every finished transfer. More...
 
void clearFinishedTransfersByType (int type, ActionListenerType listener=nullptr)
 Clears every finished transfer that meets the type filter. More...
 
void closeSecret (NodeHandle secretHandle, ActionListenerType listener=nullptr)
 Closes a secret space given its handle. More...
 
void copyNode (NodeHandle node, NodeHandle parent, ActionListenerType listener=nullptr)
 Copies a node to a diferent path. More...
 
void createAccount (const std::string &registrationId, const std::string &name, const std::string &lastName, const std::string &email, const std::string &password, int pin, ActionListenerType listener=nullptr)
 Creates a new user account making use of the registrationId and pin that were generated after using verifyEmail. More...
 
void createAccountForCurrentUser (const std::string &coupon, ActionListenerType listener=nullptr)
 Creates a new user account for the currently logged-in user. More...
 
void createAccountWithCoupon (const std::string &registrationId, const std::string &name, const std::string &lastName, const std::string &email, const std::string &password, int pin, const std::string &coupon, ActionListenerType listener=nullptr)
 Creates a new user account making use of the registrationId and pin that were generated after using verifyEmail. More...
 
void createAccountWithPlan (const std::string &registrationId, const std::string &name, const std::string &lastName, const std::string &email, const std::string &password, int pin, const std::string &coupon, int planId, ActionListenerType listener=nullptr)
 Creates a new user account making use of the registrationId and pin that were generated after using verifyEmail. More...
 
void createBackup (const std::string &name, unsigned long startTime, const std::string cronExpr, const std::string &localPath, int maxSnapshots, int status, ActionListenerType listener=nullptr)
 Creates a new backup. More...
 
void createFolder (NodeHandle parent, const std::string &name, ActionListenerType listener=nullptr)
 Creates a new folder with the specified name as a descendant of the parent. More...
 
void createInbox (const std::string &name, const std::string &message, ActionListenerType listener=nullptr)
 Creates a new inbox for electronic record management. More...
 
void createJoinLink (const std::string &email, ActionListenerType listener=nullptr)
 Creates a join link for a specific email. More...
 
void createJoinLinkWithAccessLevel (const std::string &email, int accessLevel, ActionListenerType listener=nullptr)
 Creates a join link for a specific email. More...
 
void createLink (NodeHandle node, ActionListenerType listener=nullptr)
 Creates a link to a specified node (file, folder or inbox). More...
 
void createResellerCoupon (const std::string &email=std::string(), ActionListenerType listener=nullptr)
 Creates a new reseller-type coupon. More...
 
void createResellerCouponWithPlan (int planId, const std::string &email=std::string(), ActionListenerType listener=nullptr)
 Creates a new reseller-type coupon with an associated plan. More...
 
void createSecret (const std::string &name, const std::string &password, ActionListenerType listener=nullptr)
 Creates a secret space with the specified credentials. More...
 
void createSharedDrive (const std::string &name, ActionListenerType listener=nullptr)
 Creates a shared drive with the specified name. More...
 
void createSharedDriveLink (NodeHandle node, int accessLevel, ActionListenerType listener=nullptr)
 Creates a link to a specified shared drive node. More...
 
void createVirtuallyNestedSharedDrive (NodeHandle parent, const std::string &name, ActionListenerType listener=nullptr)
 Creates a virtually nested shared drive with the specified name and the specified share drive "parent". More...
 
void currentEmail (ActionListenerType listener=nullptr)
 Gets the email of the currently logged-in user. More...
 
void deauthorizeBackup (NodeHandle backupId, ActionListenerType listener=nullptr)
 Deauthorizes an existing backup. More...
 
void deleteAccount (const std::string &reason, ActionListenerType listener=nullptr)
 Deletes the current account. More...
 
void deleteBackup (NodeHandle backupId, ActionListenerType listener=nullptr)
 Deletes an existing backup. More...
 
void deleteCoupon (int id, ActionListenerType listener=nullptr)
 Deletes a coupon given its identifier. More...
 
void deleteDevice (NodeHandle deviceId, ActionListenerType listener=nullptr)
 Deletes the deviced identified by deviceId. More...
 
void deleteLink (const std::string &link, ActionListenerType listener=nullptr)
 Deletes a public link. More...
 
void deleteNode (NodeHandle node, ActionListenerType listener=nullptr)
 Deletes a node given its handle. More...
 
void deleteNodePermanently (NodeHandle node, ActionListenerType listener=nullptr)
 Deletes a node permanently given its handle. More...
 
void deleteSecret (NodeHandle secretHandle, ActionListenerType listener=nullptr)
 Deletes a secret space given its handle. More...
 
void deleteSharedDrive (NodeHandle sharedDrive, ActionListenerType listener=nullptr)
 Deletes a shared drive given its handle. More...
 
void disable2fa (int code, ActionListenerType listener=nullptr)
 Disables the 2FA method for the currently logged-in user. More...
 
void download (NodeHandle node, const std::string &parent, ActionListenerType listener=nullptr)
 Downloads a file or folder to a specific local filesystem directory. More...
 
void downloadInvoice (int invoiceId, const std::string &path, ActionListenerType listener=nullptr)
 Downloads and writes the invoice identified by invoiceId to the local filesystem at the specified path. More...
 
void downloadLink (const std::string &link, const std::string &parent, ActionListenerType listener=nullptr)
 Downloads a file referenced by a public link to the specified directory. More...
 
void downloadLinkWithCustomData (const std::string &link, const std::string &parent, const std::string &customData, ActionListenerType listener=nullptr)
 Downloads a file referenced by a public link to the specified directory, associating application data to the transfer. More...
 
void downloadMetadata (NodeHandle node, int metadataType, const std::string &parent, ActionListenerType listener=nullptr)
 Downloads specific metadata for a given node and a metadata type. More...
 
void downloadPublicMetadata (const std::string &metadataInfo, int metadataType, const std::string &parent, ActionListenerType listener=nullptr)
 Downloads specific public metadata for a node given its public metadata information and a metadata type. More...
 
void downloadUpdate (const std::string &appName, int version, const std::string &downloadFolder, const std::string &installFolder, ActionListenerType listener=nullptr)
 downloadUpdate More...
 
void downloadWithCustomData (NodeHandle node, const std::string &parent, const std::string &customData, ActionListenerType listener=nullptr)
 Downloads a file or folder to a specific local filesystem directory, associating application data to the transfer. More...
 
void downloadZip (NodeHandle node, const std::string &parent, ActionListenerType listener=nullptr)
 Generates a downloadable zipped file or folder. More...
 
void downloadZipWithCustomData (NodeHandle node, const std::string &parent, const std::string &customData, ActionListenerType listener=nullptr)
 Generates a downloadable zipped file or folder, associating application data to the transfer. More...
 
void enable2fa (int code, ActionListenerType listener=nullptr)
 Enables the 2FA method for the currently logged-in user. More...
 
void finishRecord (ActionListenerType listener=nullptr)
 Finishes the creation of a record. More...
 
void finishRecordWithRecipient (const std::string &recipient, ActionListenerType listener=nullptr)
 Finishes the creation of a record and sends its link to the recipient. More...
 
void forgotPassword (const std::string &email, ActionListenerType listener=nullptr)
 Inits the process of account recovery by sending instructions to the provided email address. More...
 
void generate2faUrl (ActionListenerType listener=nullptr)
 Generates the 2FA URL for the currently logged-in user. More...
 
void generateUpdate (const std::string &appName, int version, const std::string &platform, const std::string &updateFolder, const std::string &updateUrl, const std::string &changelog, const std::string &outputFile, const std::string &privateKey, ActionListenerType listener=nullptr)
 generateUpdate More...
 
void getAccountCoupons (ActionListenerType listener=nullptr)
 Gets the coupons created by the account of the currently logged-in user. More...
 
void getAccountInfo (ActionListenerType listener=nullptr)
 Gets the info of the currently logged-in user account. More...
 
void getAccountLog (unsigned short page=1, ActionListenerType listener=nullptr)
 Gets the account log containing special actions performed by any user in the current account. More...
 
void getActiveBackups (ActionListenerType listener=nullptr)
 Gets every active backup of the devices owned by the currently logged-in user. More...
 
void getBackupById (NodeHandle backupId, ActionListenerType listener=nullptr)
 Gets the backup identified by backupId. More...
 
void getBackupByName (NodeHandle deviceId, const std::string &name, ActionListenerType listener=nullptr)
 Gets the backup identified by name of a device owned by the currently logged-in user whose node handle is deviceId. More...
 
void getBackups (NodeHandle deviceId, ActionListenerType listener=nullptr)
 Gets every backup of a specific device identified by deviceId. More...
 
void getBalancesInfo (ActionListenerType listener=nullptr)
 Gets the balances information of the account of the currently logged-in user. More...
 
void getChildFiles (NodeHandle id, ActionListenerType listener=nullptr)
 Gets every direct descendant file of a specified node using default sort order. More...
 
void getChildFolders (NodeHandle id, ActionListenerType listener=nullptr)
 Gets every direct descendant folder of a specified node using default sort order. More...
 
void getChildren (NodeHandle id, ActionListenerType listener=nullptr)
 Gets every direct descendant of a specified node using default sort order. More...
 
void getCouponInfo (const std::string &coupon, ActionListenerType listener=nullptr)
 Gets the information of a given coupon. More...
 
void getCurrentDevice (ActionListenerType listener=nullptr)
 Gets the current device from which the desktop app has been launched. More...
 
void getDeviceById (NodeHandle deviceId, ActionListenerType listener=nullptr)
 Gets the requested device. More...
 
void getDeviceByName (const std::string &name, ActionListenerType listener=nullptr)
 Gets the requested device owned by the currently logged-in user. More...
 
void getDevices (ActionListenerType listener=nullptr)
 Gets every device owned by the currently logged-in user. More...
 
void getDownloadSpeedLimit (ActionListenerType listener=nullptr)
 Gets the download speed limit using kbps unit. More...
 
void getExternalInbox (ActionListenerType listener=nullptr)
 Get an external inbox to send records to users without an Iberbox account. More...
 
void getInboxInfo (const std::string &inboxLink, ActionListenerType listener=nullptr)
 Gets the information related to a given inbox by its public link. More...
 
void getInvoicingInfo (ActionListenerType listener=nullptr)
 Gets the invoicing information of the currently logged-in user. More...
 
void getLastSnapshots (ActionListenerType listener=nullptr)
 Gets the last created snapshots of every backup in the current device. More...
 
void getLastSnapshotsForAccount (ActionListenerType listener=nullptr)
 Gets the last created snapshots for the account of the currently logged-in user. More...
 
void getLastSnapshotsForBackup (NodeHandle backupId, int count, ActionListenerType listener=nullptr)
 Gets the n (count) latest created snapshots of a given backup. More...
 
void getLastSnapshotsForDevice (NodeHandle deviceId, ActionListenerType listener=nullptr)
 Gets the last created snapshots of every backup in the specified device. More...
 
void getLinkInfo (const std::string &link, ActionListenerType listener=nullptr)
 Gets the node which the link points to. More...
 
void getMeetingAccess (NodeHandle sharedDrive, ActionListenerType listener=nullptr)
 Gets the credentials for the current account to access to a meeting given a shared drive. More...
 
void getNextSnapshots (ActionListenerType listener=nullptr)
 Gets next scheduled snapshots of every backup in the current device. More...
 
void getNextSnapshotsForAccount (ActionListenerType listener=nullptr)
 Gets the next scheduled snapshots of every backup in the account of the currently logged-in user. More...
 
void getNextSnapshotsForBackup (NodeHandle backupId, int count, ActionListenerType listener=nullptr)
 Gets n (count) next scheduled snapshots for a given backup. More...
 
void getNextSnapshotsForDevice (NodeHandle deviceId, ActionListenerType listener=nullptr)
 Gets next scheduled snapshots of every backup in a given device. More...
 
void getNextSnapshotsForSchedule (unsigned long startTime, const std::string cronExpr, int count, ActionListenerType listener=nullptr)
 Gets a specified number of timestamps when the snapshots would be carried out given a start time and a cron expression. More...
 
void getNodeById (NodeHandle id, ActionListenerType listener=nullptr)
 Gets a node given its node handle. More...
 
void getNodeByPath (const std::string &path, ActionListenerType listener=nullptr)
 Gets a node given its path. More...
 
void getNodePath (NodeHandle id, ActionListenerType listener=nullptr)
 Gets the path of a given node. More...
 
void getNodes (ActionListenerType listener=nullptr)
 Get the cloud root node. More...
 
void getNoticeCredentials (ActionListenerType listener=nullptr)
 Gets the email account credentials in order to send notices. More...
 
void getOpenSecrets (ActionListenerType listener=nullptr)
 Gets every open secret space within the account of the currently logged-in user. More...
 
void getPaymentInfo (int subscriptionId, ActionListenerType listener=nullptr)
 Gets the information related to the payment of a given subscription. More...
 
void getPublicAccountInfo (AccountHandle account, ActionListenerType listener=nullptr)
 Gets the public info of an account given its handle. More...
 
void getPublicAccountInfoByLink (const std::string &link, ActionListenerType listener=nullptr)
 Gets the public info of the account associated to an account link. More...
 
void getPublicUserInfo (UserHandle user, ActionListenerType listener=nullptr)
 Gets the public info of a user given its handle. More...
 
void getRecordInfo (const std::string &recordLink, ActionListenerType listener=nullptr)
 Gets the information of a record given its public link. More...
 
void getRecoveryKey (ActionListenerType listener=nullptr)
 Gets the recovery key of the currently logged-in user. More...
 
void getReferralsInfo (ActionListenerType listener=nullptr)
 Gets the referrals information of the account of the currently logged-in user. More...
 
void getRootNode (int type, ActionListenerType listener=nullptr)
 Gets the root node in the filesystem that matches the given type. More...
 
void getRootNodes (ActionListenerType listener=nullptr)
 Gets every root node in the filesystem. More...
 
void getSecretRecoveryKey (NodeHandle secretHandle, ActionListenerType listener=nullptr)
 Gets the recovery key for a secret space given its handle. More...
 
void getSessionInfo (ActionListenerType listener=nullptr)
 Gets the information of the active and inactive sessions. More...
 
void getSharedDriveInfo (NodeHandle sharedDrive, ActionListenerType listener=nullptr)
 Gets information of a specific shared node given its handle. More...
 
void getSharedDrives (ActionListenerType listener=nullptr)
 Gets every shared drive within the account of the currently logged-in user. More...
 
void getSnapshots (NodeHandle backupId, ActionListenerType listener=nullptr)
 Gets every snapshot of a given backup. More...
 
void getSortedChildFiles (NodeHandle id, int sortOrder=SORT_ORDER_DEFAULT, ActionListenerType listener=nullptr)
 Gets every direct descendant file of a specified node using a specified sort order. More...
 
void getSortedChildFolders (NodeHandle id, int sortOrder=SORT_ORDER_DEFAULT, ActionListenerType listener=nullptr)
 Gets every direct descendant folder of a specified node using a specified sort order. More...
 
void getSortedChildren (NodeHandle id, int sortOrder=SORT_ORDER_DEFAULT, ActionListenerType listener=nullptr)
 Gets every direct descendant of a specified node using a specified sort order. More...
 
void getSubscriptionOptions (ActionListenerType listener=nullptr)
 Gets the list of subscription options and its information. More...
 
void getSubscriptionOptionsWithFeatures (int features, ActionListenerType listener=nullptr)
 Gets the list of subscription options that have a set of required features. More...
 
void getTransfers (ActionListenerType listener=nullptr)
 Gets all the transfers. More...
 
void getTransfersByStatus (int type, int status, ActionListenerType listener=nullptr)
 Gets every transfer that meets the type and status filter. More...
 
void getTransfersByType (int type, ActionListenerType listener=nullptr)
 Gets every finished transfer that meets the type filter. More...
 
void getUnfinishedTransfers (int type, ActionListenerType listener=nullptr)
 Gets every unfinished transfer that meets the type filer. More...
 
void getUploadSpeedLimit (ActionListenerType listener=nullptr)
 Gets the upload speed limit using kbps unit. More...
 
void getUserInfo (ActionListenerType listener=nullptr)
 Gets the info of the currently logged-in user. More...
 
 Iberbox (TaskManagerType taskManager=nullptr, IberboxSettingsType settings=nullptr)
 Iberbox default constructor. More...
 
void installUpdate (const std::string &appName, int version, const std::string &downloadFolder, const std::string &installFolder, ActionListenerType listener=nullptr)
 installUpdate More...
 
void inviteEmail (const std::string &email, ActionListenerType listener=nullptr)
 Sends an invitation email to the given address. More...
 
void joinAccount (AccountHandle account, const std::string &accountKey, const std::string &registrationId, const std::string &name, const std::string &lastName, const std::string &email, const std::string &password, int pin, ActionListenerType listener=nullptr)
 Gives the currently logged-in user permission to access a specified account. More...
 
void joinAccountWithCurrentUser (AccountHandle account, const std::string &accountKey, ActionListenerType listener=nullptr)
 Gives the currently logged-in user permission to access a specified account. More...
 
void logEvent (int eventId, ActionListenerType listener=nullptr)
 Logs an event given its identifier. More...
 
void logEventData (int eventId, const std::string &message, ActionListenerType listener=nullptr)
 Logs an event given its identifier and some data to include in the log. More...
 
void login (const std::string &login, const std::string &password, ActionListenerType listener=nullptr)
 Performs account 1FA login using login and password credentials. More...
 
void login2fa (const std::string &login, const std::string &password, int code, ActionListenerType listener=nullptr)
 Performs a 2FA login. More...
 
void loginIntoAccount (const std::string &login, const std::string &password, AccountHandle account, ActionListenerType listener=nullptr)
 Performs account 1FA login using login and password credentials. More...
 
void loginIntoAccount2fa (const std::string &login, const std::string &password, int code, AccountHandle accountHandle, ActionListenerType listener=nullptr)
 Performs a 2FA login. More...
 
void loginLink (const std::string &folderLink, ActionListenerType listener=nullptr)
 loginLink More...
 
void logout (ActionListenerType listener=nullptr)
 Performs a logout of the currently logged-in user. More...
 
void logoutLink (ActionListenerType listener=nullptr)
 logoutLink More...
 
void modifyBackup (NodeHandle backupId, const std::string &name, unsigned long startTime, const std::string cronExpr, const std::string &localPath, int maxSnapshots, int status, ActionListenerType listener=nullptr)
 Modifies the configuration of a previously created backup. More...
 
void modifyContact (NodeHandle contact, const std::string &contactName, ActionListenerType listener=nullptr)
 Modifies the alias name of a previously added contact. More...
 
void modifySavedInbox (NodeHandle outbox, const std::string &outboxName, ActionListenerType listener=nullptr)
 Modifies the alias name of a previously added outbox. More...
 
void moveNode (NodeHandle node, NodeHandle parent, ActionListenerType listener=nullptr)
 Changes the parent node of another node. More...
 
void nestSharedDrive (NodeHandle sharedDrive, NodeHandle parent, ActionListenerType listener=nullptr)
 
void newSession (ActionListenerType listener=nullptr)
 Creates a new session. More...
 
void newSessionIntoAccount (AccountHandle accountHandle, ActionListenerType listener=nullptr)
 Creates a new session within an specific account. More...
 
virtual void onActionFinish (Action action) override
 The method that will be executed when the action finishes. More...
 
void openSecret (const std::string &name, const std::string &password, ActionListenerType listener=nullptr)
 Opens a secret spaced given its credentials (name and password). More...
 
void readLink (const std::string &link, unsigned long startPositon, unsigned long size, ActionListenerType listener=nullptr)
 readLink More...
 
void readNode (NodeHandle file, unsigned long startPositon, unsigned long size, ActionListenerType listener=nullptr)
 readNode More...
 
void recoverAccount (const std::string &recoveryId, const std::string &login, const std::string &recoveryKey, int pin, ActionListenerType listener=nullptr)
 Recovers the account of a user. More...
 
void recoverAccount2fa (const std::string &recoveryId, const std::string &login, const std::string &recoveryKey, int pin, int code, ActionListenerType listener=nullptr)
 Recovers the account of a user like recoverAccount method does but with the code special param corresponding to the One-Time Password required by 2FA method. More...
 
void recoverSecret (const std::string &recoveryKey, const std::string &newName, const std::string &newPassword, ActionListenerType listener=nullptr)
 Recovers a secret space given its recovery key. More...
 
void registerDevice (const std::string &name, ActionListenerType listener=nullptr)
 Registers a new device in the account of the currently logged-in user. More...
 
void removeActionListener (ActionListenerType listener)
 Removes a previously added action listener. More...
 
void removeContact (NodeHandle contact, ActionListenerType listener=nullptr)
 Removes a contact from the current account. More...
 
void removeEventListener (EventListenerType listener)
 Removes a previously added event listener. More...
 
void removeFromRecord (NodeHandle fileHandle, ActionListenerType listener=nullptr)
 Removes a file from a record given its node handle. More...
 
void removePaymentMethod (ActionListenerType listener=nullptr)
 Removes the configured payment method for the account of the currently logged-in user. More...
 
void removeProxy (ActionListenerType listener=nullptr)
 Disables the current active proxy server configuration. More...
 
void removeRecord (ActionListenerType listener=nullptr)
 Removes a record from... More...
 
void removeSavedInbox (NodeHandle outbox, ActionListenerType listener=nullptr)
 Removes an outbox from the current account. More...
 
void renameBackup (NodeHandle backupId, const std::string &newName, ActionListenerType listener=nullptr)
 Renames a specified backup. More...
 
void renameDevice (NodeHandle deviceId, const std::string &newName, ActionListenerType listener=nullptr)
 Set a new name to the device identified by deviceId. More...
 
void renameNode (NodeHandle node, const std::string &name, ActionListenerType listener=nullptr)
 Sets a new name to the specified node. More...
 
void resumeRecord (const std::string &newRecordLink, ActionListenerType listener=nullptr)
 Resumes the creation of a record. More...
 
void resumeSession (const std::string &session, ActionListenerType listener=nullptr)
 Resumes an user's session given a previously obtained session string. More...
 
void revokeAccountAccess (UserHandle user, ActionListenerType listener=nullptr)
 Revokes access of a specific user to the current account. More...
 
void revokeAccountAccessOfCurrentUser (ActionListenerType listener=nullptr)
 Revokes access of currently logged-in user to the current account. More...
 
void saveInbox (NodeHandle contact, const std::string &inboxLink, const std::string &outboxName, ActionListenerType listener=nullptr)
 Saves an inbox corresponded to an existing contact in order to keep track of the sent records. More...
 
void saveSentRecord (NodeHandle outbox, const std::string &recordLink, ActionListenerType listener=nullptr)
 
void selectDevice (NodeHandle deviceId, ActionListenerType listener=nullptr)
 Selects a given device from the account of the currently logged-in user. More...
 
void sendCrashReport (const std::string &file, ActionListenerType listener=nullptr)
 sendCrashReport More...
 
void setAccessLevel (UserHandle user, int accessLevel, ActionListenerType listener=nullptr)
 Sets an user's access level to the current account. More...
 
void setAccountCryptoScheme (int cryptoScheme, ActionListenerType listener=nullptr)
 Set the default crypto scheme for the account. More...
 
void setAuthProxy (const std::string &url, const std::string &user, const std::string &password, ActionListenerType listener=nullptr)
 Sets up an authenticated proxy server. More...
 
void setDefaultAccount (AccountHandle account, ActionListenerType listener=nullptr)
 Sets the default account for the currently logged-in user. More...
 
void setDownloadSpeedLimit (int kbps, ActionListenerType listener=nullptr)
 Sets the download speed limit setting. More...
 
void setEmailRecordInfo (const std::string &from, const std::string &to, const std::string &subject, const std::string &message, ActionListenerType listener=nullptr)
 Sets the information of a record sent by email. More...
 
void setInboxInfo (NodeHandle inboxHandle, const std::string &name, const std::string &message, ActionListenerType listener=nullptr)
 Sets new information related to a given inbox. More...
 
void setInvoicingAddress (const std::string &companyName, const std::string &companyAddress, const std::string &companyAddress2, const std::string &companyID, ActionListenerType listener=nullptr)
 Sets the invoicing address for the currently logged-in user. More...
 
void setNodeTag (NodeHandle node, unsigned char tag, ActionListenerType listener=nullptr)
 Sets a new tag to the specified node. More...
 
void setProxy (const std::string &url, ActionListenerType listener=nullptr)
 Sets up an unauthenticated proxy server. More...
 
void setRecordInfo (const std::string &contactInfo, const std::string &subject, const std::string &message, ActionListenerType listener=nullptr)
 Sets the information of a record. More...
 
void setRecordStatus (NodeHandle record, unsigned char status, ActionListenerType listener=nullptr)
 Sets the status of a record given its handle. More...
 
void setSubscription (int subscriptionId, ActionListenerType listener=nullptr)
 Sets a specific subscription for the current account. More...
 
void setUploadSpeedLimit (int kbps, ActionListenerType listener=nullptr)
 Sets the upload speed limit setting. More...
 
void shareDriveWithAccount (NodeHandle sharedDrive, AccountHandle account, ActionListenerType listener=nullptr)
 Shares a drive with an account given their respective handles. More...
 
void shareDriveWithAccountAndAccessLevel (NodeHandle sharedDrive, AccountHandle account, int accessLevel, ActionListenerType listener=nullptr)
 Shares a drive with an account given their respective handles. More...
 
void shareDriveWithAccountByLink (NodeHandle sharedDrive, const std::string &accountLink, ActionListenerType listener=nullptr)
 Shares a drive with an account given the drive handle and the account link. More...
 
void shareDriveWithAccountByLinkWithAccessLevel (NodeHandle sharedDrive, const std::string &accountLink, int accessLevel, ActionListenerType listener=nullptr)
 Shares a drive with an account given the drive handle and the account link. More...
 
void startRecord (const std::string &inboxLink, ActionListenerType listener=nullptr)
 Starts a new record in an inbox. More...
 
int test ()
 test More...
 
void testProxy (const std::string &url, const std::string &user, const std::string &password, ActionListenerType listener=nullptr)
 testProxy More...
 
void testRequest (ActionListenerType listener=nullptr)
 testRequest More...
 
void toggleFolderSync (NodeHandle node, ActionListenerType listener=nullptr)
 Toggle the sync flag of a folder. More...
 
void unarchiveSharedDrive (NodeHandle sharedDrive, ActionListenerType listener=nullptr)
 unarchiveSharedDrive More...
 
void unnestSharedDrive (NodeHandle sharedDrive, ActionListenerType listener=nullptr)
 
void unshareDriveWithAccount (NodeHandle sharedDrive, AccountHandle account, ActionListenerType listener=nullptr)
 Unshares a drive with an account given their respective handles. More...
 
void updateSecret (NodeHandle secretHandle, const std::string &name, const std::string &password, ActionListenerType listener=nullptr)
 Updates the credentials of a secret space given its handle and new credentials values. More...
 
void upload (const std::string &file, NodeHandle parent, ActionListenerType listener=nullptr)
 Uploads a file or folder to a specific folder. More...
 
void uploadMetadata (const std::string &file, NodeHandle node, int metadataType, ActionListenerType listener=nullptr)
 Uploads specific metadata for a given node. More...
 
void uploadToRecord (const std::string &file, ActionListenerType listener=nullptr)
 Uploads a file to a record. More...
 
void uploadWithCustomData (const std::string &file, NodeHandle parent, const std::string &customData, ActionListenerType listener=nullptr)
 Uploads a file or folder to a specific folder, associating application data to the transfer. More...
 
void verifyEmail (const std::string &email, const std::string &firstName, const std::string &lastName, ActionListenerType listener=nullptr)
 Verifies if an email already exists alongside a first name and last name. More...
 
void verifyHash (const std::string base64Hash, const std::string filePath, ActionListenerType listener=nullptr)
 Verifies if a given hash corresponds to a specific file. More...
 
virtual ~Iberbox ()
 ~Iberbox default destructor More...
 
- Public Member Functions inherited from iberbox::ActionListener
 ActionListener ()
 Constructs a new Action Listener object. More...
 
 ActionListener (std::function< void(Action)> finishCallback)
 Constructs a new Action Listener object. More...
 
 ActionListener (std::function< void(Action)> progressCallback, std::function< void(Action)> finishCallback)
 
 ActionListener (std::function< void(Action)> errorCallback, std::function< void(Action)> progressCallback, std::function< void(Action)> finishCallback)
 
 ActionListener (std::function< void(Action)> startCallback, std::function< void(Action)> errorCallback, std::function< void(Action)> progressCallback, std::function< void(Action)> finishCallback)
 
virtual void onActionError (Action action)
 The method that will be executed when an error occurs within the action. More...
 
virtual void onActionProcessed (Action action)
 The method that will be executed when the action has been processed. More...
 
virtual void onActionProgress (Action action)
 The method that will be executed when the action's progress changes. More...
 
virtual void onActionStart (Action action)
 The method that will be executed when the action starts. More...
 
void setErrorCallback (std::function< void(Action)> errorCallback)
 
void setFinishCallback (std::function< void(Action)> finishCallback)
 
void setProgressCallback (std::function< void(Action)> progressCallback)
 
void setStartCallback (std::function< void(Action)> startCallback)
 
virtual ~ActionListener ()
 

Static Public Member Functions

static void enableCrashHandler (std::function< void(std::string, std::string)> callback)
 Initializes the crash manager and enables the crash handler. More...
 
static int getLogLevel ()
 Get the active log level Possible log levels are specified by the LogLevelType enum: More...
 
static void globalCleanup ()
 Releases global resources. More...
 
static void globalInit (const std::string &appId, int appVersion)
 Initializes global resources. More...
 
static void setLogLevel (int logLevel)
 Set the active log level Possible log levels are specified by the LogLevelType enum: More...
 

Detailed Description

The Iberbox class.

Member Enumeration Documentation

◆ CryptoSchemeType

Enumerator
AES256_CRYPTO_SCHEME 
AES128_CRYPTO_SCHEME 

◆ LogLevelType

Enumerator
LOG_LEVEL_TRACE 
LOG_LEVEL_DEBUG 
LOG_LEVEL_INFO 
LOG_LEVEL_WARN 
LOG_LEVEL_ERROR 
LOG_LEVEL_CRITICAL 
LOG_LEVEL_OFF 

◆ SortOrderType

The SortOrderType enum.

This enumeration specifies the different ways of sorting a node list or in general any array-like object.

Enumerator
SORT_ORDER_SIZE_R 
SORT_ORDER_MODIFICATION_TIME_R 
SORT_ORDER_CREATION_TIME_R 
SORT_ORDER_ALPHABETICAL_R 
SORT_ORDER_NATURAL_R 
SORT_ORDER_DEFAULT_R 
SORT_ORDER_NONE 
SORT_ORDER_DEFAULT 
SORT_ORDER_NATURAL 
SORT_ORDER_ALPHABETICAL 
SORT_ORDER_CREATION_TIME 
SORT_ORDER_MODIFICATION_TIME 
SORT_ORDER_SIZE 
SORT_ORDER_LAST 

Constructor & Destructor Documentation

◆ Iberbox()

iberbox::Iberbox::Iberbox ( TaskManagerType  taskManager = nullptr,
IberboxSettingsType  settings = nullptr 
)

Iberbox default constructor.

Parameters
taskManagerThe task manager.
settingsThe settings.

◆ ~Iberbox()

virtual iberbox::Iberbox::~Iberbox ( )
virtual

~Iberbox default destructor

Member Function Documentation

◆ addActionListener()

void iberbox::Iberbox::addActionListener ( ActionListenerType  listener)

Adds a new action listener.

Parameters
listenerThe listener that will handle every action event.
Returns
The listener's onActionFinish method will be provided with the finished action.
If any error occurred, the action's getError method may be used to retrieve such error.
  • E_SUCCESS is returned on success.
  • E_PARAMETERS is returned when some parameters are missing or the provided ones are not valid.
  • E_UNEXPECTED is returned when unexpected behavior occurs.

◆ addBankTransferAsPaymentMethod()

void iberbox::Iberbox::addBankTransferAsPaymentMethod ( ActionListenerType  listener = nullptr)

Adds bank transfer as a payment method for the currently logged-in user's account.

Parameters
listenerThe listener that will handle every action event.
Returns
The listener's onActionFinish method will be provided with the finished action.
If any error occurred, the action's getError method may be used to retrieve such error.
  • E_SUCCESS is returned on success.
  • E_PARAMETERS is returned when some parameters are missing or the provided ones are not valid.
  • E_UNEXPECTED is returned when unexpected behavior occurs.
The returned action type corresponds to ADD_PAYMENT_METHOD.

◆ addContact()

void iberbox::Iberbox::addContact ( NodeHandle  account,
const std::string &  contactName,
ActionListenerType  listener = nullptr 
)

Adds a new contact to the account of the currently logged-in user.

Parameters
accountThe handle of the account to be added as a contact.
contactNameThe alias name to be given to the contact.
listenerThe listener that will handle every action event.
Returns
The listener's onActionFinish method will be provided with the finished action.
If any error occurred, the action's getError method may be used to retrieve such error.
  • E_SUCCESS is returned on success.
  • E_PARAMETERS is returned when some parameters are missing or the provided ones are not valid.
  • E_UNEXPECTED is returned when unexpected behavior occurs.
The returned action type corresponds to MANAGE_CONTACTS.

◆ addDirectDebitAsPaymentMethod()

void iberbox::Iberbox::addDirectDebitAsPaymentMethod ( const std::string &  iban,
const std::string &  holder,
ActionListenerType  listener = nullptr 
)

Adds a bank account as the payment method for the currently logged-in user's account.

Direct debit transactions will be processed automatically when needed.

Parameters
ibanThe international bank account number.
holderThe bank account holder.
listenerThe listener that will handle every action event.
Returns
The listener's onActionFinish method will be provided with the finished action.
If any error occurred, the action's getError method may be used to retrieve such error.
  • E_SUCCESS is returned on success.
  • E_PARAMETERS is returned when some parameters are missing or the provided ones are not valid.
  • E_UNEXPECTED is returned when unexpected behavior occurs.
The returned action type corresponds to ADD_PAYMENT_METHOD.

◆ addEventListener()

void iberbox::Iberbox::addEventListener ( EventListenerType  listener)

Adds a new event listener.

Parameters
listenerThe listener that will handle every action event.
Returns
The listener's onActionFinish method will be provided with the finished action.
If any error occurred, the action's getError method may be used to retrieve such error.
  • E_SUCCESS is returned on success.
  • E_PARAMETERS is returned when some parameters are missing or the provided ones are not valid.
  • E_UNEXPECTED is returned when unexpected behavior occurs.

◆ addResellerCodeAsPaymentMethod()

void iberbox::Iberbox::addResellerCodeAsPaymentMethod ( const std::string &  code,
ActionListenerType  listener = nullptr 
)

Adds a reseller code as the payment method for the currently logged-in user's account.

Parameters
codeThe reseller's code.
listenerThe listener that will handle every action event.
Returns
The listener's onActionFinish method will be provided with the finished action.
If any error occurred, the action's getError method may be used to retrieve such error.
  • E_SUCCESS is returned on success.
  • E_PARAMETERS is returned when some parameters are missing or the provided ones are not valid.
  • E_UNEXPECTED is returned when unexpected behavior occurs.
The returned action type corresponds to ADD_PAYMENT_METHOD.

◆ archiveSharedDrive()

void iberbox::Iberbox::archiveSharedDrive ( NodeHandle  sharedDrive,
ActionListenerType  listener = nullptr 
)

Archives an owned shared drive removing every permission to other accounts.

// TODO:

Parameters
sharedDriveThe handle of the shared drive to be archived.
listenerThe listener that will handle every action event.

◆ authorizeBackup()

void iberbox::Iberbox::authorizeBackup ( NodeHandle  backupId,
ActionListenerType  listener = nullptr 
)

Authorizes an existing backup.

Parameters
backupIdThe handle of the node representing the backup to authorize.
listenerThe listener that will handle every action event.
Returns
The listener's onActionFinish method will be provided with the finished action.
If any error occurred, the action's getError method may be used to retrieve such error.
  • E_SUCCESS is returned on success.
  • E_PARAMETERS is returned when some parameters are missing or the provided ones are not valid.
  • E_UNEXPECTED is returned when unexpected behavior occurs.
Otherwise, the action's getNode method may be used to retrieve the node representing the backup.
The returned action type corresponds to AUTHORIZE_BACKUP.

◆ cancelTransferByTag()

void iberbox::Iberbox::cancelTransferByTag ( int  tag,
ActionListenerType  listener = nullptr 
)

Cancels the transfer identified by tag.

Parameters
tagThe identifier of the transfer that will be canceled.
listenerThe listener that will handle every action event.
Returns
The listener's onActionFinish method will be provided with the finished action.
If any error occurred, the action's getError method may be used to retrieve such error.
  • E_SUCCESS is returned on success.
  • E_PARAMETERS is returned when some parameters are missing or the provided ones are not valid.
  • E_UNEXPECTED is returned when unexpected behavior occurs.
The returned action type corresponds to CANCEL_TRANSFERS.

◆ cancelTransfers()

void iberbox::Iberbox::cancelTransfers ( ActionListenerType  listener = nullptr)

Cancels every transfer.

Parameters
listenerThe listener that will handle every action event.
Returns
The listener's onActionFinish method will be provided with the finished action.
If any error occurred, the action's getError method may be used to retrieve such error.
  • E_SUCCESS is returned on success.
  • E_PARAMETERS is returned when some parameters are missing or the provided ones are not valid.
  • E_UNEXPECTED is returned when unexpected behavior occurs.
The returned action type corresponds to CANCEL_TRANSFERS.

◆ cancelTransfersByType()

void iberbox::Iberbox::cancelTransfersByType ( int  type,
ActionListenerType  listener = nullptr 
)

Cancels every transfer that meets the type filter.

Parameters
typeThe transfer type which the list of transfers will be filtered with.
listenerThe listener that will handle every action event.
Returns
The listener's onActionFinish method will be provided with the finished action.
If any error occurred, the action's getError method may be used to retrieve such error.
  • E_SUCCESS is returned on success.
  • E_PARAMETERS is returned when some parameters are missing or the provided ones are not valid.
  • E_UNEXPECTED is returned when unexpected behavior occurs.
The returned action type corresponds to CANCEL_TRANSFERS.

◆ changeBackupPath()

void iberbox::Iberbox::changeBackupPath ( NodeHandle  backupId,
const std::string &  localPath,
ActionListenerType  listener = nullptr 
)

Changes the path of a specified backup.

Parameters
backupIdThe handle of the node representing the backup whose path will be changed.
localPathThe new path in the local filesystem to be set in the specified backup.
listenerThe listener that will handle every action event.
Returns
The listener's onActionFinish method will be provided with the finished action.
If any error occurred, the action's getError method may be used to retrieve such error.
  • E_SUCCESS is returned on success.
  • E_PARAMETERS is returned when some parameters are missing or the provided ones are not valid.
  • E_UNEXPECTED is returned when unexpected behavior occurs.
Otherwise, the action's getNode method may be used to retrieve the modified node representing the backup.
The returned action type corresponds to CHANGE_BACKUP_PATH.

◆ changeBackupSchedule()

void iberbox::Iberbox::changeBackupSchedule ( NodeHandle  backupId,
unsigned long  startTime,
std::string  cronExpr,
ActionListenerType  listener = nullptr 
)

Changes the schedule of a specified backup.

cronExpr must follow the following format:

.--------------- minute (0-59)
|  .------------ hour (0-23)
|  |  .--------- day of the month (1-31)
|  |  |  .------ month (1-12) or jan,feb,mar,apr,may,jun,jul...
|  |  |  |  .--- day of the week (0-6) (sunday=0 or 7) or sun,mon,tue,wed,thu,fri,sat
|  |  |  |  |
*  *  *  *  *
Parameters
backupIdThe handle of the node representing the backup whose schedule will be changed.
startTimeThe new start time from which the snapshots will start being created.
cronExprThe cron expression of the interval between one snapshot and another.
listenerThe listener that will handle every action event.
Returns
The listener's onActionFinish method will be provided with the finished action.
If any error occurred, the action's getError method may be used to retrieve such error.
  • E_SUCCESS is returned on success.
  • E_PARAMETERS is returned when some parameters are missing or the provided ones are not valid.
  • E_UNEXPECTED is returned when unexpected behavior occurs.
Otherwise, the action's getNode method may be used to retrieve the modified node representing the backup.
The returned action type corresponds to CHANGE_BACKUP_SCHEDULE.

◆ changeBackupStatus()

void iberbox::Iberbox::changeBackupStatus ( NodeHandle  backupId,
int  status,
ActionListenerType  listener = nullptr 
)

Changes the status of a specified backup.

The possible status values are described by NodeData::BackupStatus.

Parameters
backupIdThe handle of the node representing the backup whose status will be changed.
statusThe new status to be set.
listenerThe listener that will handle every action event.
Returns
The listener's onActionFinish method will be provided with the finished action.
If any error occurred, the action's getError method may be used to retrieve such error.
  • E_SUCCESS is returned on success.
  • E_PARAMETERS is returned when some parameters are missing or the provided ones are not valid.
  • E_UNEXPECTED is returned when unexpected behavior occurs.
Otherwise, the action's getNode method may be used to retrieve the modified node representing the backup.
The returned action type corresponds to CHANGE_BACKUP_STATUS.

◆ changePassword()

void iberbox::Iberbox::changePassword ( const std::string &  password,
ActionListenerType  listener = nullptr 
)

Changes the password of the currently logged-in user.

Parameters
passwordThe new password to be set.
listenerThe listener that will handle every action event.
Returns
The listener's onActionFinish method will be provided with the finished action.
If any error occurred, the action's getError method may be used to retrieve such error.
  • E_SUCCESS is returned on success.
  • E_PARAMETERS is returned when some parameters are missing or the provided ones are not valid.
  • E_UNEXPECTED is returned when unexpected behavior occurs.
  • E_FORBIDDEN is returned when no user is logged in.
The returned action type corresponds to CHANGE_PASSWORD.

◆ checkJoinLink()

void iberbox::Iberbox::checkJoinLink ( const std::string &  link,
const std::string &  email,
ActionListenerType  listener = nullptr 
)

Checks a previously created join link using createJoinLink method.

If there isn't already an user regsitered in the platform with the given email a registration identifier will be returned to proceed with user registration using joinAccount method. The returned account's master key and identifier will be required by either joinAccount or joinAccountWithCurrentUser.

Parameters
linkThe link to be checked.
emailThe email of the receiver of the invitation.
listenerThe listener that will handle every action event.
Returns
The listener's onActionFinish method will be provided with the finished action.
If any error occurred, the action's getError method may be used to retrieve such error.
  • E_SUCCESS is returned on success.
  • E_PARAMETERS is returned when some parameters are missing or the provided ones are not valid.
  • E_UNEXPECTED is returned when unexpected behavior occurs.
Otherwise, the action's getText method may be used to retrieve the registrationId when needed, the getAccountId method to retrieve the handle of the account the user will have access to and the getSession method to retrieve base64 form of the account's master key.
The returned action type corresponds to JOIN_LINK.

◆ checkPassword()

void iberbox::Iberbox::checkPassword ( const std::string &  password,
ActionListenerType  listener = nullptr 
)

Checks user's password against a given one.

Checks if the current logged-in user's password matches the given one.

Parameters
password
listenerThe listener that will handle every action event.
Returns
The listener's onActionFinish method will be provided with the finished action.
If any error occurred, the action's getError method may be used to retrieve such error.
  • E_SUCCESS is returned on success.
  • E_PARAMETERS is returned when some parameters are missing or the provided ones are not valid.
  • E_UNEXPECTED is returned when unexpected behavior occurs.
The returned action type corresponds to LOGIN.

◆ checkUpdate()

void iberbox::Iberbox::checkUpdate ( const std::string &  appName,
int  version,
ActionListenerType  listener = nullptr 
)
Todo:
Parameters
appName
version
listenerThe listener that will handle every action event.
Returns
The listener's onActionFinish method will be provided with the finished action.
If any error occurred, the action's getError method may be used to retrieve such error.
  • E_SUCCESS is returned on success.
  • E_PARAMETERS is returned when some parameters are missing or the provided ones are not valid.
  • E_UNEXPECTED is returned when unexpected behavior occurs.
The returned action type corresponds to UPDATE.

◆ clearFinishedTransferByTag()

void iberbox::Iberbox::clearFinishedTransferByTag ( int  tag,
ActionListenerType  listener = nullptr 
)

Clears the transfer identified by tag if it has finished.

Parameters
tagThe identifier of the transfer that will be cleared if it has finished.
listenerThe listener that will handle every action event.
Returns
The listener's onActionFinish method will be provided with the finished action.
If any error occurred, the action's getError method may be used to retrieve such error.
  • E_SUCCESS is returned on success.
  • E_PARAMETERS is returned when some parameters are missing or the provided ones are not valid.
  • E_UNEXPECTED is returned when unexpected behavior occurs.
The returned action type corresponds to CLEAR_FINISHED_TRANSFERS.

◆ clearFinishedTransfers()

void iberbox::Iberbox::clearFinishedTransfers ( ActionListenerType  listener = nullptr)

Clears every finished transfer.

Parameters
listenerThe listener that will handle every action event.
Returns
The listener's onActionFinish method will be provided with the finished action.
If any error occurred, the action's getError method may be used to retrieve such error.
  • E_SUCCESS is returned on success.
  • E_PARAMETERS is returned when some parameters are missing or the provided ones are not valid.
  • E_UNEXPECTED is returned when unexpected behavior occurs.
The returned action type corresponds to CLEAR_FINISHED_TRANSFERS.

◆ clearFinishedTransfersByType()

void iberbox::Iberbox::clearFinishedTransfersByType ( int  type,
ActionListenerType  listener = nullptr 
)

Clears every finished transfer that meets the type filter.

Parameters
typeThe transfer type which the list of transfers will be filtered with.
listenerThe listener that will handle every action event.
Returns
The listener's onActionFinish method will be provided with the finished action.
If any error occurred, the action's getError method may be used to retrieve such error.
  • E_SUCCESS is returned on success.
  • E_PARAMETERS is returned when some parameters are missing or the provided ones are not valid.
  • E_UNEXPECTED is returned when unexpected behavior occurs.
The returned action type corresponds to CLEAR_FINISHED_TRANSFERS.

◆ closeSecret()

void iberbox::Iberbox::closeSecret ( NodeHandle  secretHandle,
ActionListenerType  listener = nullptr 
)

Closes a secret space given its handle.

Parameters
secretHandleThe handle of the secret space that will be closed.
listenerThe listener that will handle every action event.
Returns
The listener's onActionFinish method will be provided with the finished action.
If any error occurred, the action's getError method may be used to retrieve such error.
  • E_SUCCESS is returned on success.
  • E_PARAMETERS is returned when some parameters are missing or the provided ones are not valid.
  • E_UNEXPECTED is returned when unexpected behavior occurs.
The returned action type corresponds to MANAGE_SECRETS.

◆ copyNode()

void iberbox::Iberbox::copyNode ( NodeHandle  node,
NodeHandle  parent,
ActionListenerType  listener = nullptr 
)

Copies a node to a diferent path.

If the node to be copied is a folder, a deep (recursive) copy is carried out.

Parameters
nodeThe handle of the node that will be copied.
parentThe handle of the node from which the node will descend.
listenerThe listener that will handle every action event.
Returns
The listener's onActionFinish method will be provided with the finished action.
If any error occurred, the action's getError method may be used to retrieve such error.
  • E_SUCCESS is returned on success.
  • E_PARAMETERS is returned when some parameters are missing or the provided ones are not valid.
  • E_UNEXPECTED is returned when unexpected behavior occurs.
  • E_NOTFOUND is returned when either the node being copied or the destination folder is not found.
  • E_FORBIDDEN is returned when the user lacks permissions or the node being copied is protected.
Otherwise, the action's getNode method may be used to retrieve the copied node.
The returned action type corresponds to COPY_NODE.

◆ createAccount()

void iberbox::Iberbox::createAccount ( const std::string &  registrationId,
const std::string &  name,
const std::string &  lastName,
const std::string &  email,
const std::string &  password,
int  pin,
ActionListenerType  listener = nullptr 
)

Creates a new user account making use of the registrationId and pin that were generated after using verifyEmail.

Deprecated:
Better use createAccountWithCoupon.
Parameters
registrationIdThe registration identifier.
nameThe name of the user.
lastNameThe last name of the user.
emailThe email that the user will use to log in.
passwordThe password that the user will use to log in.
pinThe 6-digit email verification code. This code cannot be 0.
listenerThe listener that will handle every action event.
Returns
The listener's onActionFinish method will be provided with the finished action.
If any error occurred, the action's getError method may be used to retrieve such error.
  • E_SUCCESS is returned on success.
  • E_PARAMETERS is returned when some parameters are missing or the provided ones are not valid.
  • E_UNEXPECTED is returned when unexpected behavior occurs.
  • E_CRYPTO is returned when any cryptographic process fails.
  • E_DUPLICATE is returned when the provided email has already been registered.
  • E_NOTFOUND is returned when there is no match between the provided registrationId and the provided email.
  • E_FORBIDDEN is returned when the pin does not match the emailed one.
Otherwise, the action's getText method may be used to retrieve the registration identifier.
The returned action type corresponds to CREATE_ACCOUNT.

◆ createAccountForCurrentUser()

void iberbox::Iberbox::createAccountForCurrentUser ( const std::string &  coupon,
ActionListenerType  listener = nullptr 
)

Creates a new user account for the currently logged-in user.

A discount coupon may be provided as well.

Parameters
couponThe discount coupon.
listenerThe listener that will handle every action event.
Returns
The listener's onActionFinish method will be provided with the finished action.
If any error occurred, the action's getError method may be used to retrieve such error.
  • E_SUCCESS is returned on success.
  • E_PARAMETERS is returned when some parameters are missing or the provided ones are not valid.
  • E_UNEXPECTED is returned when unexpected behavior occurs.
  • E_CRYPTO is returned when any cryptographic process fails.
  • E_FORBIDDEN is returned when no user is logged in or the logged-in user is not allowed to create a new account.
  • E_COUPON is returned when the coupon does not exist or is no longer valid.
Otherwise, the action's getText method may be used to retrieve the registration identifier.
The returned action type corresponds to CREATE_ACCOUNT.

◆ createAccountWithCoupon()

void iberbox::Iberbox::createAccountWithCoupon ( const std::string &  registrationId,
const std::string &  name,
const std::string &  lastName,
const std::string &  email,
const std::string &  password,
int  pin,
const std::string &  coupon,
ActionListenerType  listener = nullptr 
)

Creates a new user account making use of the registrationId and pin that were generated after using verifyEmail.

A discount coupon may be provided as well.

Parameters
registrationIdThe registration identifier.
nameThe name of the user.
lastNameThe last name of the user.
emailThe email that the user will use to log in.
passwordThe password that the user will use to log in.
pinThe 6-digit email verification code. This code cannot be 0.
couponThe discount coupon.
listenerThe listener that will handle every action event.
Returns
The listener's onActionFinish method will be provided with the finished action.
If any error occurred, the action's getError method may be used to retrieve such error.
  • E_SUCCESS is returned on success.
  • E_PARAMETERS is returned when some parameters are missing or the provided ones are not valid.
  • E_UNEXPECTED is returned when unexpected behavior occurs.
  • E_CRYPTO is returned when any cryptographic process fails.
  • E_DUPLICATE is returned when the provided email has already been registered.
  • E_NOTFOUND is returned when there is no match between the provided registrationId and the provided email.
  • E_FORBIDDEN is returned when the pin does not match the emailed one.
  • E_COUPON is returned when the coupon does not exist or is no longer valid.
Otherwise, the action's getText method may be used to retrieve the registration identifier.
The returned action type corresponds to CREATE_ACCOUNT.

◆ createAccountWithPlan()

void iberbox::Iberbox::createAccountWithPlan ( const std::string &  registrationId,
const std::string &  name,
const std::string &  lastName,
const std::string &  email,
const std::string &  password,
int  pin,
const std::string &  coupon,
int  planId,
ActionListenerType  listener = nullptr 
)

Creates a new user account making use of the registrationId and pin that were generated after using verifyEmail.

An existing plan identifier must be specified. Valid values may be obtained using getSubscriptionOptions.
A discount coupon may be provided as well.

Parameters
registrationIdThe registration identifier.
nameThe name of the user.
lastNameThe last name of the user.
emailThe email that the user will use to log in.
passwordThe password that the user will use to log in.
pinThe 6-digit email verification code. This code cannot be 0.
couponThe discount coupon.
planIdThe plan identifier.
listenerThe listener that will handle every action event.
Returns
The listener's onActionFinish method will be provided with the finished action.
If any error occurred, the action's getError method may be used to retrieve such error.
  • E_SUCCESS is returned on success.
  • E_PARAMETERS is returned when some parameters are missing or the provided ones are not valid.
  • E_UNEXPECTED is returned when unexpected behavior occurs.
  • E_CRYPTO is returned when any cryptographic process fails.
  • E_DUPLICATE is returned when the provided email has already been registered.
  • E_NOTFOUND is returned when there is no match between the provided registrationId and the provided email.
  • E_FORBIDDEN is returned when the pin does not match the emailed one.
  • E_COUPON is returned when the coupon does not exist or is no longer valid.
Otherwise, the action's getText method may be used to retrieve the registration identifier.
The returned action type corresponds to CREATE_ACCOUNT.

◆ createBackup()

void iberbox::Iberbox::createBackup ( const std::string &  name,
unsigned long  startTime,
const std::string  cronExpr,
const std::string &  localPath,
int  maxSnapshots,
int  status,
ActionListenerType  listener = nullptr 
)

Creates a new backup.

cronExpr must follow the following format:

.--------------- minute (0-59)
|  .------------ hour (0-23)
|  |  .--------- day of the month (1-31)
|  |  |  .------ month (1-12) or jan,feb,mar,apr,may,jun,jul...
|  |  |  |  .--- day of the week (0-6) (sunday=0 or 7) or sun,mon,tue,wed,thu,fri,sat
|  |  |  |  |
*  *  *  *  *
Parameters
nameThe name that will be given to the backup.
startTimeThe start time from which the snapshots will start being created.
cronExprThe cron expression of the interval between one snapshot and another.
localPathThe local path that will be backed up.
maxSnapshotsThe maximum number of the backup snapshots to be kept.
statusThe initial status of the backup.
listenerThe listener that will handle every action event.
Returns
The listener's onActionFinish method will be provided with the finished action.
If any error occurred, the action's getError method may be used to retrieve such error.
  • E_SUCCESS is returned on success.
  • E_PARAMETERS is returned when some parameters are missing or the provided ones are not valid.
  • E_UNEXPECTED is returned when unexpected behavior occurs.
Otherwise, the action's getNode method may be used to retrieve the node representing the new backup.
The returned action type corresponds to CREATE_BACKUP.

◆ createFolder()

void iberbox::Iberbox::createFolder ( NodeHandle  parent,
const std::string &  name,
ActionListenerType  listener = nullptr 
)

Creates a new folder with the specified name as a descendant of the parent.

Creates a new folder with the specified name as a descendant of the parent.

Parameters
parentThe handler of the node from which the new folder will descend.
nameThe name of the folder that will be created.
listenerThe listener that will handle every action event.
Returns
The listener's onActionFinish method will be provided with the finished action.
If any error occurred, the action's getError method may be used to retrieve such error.
  • E_SUCCESS is returned on success.
  • E_PARAMETERS is returned when some parameters are missing or the provided ones are not valid.
  • E_UNEXPECTED is returned when unexpected behavior occurs.
Otherwise, the action's getNode method may be used to retrieve the first node of the new tree.
The returned action type corresponds to ADD_NODES.

◆ createInbox()

void iberbox::Iberbox::createInbox ( const std::string &  name,
const std::string &  message,
ActionListenerType  listener = nullptr 
)

Creates a new inbox for electronic record management.

Parameters
nameThe name of the inbox.
messageThe description of the inbox.
listenerThe listener that will handle every action event.
Returns
The listener's onActionFinish method will be provided with the finished action.
If any error occurred, the action's getError method may be used to retrieve such error.
  • E_SUCCESS is returned on success.
  • E_PARAMETERS is returned when some parameters are missing or the provided ones are not valid.
  • E_UNEXPECTED is returned when unexpected behavior occurs.
Otherwise, the action's getNode method may be used to retrieve the node representing the created inbox.
The returned action type corresponds to CREATE_INBOX.

◆ createJoinLink()

void iberbox::Iberbox::createJoinLink ( const std::string &  email,
ActionListenerType  listener = nullptr 
)

Creates a join link for a specific email.

Only the specified email will be able to join the platform using the created link.
The created link will be required by checkJoinLink method. The user that uses the join link will get read/write permissions in the account

Parameters
emailThe email of the receiver of the invitation.
listenerThe listener that will handle every action event.
Returns
The listener's onActionFinish method will be provided with the finished action.
If any error occurred, the action's getError method may be used to retrieve such error.
  • E_SUCCESS is returned on success.
  • E_PARAMETERS is returned when some parameters are missing or the provided ones are not valid.
  • E_UNEXPECTED is returned when unexpected behavior occurs.
Otherwise, the action's getLink method may be used to retrieve the created join link.
The returned action type corresponds to JOIN_LINK.

◆ createJoinLinkWithAccessLevel()

void iberbox::Iberbox::createJoinLinkWithAccessLevel ( const std::string &  email,
int  accessLevel,
ActionListenerType  listener = nullptr 
)

Creates a join link for a specific email.

Only the specified email will be able to join the platform using the created link.
The created link will be required by checkJoinLink method. The user that uses the join link will get permissions according to the accessLevel parameter

Parameters
emailThe email of the receiver of the invitation.
accessLevelAccess level granted to the user. Valid values are:
listenerThe listener that will handle every action event.
Returns
The listener's onActionFinish method will be provided with the finished action.
If any error occurred, the action's getError method may be used to retrieve such error.
  • E_SUCCESS is returned on success.
  • E_PARAMETERS is returned when some parameters are missing or the provided ones are not valid.
  • E_UNEXPECTED is returned when unexpected behavior occurs.
Otherwise, the action's getLink method may be used to retrieve the created join link.
The returned action type corresponds to JOIN_LINK.

◆ createLink()

void iberbox::Iberbox::createLink ( NodeHandle  node,
ActionListenerType  listener = nullptr 
)

Creates a link to a specified node (file, folder or inbox).

If the specified node is a folder, a full and static copy of its contents is created.

Parameters
nodeThe node whose
listenerThe listener that will handle every action event.
Returns
The listener's onActionFinish method will be provided with the finished action.
If any error occurred, the action's getError method may be used to retrieve such error.
  • E_SUCCESS is returned on success.
  • E_PARAMETERS is returned when some parameters are missing or the provided ones are not valid.
  • E_UNEXPECTED is returned when unexpected behavior occurs.
Otherwise, the action's getLink method may be used to retrieve the link to the specified node and getNode method to retrieve such node.
The returned action type corresponds to CREATE_LINK.

◆ createResellerCoupon()

void iberbox::Iberbox::createResellerCoupon ( const std::string &  email = std::string(),
ActionListenerType  listener = nullptr 
)

Creates a new reseller-type coupon.

Optionally, an email may be provided to identify coupon's beneficiary.
Coupons' types are described by the CouponType enum.

Parameters
emailThe email of the coupon's beneficiary.
listenerThe listener that will handle every action event.
Returns
The listener's onActionFinish method will be provided with the finished action.
If any error occurred, the action's getError method may be used to retrieve such error.
  • E_SUCCESS is returned on success.
  • E_PARAMETERS is returned when some parameters are missing or the provided ones are not valid.
  • E_UNEXPECTED is returned when unexpected behavior occurs.
Otherwise, the action's getCoupon method may be used to retrieve the newly created coupon.
The returned action type corresponds to COUPONS.

◆ createResellerCouponWithPlan()

void iberbox::Iberbox::createResellerCouponWithPlan ( int  planId,
const std::string &  email = std::string(),
ActionListenerType  listener = nullptr 
)

Creates a new reseller-type coupon with an associated plan.

Optionally, an email may be provided to identify coupon's beneficiary.
Coupons' types are described by the CouponType enum.

Parameters
planIdThe identifier of the plan that the coupon will be valid for.
emailThe email of the coupon's beneficiary.
listenerThe listener that will handle every action event.
Returns
The listener's onActionFinish method will be provided with the finished action.
If any error occurred, the action's getError method may be used to retrieve such error.
  • E_SUCCESS is returned on success.
  • E_PARAMETERS is returned when some parameters are missing or the provided ones are not valid.
  • E_UNEXPECTED is returned when unexpected behavior occurs.
Otherwise, the action's getCoupon method may be used to retrieve the newly created coupon.
The returned action type corresponds to COUPONS.

◆ createSecret()

void iberbox::Iberbox::createSecret ( const std::string &  name,
const std::string &  password,
ActionListenerType  listener = nullptr 
)

Creates a secret space with the specified credentials.

Parameters
nameThe name of the new secret space.
passwordThe password of the new secret space.
listenerThe listener that will handle every action event.
Returns
The listener's onActionFinish method will be provided with the finished action.
If any error occurred, the action's getError method may be used to retrieve such error.
  • E_SUCCESS is returned on success.
  • E_PARAMETERS is returned when some parameters are missing or the provided ones are not valid.
  • E_UNEXPECTED is returned when unexpected behavior occurs.
Otherwise, the action's getNode method to retrieve the new secret space's root node.
The returned action type corresponds to MANAGE_SECRETS.

◆ createSharedDrive()

void iberbox::Iberbox::createSharedDrive ( const std::string &  name,
ActionListenerType  listener = nullptr 
)

Creates a shared drive with the specified name.

Parameters
nameThe name of the new shared drive.
listenerThe listener that will handle every action event.
Returns
The listener's onActionFinish method will be provided with the finished action.
If any error occurred, the action's getError method may be used to retrieve such error.
  • E_SUCCESS is returned on success.
  • E_PARAMETERS is returned when some parameters are missing or the provided ones are not valid.
  • E_UNEXPECTED is returned when unexpected behavior occurs.
Otherwise, the action's getNode method to retrieve the new shared drive's root node.
The returned action type corresponds to MANAGE_SHARED_DRIVES.

◆ createSharedDriveLink()

void iberbox::Iberbox::createSharedDriveLink ( NodeHandle  node,
int  accessLevel,
ActionListenerType  listener = nullptr 
)

Creates a link to a specified shared drive node.

Parameters
nodeThe shared drive node to share
accessLevelThe access level to apply to the link. This parameter is only valid for shared drive links. Valid values are:
listenerThe listener that will handle every action event.
Returns
The listener's onActionFinish method will be provided with the finished action.
If any error occurred, the action's getError method may be used to retrieve such error.
  • E_SUCCESS is returned on success.
  • E_PARAMETERS is returned when some parameters are missing or the provided ones are not valid.
  • E_UNEXPECTED is returned when unexpected behavior occurs.
Otherwise, the action's getLink method may be used to retrieve the link to the specified node and getNode method to retrieve such node.
The returned action type corresponds to CREATE_LINK.

◆ createVirtuallyNestedSharedDrive()

void iberbox::Iberbox::createVirtuallyNestedSharedDrive ( NodeHandle  parent,
const std::string &  name,
ActionListenerType  listener = nullptr 
)

Creates a virtually nested shared drive with the specified name and the specified share drive "parent".

Parameters
parentThe handle of the "parent" shared drive.
nameThe name of the new shared drive.
listenerThe listener that will handle every action event.
Returns
The listener's onActionFinish method will be provided with the finished action.
If any error occurred, the action's getError method may be used to retrieve such error.
  • E_SUCCESS is returned on success.
  • E_PARAMETERS is returned when some parameters are missing or the provided ones are not valid.
  • E_UNEXPECTED is returned when unexpected behavior occurs.
Otherwise, the action's getNode method to retrieve the new shared drive's root node.
The returned action type corresponds to MANAGE_SHARED_DRIVES.

◆ currentEmail()

void iberbox::Iberbox::currentEmail ( ActionListenerType  listener = nullptr)

Gets the email of the currently logged-in user.

Parameters
listenerThe listener that will handle every action event.
Returns
The listener's onActionFinish method will be provided with the finished action.
If any error occurred, the action's getError method may be used to retrieve such error.
  • E_SUCCESS is returned on success.
  • E_PARAMETERS is returned when some parameters are missing or the provided ones are not valid.
  • E_UNEXPECTED is returned when unexpected behavior occurs.
Otherwise, the action's getEmail method may be used to retrieve the email address of the currently logged-in user.
The returned action type corresponds to CURRENT_EMAIL.

◆ deauthorizeBackup()

void iberbox::Iberbox::deauthorizeBackup ( NodeHandle  backupId,
ActionListenerType  listener = nullptr 
)

Deauthorizes an existing backup.

Parameters
backupIdThe handle of the node representing the backup to deauthorize.
listenerThe listener that will handle every action event.
Returns
The listener's onActionFinish method will be provided with the finished action.
If any error occurred, the action's getError method may be used to retrieve such error.
  • E_SUCCESS is returned on success.
  • E_PARAMETERS is returned when some parameters are missing or the provided ones are not valid.
  • E_UNEXPECTED is returned when unexpected behavior occurs.
Otherwise, the action's getNode method may be used to retrieve the node representing the backup.
The returned action type corresponds to AUTHORIZE_BACKUP.

◆ deleteAccount()

void iberbox::Iberbox::deleteAccount ( const std::string &  reason,
ActionListenerType  listener = nullptr 
)

Deletes the current account.

Parameters
reasonReason to delete the account. It can be an empty string.
listenerThe listener that will handle every action event.
Returns
The listener's onActionFinish method will be provided with the finished action.
If any error occurred, the action's getError method may be used to retrieve such error.
  • E_SUCCESS is returned on success.
  • E_PARAMETERS is returned when some parameters are missing or the provided ones are not valid.
  • E_UNEXPECTED is returned when unexpected behavior occurs.
The returned action type corresponds to DELETE_ACCOUNT.

◆ deleteBackup()

void iberbox::Iberbox::deleteBackup ( NodeHandle  backupId,
ActionListenerType  listener = nullptr 
)

Deletes an existing backup.

Parameters
backupIdThe handle of the node representing the backup to be removed.
listenerThe listener that will handle every action event.
Returns
The listener's onActionFinish method will be provided with the finished action.
If any error occurred, the action's getError method may be used to retrieve such error.
  • E_SUCCESS is returned on success.
  • E_PARAMETERS is returned when some parameters are missing or the provided ones are not valid.
  • E_UNEXPECTED is returned when unexpected behavior occurs.
The returned action type corresponds to DELETE_BACKUP.

◆ deleteCoupon()

void iberbox::Iberbox::deleteCoupon ( int  id,
ActionListenerType  listener = nullptr 
)

Deletes a coupon given its identifier.

Parameters
idThe coupon identifier.
listenerThe listener that will handle every action event.
Returns
The listener's onActionFinish method will be provided with the finished action.
If any error occurred, the action's getError method may be used to retrieve such error.
  • E_SUCCESS is returned on success.
  • E_PARAMETERS is returned when some parameters are missing or the provided ones are not valid.
  • E_UNEXPECTED is returned when unexpected behavior occurs.
The returned action type corresponds to COUPONS.

◆ deleteDevice()

void iberbox::Iberbox::deleteDevice ( NodeHandle  deviceId,
ActionListenerType  listener = nullptr 
)

Deletes the deviced identified by deviceId.

Parameters
deviceIdThe handle of the node that uniquely identifies the requested device.
listenerThe listener that will handle every action event.
Returns
The listener's onActionFinish method will be provided with the finished action.
If any error occurred, the action's getError method may be used to retrieve such error.
  • E_SUCCESS is returned on success.
  • E_PARAMETERS is returned when some parameters are missing or the provided ones are not valid.
  • E_UNEXPECTED is returned when unexpected behavior occurs.
The returned action type corresponds to DELETE_DEVICE.

◆ deleteLink()

void iberbox::Iberbox::deleteLink ( const std::string &  link,
ActionListenerType  listener = nullptr 
)

Deletes a public link.

Parameters
linkLink to delete
listenerThe listener that will handle every action event.
Returns
The listener's onActionFinish method will be provided with the finished action.
If any error occurred, the action's getError method may be used to retrieve such error.
  • E_SUCCESS is returned on success.
  • E_PARAMETERS is returned when some parameters are missing or the provided ones are not valid.
  • E_UNEXPECTED is returned when unexpected behavior occurs.
The returned action type corresponds to DELETE_LINK.

◆ deleteNode()

void iberbox::Iberbox::deleteNode ( NodeHandle  node,
ActionListenerType  listener = nullptr 
)

Deletes a node given its handle.

Under normal conditions, the node will be sent to the rubbish bin, unless the node is already there, in which case the node will be removed permanently.

Parameters
node
listenerThe listener that will handle every action event.
Returns
The listener's onActionFinish method will be provided with the finished action.
If any error occurred, the action's getError method may be used to retrieve such error.
  • E_SUCCESS is returned on success.
  • E_PARAMETERS is returned when some parameters are missing or the provided ones are not valid.
  • E_UNEXPECTED is returned when unexpected behavior occurs.
The returned action type corresponds to DELETE_NODE.

◆ deleteNodePermanently()

void iberbox::Iberbox::deleteNodePermanently ( NodeHandle  node,
ActionListenerType  listener = nullptr 
)

Deletes a node permanently given its handle.

No matter whether the node is in the rubbish bin or not, it will be deleted permanently without be sent to the rubbish bin previously.

Parameters
node
listenerThe listener that will handle every action event.
Returns
The listener's onActionFinish method will be provided with the finished action.
If any error occurred, the action's getError method may be used to retrieve such error.
  • E_SUCCESS is returned on success.
  • E_PARAMETERS is returned when some parameters are missing or the provided ones are not valid.
  • E_UNEXPECTED is returned when unexpected behavior occurs.
The returned action type corresponds to DELETE_NODE.

◆ deleteSecret()

void iberbox::Iberbox::deleteSecret ( NodeHandle  secretHandle,
ActionListenerType  listener = nullptr 
)

Deletes a secret space given its handle.

Parameters
secretHandleThe handle of the secret to be deleted.
listenerThe listener that will handle every action event.
Returns
The listener's onActionFinish method will be provided with the finished action.
If any error occurred, the action's getError method may be used to retrieve such error.
  • E_SUCCESS is returned on success.
  • E_PARAMETERS is returned when some parameters are missing or the provided ones are not valid.
  • E_UNEXPECTED is returned when unexpected behavior occurs.
The returned action type corresponds to MANAGE_SECRETS.

◆ deleteSharedDrive()

void iberbox::Iberbox::deleteSharedDrive ( NodeHandle  sharedDrive,
ActionListenerType  listener = nullptr 
)

Deletes a shared drive given its handle.

Parameters
sharedDriveThe handle of the shared drive to be deleted.
listenerThe listener that will handle every action event.
Returns
The listener's onActionFinish method will be provided with the finished action.
If any error occurred, the action's getError method may be used to retrieve such error.
  • E_SUCCESS is returned on success.
  • E_PARAMETERS is returned when some parameters are missing or the provided ones are not valid.
  • E_UNEXPECTED is returned when unexpected behavior occurs.
The returned action type corresponds to MANAGE_SHARED_DRIVES.

◆ disable2fa()

void iberbox::Iberbox::disable2fa ( int  code,
ActionListenerType  listener = nullptr 
)

Disables the 2FA method for the currently logged-in user.

Parameters
codeA code generated with any TOTP generator using the URL generated after calling generate2faUrl.
listenerThe listener that will handle every action event.
Returns
The listener's onActionFinish method will be provided with the finished action.
If any error occurred, the action's getError method may be used to retrieve such error.
  • E_SUCCESS is returned on success.
  • E_PARAMETERS is returned when some parameters are missing or the provided ones are not valid.
  • E_UNEXPECTED is returned when unexpected behavior occurs.
The returned action type corresponds to MANAGE_2FA.

◆ download()

void iberbox::Iberbox::download ( NodeHandle  node,
const std::string &  parent,
ActionListenerType  listener = nullptr 
)

Downloads a file or folder to a specific local filesystem directory.

Parameters
nodeThe node handler of the file or folder to be downloaded.
parentThe path to the local filesystem where the node will be downloaded.
listenerThe listener that will handle every action event.
Returns
The listener's onActionFinish method will be provided with the finished action.
If any error occurred, the action's getError method may be used to retrieve such error.
  • E_SUCCESS is returned on success.
  • E_PARAMETERS is returned when some parameters are missing or the provided ones are not valid.
  • E_UNEXPECTED is returned when unexpected behavior occurs.
The returned action type corresponds to DOWNLOAD.

◆ downloadInvoice()

void iberbox::Iberbox::downloadInvoice ( int  invoiceId,
const std::string &  path,
ActionListenerType  listener = nullptr 
)

Downloads and writes the invoice identified by invoiceId to the local filesystem at the specified path.

Parameters
invoiceIdThe identifier of the invoice to be downloaded.
pathThe path where the invoice file will be written to.
listenerThe listener that will handle every action event.
Returns
The listener's onActionFinish method will be provided with the finished action.
If any error occurred, the action's getError method may be used to retrieve such error.
  • E_SUCCESS is returned on success.
  • E_PARAMETERS is returned when some parameters are missing or the provided ones are not valid.
  • E_UNEXPECTED is returned when unexpected behavior occurs.
The returned action type corresponds to GET_INVOICE.

◆ downloadLink()

void iberbox::Iberbox::downloadLink ( const std::string &  link,
const std::string &  parent,
ActionListenerType  listener = nullptr 
)

Downloads a file referenced by a public link to the specified directory.

Parameters
linkThe public link to a file or folder hosted by an iberbox account.
parentThe path to the folder where the file or folder will be downloaded.
listenerThe listener that will handle every action event.
Returns
The listener's onActionFinish method will be provided with the finished action.
If any error occurred, the action's getError method may be used to retrieve such error.
  • E_SUCCESS is returned on success.
  • E_PARAMETERS is returned when some parameters are missing or the provided ones are not valid.
  • E_UNEXPECTED is returned when unexpected behavior occurs.
The returned action type corresponds to DOWNLOAD.

◆ downloadLinkWithCustomData()

void iberbox::Iberbox::downloadLinkWithCustomData ( const std::string &  link,
const std::string &  parent,
const std::string &  customData,
ActionListenerType  listener = nullptr 
)

Downloads a file referenced by a public link to the specified directory, associating application data to the transfer.

Parameters
linkThe public link to a file or folder hosted by an iberbox account.
parentThe path to the folder where the file or folder will be downloaded.
customDataCustom data set by the app that can be accessed using getCustomData in callbacks.
listenerThe listener that will handle every action event.
Returns
The listener's onActionFinish method will be provided with the finished action.
If any error occurred, the action's getError method may be used to retrieve such error.
  • E_SUCCESS is returned on success.
  • E_PARAMETERS is returned when some parameters are missing or the provided ones are not valid.
  • E_UNEXPECTED is returned when unexpected behavior occurs.
The returned action type corresponds to DOWNLOAD.

◆ downloadMetadata()

void iberbox::Iberbox::downloadMetadata ( NodeHandle  node,
int  metadataType,
const std::string &  parent,
ActionListenerType  listener = nullptr 
)

Downloads specific metadata for a given node and a metadata type.

metadataType valid values are described in NodeData::MetadataType.

Parameters
nodeThe handle of the node whose metadata will be downloaded.
metadataTypeThe type of the metadata that will be downloaded.
parentThe file path where to download the metadata.
listenerThe listener that will handle every action event.
Returns
The listener's onActionFinish method will be provided with the finished action.
If any error occurred, the action's getError method may be used to retrieve such error.
  • E_SUCCESS is returned on success.
  • E_PARAMETERS is returned when some parameters are missing or the provided ones are not valid.
  • E_UNEXPECTED is returned when unexpected behavior occurs.
Otherwise, the action's getNode method may be used to retrieve the node whose metadata has been updated.
The returned action type corresponds to DOWNLOAD_METADATA.

◆ downloadPublicMetadata()

void iberbox::Iberbox::downloadPublicMetadata ( const std::string &  metadataInfo,
int  metadataType,
const std::string &  parent,
ActionListenerType  listener = nullptr 
)

Downloads specific public metadata for a node given its public metadata information and a metadata type.

metadataType possible values are described in NodeData::MetadataType.

Parameters
metadataInfoThe public metadata info of a node.
metadataTypeThe type of the metadata that will be downloaded.
parentThe file path where to download the metadata.
listenerThe listener that will handle every action event.
Returns
The listener's onActionFinish method will be provided with the finished action.
If any error occurred, the action's getError method may be used to retrieve such error.
  • E_SUCCESS is returned on success.
  • E_PARAMETERS is returned when some parameters are missing or the provided ones are not valid.
  • E_UNEXPECTED is returned when unexpected behavior occurs.
The returned action type corresponds to DOWNLOAD_METADATA.

◆ downloadUpdate()

void iberbox::Iberbox::downloadUpdate ( const std::string &  appName,
int  version,
const std::string &  downloadFolder,
const std::string &  installFolder,
ActionListenerType  listener = nullptr 
)

downloadUpdate

Todo:
Parameters
appName
version
downloadFolder
installFolder
listenerThe listener that will handle every action event.
Returns
The listener's onActionFinish method will be provided with the finished action.
If any error occurred, the action's getError method may be used to retrieve such error.
  • E_SUCCESS is returned on success.
  • E_PARAMETERS is returned when some parameters are missing or the provided ones are not valid.
  • E_UNEXPECTED is returned when unexpected behavior occurs.
The returned action type corresponds to UPDATE.

◆ downloadWithCustomData()

void iberbox::Iberbox::downloadWithCustomData ( NodeHandle  node,
const std::string &  parent,
const std::string &  customData,
ActionListenerType  listener = nullptr 
)

Downloads a file or folder to a specific local filesystem directory, associating application data to the transfer.

Parameters
nodeThe node handler of the file or folder to be downloaded.
parentThe path to the local filesystem where the node will be downloaded.
customDataCustom data set by the app that can be accessed using getCustomData in callbacks.
listenerThe listener that will handle every action event.
Returns
The listener's onActionFinish method will be provided with the finished action.
If any error occurred, the action's getError method may be used to retrieve such error.
  • E_SUCCESS is returned on success.
  • E_PARAMETERS is returned when some parameters are missing or the provided ones are not valid.
  • E_UNEXPECTED is returned when unexpected behavior occurs.
The returned action type corresponds to DOWNLOAD.

◆ downloadZip()

void iberbox::Iberbox::downloadZip ( NodeHandle  node,
const std::string &  parent,
ActionListenerType  listener = nullptr 
)

Generates a downloadable zipped file or folder.

Parameters
nodeThe handle of the file or folder node.
parentThe path to the local filesystem where the zip file will be downloaded.
listenerThe listener that will handle every action event.
Returns
The listener's onActionFinish method will be provided with the finished action.
If any error occurred, the action's getError method may be used to retrieve such error.
  • E_SUCCESS is returned on success.
  • E_PARAMETERS is returned when some parameters are missing or the provided ones are not valid.
  • E_UNEXPECTED is returned when unexpected behavior occurs.
The returned action type corresponds to DOWNLOAD_ZIP.

◆ downloadZipWithCustomData()

void iberbox::Iberbox::downloadZipWithCustomData ( NodeHandle  node,
const std::string &  parent,
const std::string &  customData,
ActionListenerType  listener = nullptr 
)

Generates a downloadable zipped file or folder, associating application data to the transfer.

Parameters
nodeThe handle of the file or folder node.
parentThe path to the local filesystem where the zip file will be downloaded.
listenerThe listener that will handle every action event.
customDataCustom data set by the app that can be accessed using getCustomData in callbacks.
Returns
The listener's onActionFinish method will be provided with the finished action.
If any error occurred, the action's getError method may be used to retrieve such error.
  • E_SUCCESS is returned on success.
  • E_PARAMETERS is returned when some parameters are missing or the provided ones are not valid.
  • E_UNEXPECTED is returned when unexpected behavior occurs.
The returned action type corresponds to DOWNLOAD_ZIP.

◆ enable2fa()

void iberbox::Iberbox::enable2fa ( int  code,
ActionListenerType  listener = nullptr 
)

Enables the 2FA method for the currently logged-in user.

Parameters
codeA code generated with any TOTP generator using the URL generated after calling generate2faUrl.
listenerThe listener that will handle every action event.
Returns
The listener's onActionFinish method will be provided with the finished action.
If any error occurred, the action's getError method may be used to retrieve such error.
  • E_SUCCESS is returned on success.
  • E_PARAMETERS is returned when some parameters are missing or the provided ones are not valid.
  • E_UNEXPECTED is returned when unexpected behavior occurs.
The returned action type corresponds to MANAGE_2FA.

◆ enableCrashHandler()

static void iberbox::Iberbox::enableCrashHandler ( std::function< void(std::string, std::string)>  callback)
static

Initializes the crash manager and enables the crash handler.

Parameters
callbackThe callback that will handle every crash in the app.

◆ finishRecord()

void iberbox::Iberbox::finishRecord ( ActionListenerType  listener = nullptr)

Finishes the creation of a record.

Parameters
listenerThe listener that will handle every action event.
Returns
The listener's onActionFinish method will be provided with the finished action.
If any error occurred, the action's getError method may be used to retrieve such error.
  • E_SUCCESS is returned on success.
  • E_PARAMETERS is returned when some parameters are missing or the provided ones are not valid.
  • E_UNEXPECTED is returned when unexpected behavior occurs.
Otherwise, the action's getLink method may be used to retrieve the public link to the created record.
The returned action type corresponds to LOGOUT_LINK.

◆ finishRecordWithRecipient()

void iberbox::Iberbox::finishRecordWithRecipient ( const std::string &  recipient,
ActionListenerType  listener = nullptr 
)

Finishes the creation of a record and sends its link to the recipient.

Parameters
recipientThe email address the record link will be sent to.
listenerThe listener that will handle every action event.
Returns
The listener's onActionFinish method will be provided with the finished action.
If any error occurred, the action's getError method may be used to retrieve such error.
  • E_SUCCESS is returned on success.
  • E_PARAMETERS is returned when some parameters are missing or the provided ones are not valid.
  • E_UNEXPECTED is returned when unexpected behavior occurs.
Otherwise, the action's getLink method may be used to retrieve the public link to the created record.
The returned action type corresponds to LOGOUT_LINK.

◆ forgotPassword()

void iberbox::Iberbox::forgotPassword ( const std::string &  email,
ActionListenerType  listener = nullptr 
)

Inits the process of account recovery by sending instructions to the provided email address.

Sends a pin to the provided email address and returns a recovery identifier, both needed when using the recoverAccount method.
The provided email address must correspond to a existing user and will be used to send the password recovery instructions to it.

Parameters
emailThe email address used to login into the account whose password has been forgotten.
listenerThe listener that will handle every action event.
Returns
The listener's onActionFinish method will be provided with the finished action.
If any error occurred, the action's getError method may be used to retrieve such error.
  • E_SUCCESS is returned on success.
  • E_PARAMETERS is returned when some parameters are missing or the provided ones are not valid.
  • E_UNEXPECTED is returned when unexpected behavior occurs.
  • E_DUPLICATE is returned when no user matches the email.
Otherwise, the action's getText method may be used to retrieve the recovery identifier.
The returned action type corresponds to FORGOT_PASSWORD.

◆ generate2faUrl()

void iberbox::Iberbox::generate2faUrl ( ActionListenerType  listener = nullptr)

Generates the 2FA URL for the currently logged-in user.

Reference here.

Parameters
listenerThe listener that will handle every action event.
Returns
The listener's onActionFinish method will be provided with the finished action.
If any error occurred, the action's getError method may be used to retrieve such error.
  • E_SUCCESS is returned on success.
  • E_PARAMETERS is returned when some parameters are missing or the provided ones are not valid.
  • E_UNEXPECTED is returned when unexpected behavior occurs.
Otherwise, the action's getText method may be used to retrieve the 2FA URL.
The returned action type corresponds to MANAGE_2FA.

◆ generateUpdate()

void iberbox::Iberbox::generateUpdate ( const std::string &  appName,
int  version,
const std::string &  platform,
const std::string &  updateFolder,
const std::string &  updateUrl,
const std::string &  changelog,
const std::string &  outputFile,
const std::string &  privateKey,
ActionListenerType  listener = nullptr 
)

generateUpdate

Todo:
Parameters
appName
version
platform
updateFolder
updateUrl
changelog
outputFile
privateKey
listenerThe listener that will handle every action event.
Returns
The listener's onActionFinish method will be provided with the finished action.
If any error occurred, the action's getError method may be used to retrieve such error.
  • E_SUCCESS is returned on success.
  • E_PARAMETERS is returned when some parameters are missing or the provided ones are not valid.
  • E_UNEXPECTED is returned when unexpected behavior occurs.
The returned action type corresponds to UPDATE.

◆ getAccountCoupons()

void iberbox::Iberbox::getAccountCoupons ( ActionListenerType  listener = nullptr)

Gets the coupons created by the account of the currently logged-in user.

Coupons' types are described by the CouponType enum.

Parameters
listenerThe listener that will handle every action event.
Returns
The listener's onActionFinish method will be provided with the finished action.
If any error occurred, the action's getError method may be used to retrieve such error.
  • E_SUCCESS is returned on success.
  • E_PARAMETERS is returned when some parameters are missing or the provided ones are not valid.
  • E_UNEXPECTED is returned when unexpected behavior occurs.
Otherwise, the action's getCoupons method may be used to retrieve the existing account's coupons.
The returned action type corresponds to COUPONS.

◆ getAccountInfo()

void iberbox::Iberbox::getAccountInfo ( ActionListenerType  listener = nullptr)

Gets the info of the currently logged-in user account.

Parameters
listenerThe listener that will handle every action event.
Returns
The listener's onActionFinish method will be provided with the finished action.
If any error occurred, the action's getError method may be used to retrieve such error.
  • E_SUCCESS is returned on success.
  • E_PARAMETERS is returned when some parameters are missing or the provided ones are not valid.
  • E_UNEXPECTED is returned when unexpected behavior occurs.
Otherwise, the action's getAccountInfo method may be used to retrieve the currently logged-in user account info getUserPermissions method to retrieve the list of users the account has granted access to, and the getEmail method to retrieve the owner of the account.
The returned action type corresponds to ACCOUNT_INFO.

◆ getAccountLog()

void iberbox::Iberbox::getAccountLog ( unsigned short  page = 1,
ActionListenerType  listener = nullptr 
)

Gets the account log containing special actions performed by any user in the current account.

Parameters
pageThe page of the log to retrieve. Page size is defined in the server.
listenerThe listener that will handle every action event.
Returns
The listener's onActionFinish method will be provided with the finished action.
If any error occurred, the action's getError method may be used to retrieve such error.
  • E_SUCCESS is returned on success.
  • E_PARAMETERS is returned when some parameters are missing or the provided ones are not valid.
  • E_UNEXPECTED is returned when unexpected behavior occurs.
Otherwise, the action's getLog method may be used to retrieve the array of action logs.
The returned action type corresponds to GET_COMMANDS_LOG.

◆ getActiveBackups()

void iberbox::Iberbox::getActiveBackups ( ActionListenerType  listener = nullptr)

Gets every active backup of the devices owned by the currently logged-in user.

Parameters
listenerThe listener that will handle every action event.
Returns
The listener's onActionFinish method will be provided with the finished action.
If any error occurred, the action's getError method may be used to retrieve such error.
  • E_SUCCESS is returned on success.
  • E_PARAMETERS is returned when some parameters are missing or the provided ones are not valid.
  • E_UNEXPECTED is returned when unexpected behavior occurs.
Otherwise, the action's getNodeList method may be used to retrieve the list of active backups.
The returned action type corresponds to GET_BACKUPS.

◆ getBackupById()

void iberbox::Iberbox::getBackupById ( NodeHandle  backupId,
ActionListenerType  listener = nullptr 
)

Gets the backup identified by backupId.

The requested backup is uniquely identified by its node handle and must be equal to backupId.

Parameters
backupIdThe handle of the node that uniquely identifies the requested backup.
listenerThe listener that will handle every action event.
Returns
The listener's onActionFinish method will be provided with the finished action.
If any error occurred, the action's getError method may be used to retrieve such error.
  • E_SUCCESS is returned on success.
  • E_PARAMETERS is returned when some parameters are missing or the provided ones are not valid.
  • E_UNEXPECTED is returned when unexpected behavior occurs.
Otherwise, the action's getNode method may be used to retrieve the requested backup.
The returned action type corresponds to GET_BACKUP.

◆ getBackupByName()

void iberbox::Iberbox::getBackupByName ( NodeHandle  deviceId,
const std::string &  name,
ActionListenerType  listener = nullptr 
)

Gets the backup identified by name of a device owned by the currently logged-in user whose node handle is deviceId.

The requested backup is uniquely identified by its name in the requested device, which is likewise uniquely identified by its node handle and must be equal to deviceId.

Parameters
deviceIdThe handle of the node that uniquely identifies the requested device.
nameThe name that uniquely identifies the requested backup.
listenerThe listener that will handle every action event.
Returns
The listener's onActionFinish method will be provided with the finished action.
If any error occurred, the action's getError method may be used to retrieve such error.
  • E_SUCCESS is returned on success.
  • E_PARAMETERS is returned when some parameters are missing or the provided ones are not valid.
  • E_UNEXPECTED is returned when unexpected behavior occurs.
Otherwise, the action's getNode method may be used to retrieve the requested backup.
The returned action type corresponds to GET_BACKUP.

◆ getBackups()

void iberbox::Iberbox::getBackups ( NodeHandle  deviceId,
ActionListenerType  listener = nullptr 
)

Gets every backup of a specific device identified by deviceId.

Parameters
deviceIdThe handle of the node that uniquely identifies the requested device.
listenerThe listener that will handle every action event.
Returns
The listener's onActionFinish method will be provided with the finished action.
If any error occurred, the action's getError method may be used to retrieve such error.
  • E_SUCCESS is returned on success.
  • E_PARAMETERS is returned when some parameters are missing or the provided ones are not valid.
  • E_UNEXPECTED is returned when unexpected behavior occurs.
Otherwise, the action's getNodeList method may be used to retrieve the list of devices.
The returned action type corresponds to GET_BACKUPS.

◆ getBalancesInfo()

void iberbox::Iberbox::getBalancesInfo ( ActionListenerType  listener = nullptr)

Gets the balances information of the account of the currently logged-in user.

Balances information includes the total balance and details of every balance operation.

Parameters
listenerThe listener that will handle every action event.
Returns
The listener's onActionFinish method will be provided with the finished action.
If any error occurred, the action's getError method may be used to retrieve such error.
  • E_SUCCESS is returned on success.
  • E_PARAMETERS is returned when some parameters are missing or the provided ones are not valid.
  • E_UNEXPECTED is returned when unexpected behavior occurs.
Otherwise, the action's getBalancesInfo method may be used to retrieve the balances information.
The returned action type corresponds to BALANCES_INFO.

◆ getChildFiles()

void iberbox::Iberbox::getChildFiles ( NodeHandle  id,
ActionListenerType  listener = nullptr 
)

Gets every direct descendant file of a specified node using default sort order.

Parameters
idThe handle of the node whose children will be returned.
listenerThe listener that will handle every action event.
Returns
The listener's onActionFinish method will be provided with the finished action.
If any error occurred, the action's getError method may be used to retrieve such error.
  • E_SUCCESS is returned on success.
  • E_PARAMETERS is returned when some parameters are missing or the provided ones are not valid.
  • E_UNEXPECTED is returned when unexpected behavior occurs.
Otherwise, the action's getNodeList method may be used to retrieve the list of children nodes.

◆ getChildFolders()

void iberbox::Iberbox::getChildFolders ( NodeHandle  id,
ActionListenerType  listener = nullptr 
)

Gets every direct descendant folder of a specified node using default sort order.

Parameters
idThe handle of the node whose children will be returned.
listenerThe listener that will handle every action event.
Returns
The listener's onActionFinish method will be provided with the finished action.
If any error occurred, the action's getError method may be used to retrieve such error.
  • E_SUCCESS is returned on success.
  • E_PARAMETERS is returned when some parameters are missing or the provided ones are not valid.
  • E_UNEXPECTED is returned when unexpected behavior occurs.
Otherwise, the action's getNodeList method may be used to retrieve the list of children nodes.

◆ getChildren()

void iberbox::Iberbox::getChildren ( NodeHandle  id,
ActionListenerType  listener = nullptr 
)

Gets every direct descendant of a specified node using default sort order.

Parameters
idThe handle of the node whose children will be returned.
listenerThe listener that will handle every action event.
Returns
The listener's onActionFinish method will be provided with the finished action.
If any error occurred, the action's getError method may be used to retrieve such error.
  • E_SUCCESS is returned on success.
  • E_PARAMETERS is returned when some parameters are missing or the provided ones are not valid.
  • E_UNEXPECTED is returned when unexpected behavior occurs.
Otherwise, the action's getNodeList method may be used to retrieve the list of children nodes.

◆ getCouponInfo()

void iberbox::Iberbox::getCouponInfo ( const std::string &  coupon,
ActionListenerType  listener = nullptr 
)

Gets the information of a given coupon.

Parameters
coupon
listenerThe listener that will handle every action event.
Returns
The listener's onActionFinish method will be provided with the finished action.
If any error occurred, the action's getError method may be used to retrieve such error.
  • E_SUCCESS is returned on success.
  • E_PARAMETERS is returned when some parameters are missing or the provided ones are not valid.
  • E_UNEXPECTED is returned when unexpected behavior occurs.
Otherwise, the action's getStatus method may be used to retrieve the coupon's type
(CouponInfoData::DISCOUNT or CouponInfoData::RESELLER), and the action's getIntValue
method may be used to retrieve the coupon's discount (for discount coupons) or the associated plan (for reseller coupons).
The returned action type corresponds to COUPONS.

◆ getCurrentDevice()

void iberbox::Iberbox::getCurrentDevice ( ActionListenerType  listener = nullptr)

Gets the current device from which the desktop app has been launched.

Parameters
listenerThe listener that will handle every action event.
Returns
The listener's onActionFinish method will be provided with the finished action.
If any error occurred, the action's getError method may be used to retrieve such error.
  • E_SUCCESS is returned on success.
  • E_PARAMETERS is returned when some parameters are missing or the provided ones are not valid.
  • E_UNEXPECTED is returned when unexpected behavior occurs.
Otherwise, the action's getNode method may be used to retrieve the current device.
The returned action type corresponds to GET_CURRENT_DEVICE.

◆ getDeviceById()

void iberbox::Iberbox::getDeviceById ( NodeHandle  deviceId,
ActionListenerType  listener = nullptr 
)

Gets the requested device.

The requested device is uniquely identified by its deviceId.

Parameters
deviceIdThe handle of the node that uniquely identifies the requested device.
listenerThe listener that will handle every action event.
Returns
The listener's onActionFinish method will be provided with the finished action.
If any error occurred, the action's getError method may be used to retrieve such error.
  • E_SUCCESS is returned on success.
  • E_PARAMETERS is returned when some parameters are missing or the provided ones are not valid.
  • E_UNEXPECTED is returned when unexpected behavior occurs.
Otherwise, the action's getNode method may be used to retrieve the requested device.
The returned action type corresponds to GET_DEVICE.

◆ getDeviceByName()

void iberbox::Iberbox::getDeviceByName ( const std::string &  name,
ActionListenerType  listener = nullptr 
)

Gets the requested device owned by the currently logged-in user.

The requested device is uniquely identified by its name.

Parameters
nameThe unique name that identifies the requested device owned by the currently logged-in user.
listenerThe listener that will handle every action event.
Returns
The listener's onActionFinish method will be provided with the finished action.
If any error occurred, the action's getError method may be used to retrieve such error.
  • E_SUCCESS is returned on success.
  • E_PARAMETERS is returned when some parameters are missing or the provided ones are not valid.
  • E_UNEXPECTED is returned when unexpected behavior occurs.
Otherwise, the action's getNode method may be used to retrieve the requested device.
The returned action type corresponds to GET_DEVICE.

◆ getDevices()

void iberbox::Iberbox::getDevices ( ActionListenerType  listener = nullptr)

Gets every device owned by the currently logged-in user.

Parameters
listenerThe listener that will handle every action event.
Returns
The listener's onActionFinish method will be provided with the finished action.
If any error occurred, the action's getError method may be used to retrieve such error.
  • E_SUCCESS is returned on success.
  • E_PARAMETERS is returned when some parameters are missing or the provided ones are not valid.
  • E_UNEXPECTED is returned when unexpected behavior occurs.
Otherwise, the action's getNodeList method may be used to retrieve the list of devices.
The returned action type corresponds to GET_DEVICES.

◆ getDownloadSpeedLimit()

void iberbox::Iberbox::getDownloadSpeedLimit ( ActionListenerType  listener = nullptr)

Gets the download speed limit using kbps unit.

Parameters
listenerThe listener that will handle every action event.
Returns
The listener's onActionFinish method will be provided with the finished action.
If any error occurred, the action's getError method may be used to retrieve such error.
  • E_SUCCESS is returned on success.
  • E_PARAMETERS is returned when some parameters are missing or the provided ones are not valid.
  • E_UNEXPECTED is returned when unexpected behavior occurs.
Otherwise, the action's getIntValue method may be used to retrieve the download speed limit value.
The returned action type corresponds to GET_TRANSFER_SPEED_LIMIT.

◆ getExternalInbox()

void iberbox::Iberbox::getExternalInbox ( ActionListenerType  listener = nullptr)

Get an external inbox to send records to users without an Iberbox account.

Parameters
listenerThe listener that will handle every action event.
Returns
The listener's onActionFinish method will be provided with the finished action.
If any error occurred, the action's getError method may be used to retrieve such error.
  • E_SUCCESS is returned on success.
  • E_PARAMETERS is returned when some parameters are missing or the provided ones are not valid.
  • E_UNEXPECTED is returned when unexpected behavior occurs.
Otherwise, the action's getLink method may be used to retrieve the inbox link.
The returned action type corresponds to CREATE_LINK.

◆ getInboxInfo()

void iberbox::Iberbox::getInboxInfo ( const std::string &  inboxLink,
ActionListenerType  listener = nullptr 
)

Gets the information related to a given inbox by its public link.

Parameters
inboxLinkThe public link pointing to a specific inbox.
listenerThe listener that will handle every action event.
Returns
The listener's onActionFinish method will be provided with the finished action.
If any error occurred, the action's getError method may be used to retrieve such error.
  • E_SUCCESS is returned on success.
  • E_PARAMETERS is returned when some parameters are missing or the provided ones are not valid.
  • E_UNEXPECTED is returned when unexpected behavior occurs.
Otherwise, the action's getName method may be used to retrieve the name of the receiver of the inbox records and getNode method to retrieve the node representing the inbox.
The returned action type corresponds to GET_INBOX_INFO.

◆ getInvoicingInfo()

void iberbox::Iberbox::getInvoicingInfo ( ActionListenerType  listener = nullptr)

Gets the invoicing information of the currently logged-in user.

Parameters
listenerThe listener that will handle every action event.
Returns
The listener's onActionFinish method will be provided with the finished action.
If any error occurred, the action's getError method may be used to retrieve such error.
  • E_SUCCESS is returned on success.
  • E_PARAMETERS is returned when some parameters are missing or the provided ones are not valid.
  • E_UNEXPECTED is returned when unexpected behavior occurs.
Otherwise, the action's getInvoicingInfo method may be used to retrieve the invoicing info.
The returned action type corresponds to INVOICING_INFO.

◆ getLastSnapshots()

void iberbox::Iberbox::getLastSnapshots ( ActionListenerType  listener = nullptr)

Gets the last created snapshots of every backup in the current device.

Parameters
listenerThe listener that will handle every action event.
Returns
The listener's onActionFinish method will be provided with the finished action.
If any error occurred, the action's getError method may be used to retrieve such error.
  • E_SUCCESS is returned on success.
  • E_PARAMETERS is returned when some parameters are missing or the provided ones are not valid.
  • E_UNEXPECTED is returned when unexpected behavior occurs.
Otherwise, the action's getNodeList method may be used to retrieve the node list representing the snapshots.
The returned action type corresponds to GET_LAST_SNAPSHOTS.

◆ getLastSnapshotsForAccount()

void iberbox::Iberbox::getLastSnapshotsForAccount ( ActionListenerType  listener = nullptr)

Gets the last created snapshots for the account of the currently logged-in user.

Parameters
listenerThe listener that will handle every action event.
Returns
The listener's onActionFinish method will be provided with the finished action.
If any error occurred, the action's getError method may be used to retrieve such error.
  • E_SUCCESS is returned on success.
  • E_PARAMETERS is returned when some parameters are missing or the provided ones are not valid.
  • E_UNEXPECTED is returned when unexpected behavior occurs.
Otherwise, the action's getNodeList method may be used to retrieve the node list representing the snapshots and getNumberList to retrieve the timestamp list for each snapshot.
The returned action type corresponds to GET_LAST_SNAPSHOTS_BY_ACCOUNT.

◆ getLastSnapshotsForBackup()

void iberbox::Iberbox::getLastSnapshotsForBackup ( NodeHandle  backupId,
int  count,
ActionListenerType  listener = nullptr 
)

Gets the n (count) latest created snapshots of a given backup.

Parameters
backupIdThe handle of the node representing a backup.
countThe amount of snapshots to be returned.
listenerThe listener that will handle every action event.
Returns
The listener's onActionFinish method will be provided with the finished action.
If any error occurred, the action's getError method may be used to retrieve such error.
  • E_SUCCESS is returned on success.
  • E_PARAMETERS is returned when some parameters are missing or the provided ones are not valid.
  • E_UNEXPECTED is returned when unexpected behavior occurs.
Otherwise, the action's getNodeList method may be used to retrieve the node list representing the snapshots and getNumberList to retrieve the timestamp list for each snapshot.
The returned action type corresponds to GET_LAST_SNAPSHOTS_BY_BACKUP.

◆ getLastSnapshotsForDevice()

void iberbox::Iberbox::getLastSnapshotsForDevice ( NodeHandle  deviceId,
ActionListenerType  listener = nullptr 
)

Gets the last created snapshots of every backup in the specified device.

Parameters
deviceId
listenerThe listener that will handle every action event.
Returns
The listener's onActionFinish method will be provided with the finished action.
If any error occurred, the action's getError method may be used to retrieve such error.
  • E_SUCCESS is returned on success.
  • E_PARAMETERS is returned when some parameters are missing or the provided ones are not valid.
  • E_UNEXPECTED is returned when unexpected behavior occurs.
Otherwise, the action's getNodeList method may be used to retrieve the node list representing the snapshots and getNumberList to retrieve the timestamp list for each snapshot.
The returned action type corresponds to GET_LAST_SNAPSHOTS_BY_DEVICE.

◆ getLinkInfo()

void iberbox::Iberbox::getLinkInfo ( const std::string &  link,
ActionListenerType  listener = nullptr 
)

Gets the node which the link points to.

Parameters
linkThe link whose info is requested.
listenerThe listener that will handle every action event.
Returns
The listener's onActionFinish method will be provided with the finished action.
If any error occurred, the action's getError method may be used to retrieve such error.
  • E_SUCCESS is returned on success.
  • E_PARAMETERS is returned when some parameters are missing or the provided ones are not valid.
  • E_UNEXPECTED is returned when unexpected behavior occurs.
Otherwise, the action's getNode method may be used to retrieve the node for which the link points to and getName method to retrieve such node's name.
The returned action type corresponds to GET_LINK_INFO.

◆ getLogLevel()

static int iberbox::Iberbox::getLogLevel ( )
static

Get the active log level Possible log levels are specified by the LogLevelType enum:

  • LOG_LEVEL_TRACE = 0,
  • LOG_LEVEL_DEBUG = 1,
  • LOG_LEVEL_INFO = 2,
  • LOG_LEVEL_WARN = 3,
  • LOG_LEVEL_ERROR = 4,
  • LOG_LEVEL_CRITICAL = 5,
  • LOG_LEVEL_OFF = 6
    Returns
    Active log level

◆ getMeetingAccess()

void iberbox::Iberbox::getMeetingAccess ( NodeHandle  sharedDrive,
ActionListenerType  listener = nullptr 
)

Gets the credentials for the current account to access to a meeting given a shared drive.

Parameters
sharedDriveThe handle of the shared drive that will handle the meeting.
listenerThe listener that will handle every action event.
Returns
The listener's onActionFinish method will be provided with the finished action.
If any error occurred, the action's getError method may be used to retrieve such error.
  • E_SUCCESS is returned on success.
  • E_PARAMETERS is returned when some parameters are missing or the provided ones are not valid.
  • E_UNEXPECTED is returned when unexpected behavior occurs.
Otherwise, the action's getSession method may be used to retrieve the access token and the action's getText method to retrieve the room name of the meeting.
The returned action type corresponds to MANAGE_MEETINGS.

◆ getNextSnapshots()

void iberbox::Iberbox::getNextSnapshots ( ActionListenerType  listener = nullptr)

Gets next scheduled snapshots of every backup in the current device.

Parameters
listenerThe listener that will handle every action event.
Returns
The listener's onActionFinish method will be provided with the finished action.
If any error occurred, the action's getError method may be used to retrieve such error.
  • E_SUCCESS is returned on success.
  • E_PARAMETERS is returned when some parameters are missing or the provided ones are not valid.
  • E_UNEXPECTED is returned when unexpected behavior occurs.
Otherwise, the action's getNodeList method may be used to retrieve the node list representing the snapshots and getNumberList to retrieve the timestamp list for each snapshot.
The returned action type corresponds to GET_NEXT_SNAPSHOTS_BY_DEVICE.

◆ getNextSnapshotsForAccount()

void iberbox::Iberbox::getNextSnapshotsForAccount ( ActionListenerType  listener = nullptr)

Gets the next scheduled snapshots of every backup in the account of the currently logged-in user.

Parameters
listenerThe listener that will handle every action event.
Returns
The listener's onActionFinish method will be provided with the finished action.
If any error occurred, the action's getError method may be used to retrieve such error.
  • E_SUCCESS is returned on success.
  • E_PARAMETERS is returned when some parameters are missing or the provided ones are not valid.
  • E_UNEXPECTED is returned when unexpected behavior occurs.
Otherwise, the action's getNodeList method may be used to retrieve the node list representing the snapshots and getNumberList to retrieve the timestamp list for each snapshot.
The returned action type corresponds to GET_NEXT_SNAPSHOTS_BY_SCHEDULE.

◆ getNextSnapshotsForBackup()

void iberbox::Iberbox::getNextSnapshotsForBackup ( NodeHandle  backupId,
int  count,
ActionListenerType  listener = nullptr 
)

Gets n (count) next scheduled snapshots for a given backup.

Parameters
backupIdThe handle of the node representing a backup.
countThe amount of snapshots to be returned.
listenerThe listener that will handle every action event.
Returns
The listener's onActionFinish method will be provided with the finished action.
If any error occurred, the action's getError method may be used to retrieve such error.
  • E_SUCCESS is returned on success.
  • E_PARAMETERS is returned when some parameters are missing or the provided ones are not valid.
  • E_UNEXPECTED is returned when unexpected behavior occurs.
Otherwise, the action's getNodeList method may be used to retrieve the node list representing the snapshots and getNumberList to retrieve the timestamp list for each snapshot.
The returned action type corresponds to GET_NEXT_SNAPSHOTS_BY_ACCOUNT.

◆ getNextSnapshotsForDevice()

void iberbox::Iberbox::getNextSnapshotsForDevice ( NodeHandle  deviceId,
ActionListenerType  listener = nullptr 
)

Gets next scheduled snapshots of every backup in a given device.

Parameters
deviceIdThe handle of the node representing a device.
listenerThe listener that will handle every action event.
Returns
The listener's onActionFinish method will be provided with the finished action.
If any error occurred, the action's getError method may be used to retrieve such error.
  • E_SUCCESS is returned on success.
  • E_PARAMETERS is returned when some parameters are missing or the provided ones are not valid.
  • E_UNEXPECTED is returned when unexpected behavior occurs.
Otherwise, the action's getNodeList method may be used to retrieve the node list representing the snapshots and getNumberList to retrieve the timestamp list for each snapshot.
The returned action type corresponds to GET_NEXT_SNAPSHOTS_BY_BACKUP.

◆ getNextSnapshotsForSchedule()

void iberbox::Iberbox::getNextSnapshotsForSchedule ( unsigned long  startTime,
const std::string  cronExpr,
int  count,
ActionListenerType  listener = nullptr 
)

Gets a specified number of timestamps when the snapshots would be carried out given a start time and a cron expression.

cronExpr must follow the following format:

.--------------- minute (0-59)
|  .------------ hour (0-23)
|  |  .--------- day of the month (1-31)
|  |  |  .------ month (1-12) or jan,feb,mar,apr,may,jun,jul...
|  |  |  |  .--- day of the week (0-6) (sunday=0 or 7) or sun,mon,tue,wed,thu,fri,sat
|  |  |  |  |
*  *  *  *  *
Parameters
startTimeThe time from where to start taking the cron expression into consideration.
cronExprThe cron expression for scheduling snapshots.
countThe amount of timestamps to be returned.
listenerThe listener that will handle every action event.
Returns
The listener's onActionFinish method will be provided with the finished action.
If any error occurred, the action's getError method may be used to retrieve such error.
  • E_SUCCESS is returned on success.
  • E_PARAMETERS is returned when some parameters are missing or the provided ones are not valid.
  • E_UNEXPECTED is returned when unexpected behavior occurs.
Otherwise, the action's getNumberList method may be used to retrieve the list of possible future snapshots as timestamps according to the specified conditions.
The returned action type corresponds to GET_SNAPSHOTS.

◆ getNodeById()

void iberbox::Iberbox::getNodeById ( NodeHandle  id,
ActionListenerType  listener = nullptr 
)

Gets a node given its node handle.

Parameters
idThe handle of the requested node.
listenerThe listener that will handle every action event.
Returns
The listener's onActionFinish method will be provided with the finished action.
If any error occurred, the action's getError method may be used to retrieve such error.
  • E_SUCCESS is returned on success.
  • E_PARAMETERS is returned when some parameters are missing or the provided ones are not valid.
  • E_UNEXPECTED is returned when unexpected behavior occurs.
Otherwise, the action's getNode method may be used to retrieve the requested node.
The returned action type corresponds to GET_NODE.

◆ getNodeByPath()

void iberbox::Iberbox::getNodeByPath ( const std::string &  path,
ActionListenerType  listener = nullptr 
)

Gets a node given its path.

Parameters
pathThe path of the requested node.
listenerThe listener that will handle every action event.
Returns
The listener's onActionFinish method will be provided with the finished action.
If any error occurred, the action's getError method may be used to retrieve such error.
  • E_SUCCESS is returned on success.
  • E_PARAMETERS is returned when some parameters are missing or the provided ones are not valid.
  • E_UNEXPECTED is returned when unexpected behavior occurs.
Otherwise, the action's getNode method may be used to retrieve the requested node.
The returned action type corresponds to GET_NODE.

◆ getNodePath()

void iberbox::Iberbox::getNodePath ( NodeHandle  id,
ActionListenerType  listener = nullptr 
)

Gets the path of a given node.

Parameters
idThe handle of the node whose path will be returned.
listenerThe listener that will handle every action event.
Returns
The listener's onActionFinish method will be provided with the finished action.
If any error occurred, the action's getError method may be used to retrieve such error.
  • E_SUCCESS is returned on success.
  • E_PARAMETERS is returned when some parameters are missing or the provided ones are not valid.
  • E_UNEXPECTED is returned when unexpected behavior occurs.
Otherwise, the action's getText method may be used to retrieve the path of the given node.
The returned action type corresponds to GET_PATH.

◆ getNodes()

void iberbox::Iberbox::getNodes ( ActionListenerType  listener = nullptr)

Get the cloud root node.

Parameters
listenerThe listener that will handle every action event.
Returns
The listener's onActionFinish method will be provided with the finished action.
If any error occurred, the action's getError method may be used to retrieve such error.
  • E_SUCCESS is returned on success.
  • E_PARAMETERS is returned when some parameters are missing or the provided ones are not valid.
  • E_UNEXPECTED is returned when unexpected behavior occurs.
Otherwise, the action's getNode method may be used to retrieve the cloud root node.
The returned action type corresponds to GET_NODES.

◆ getNoticeCredentials()

void iberbox::Iberbox::getNoticeCredentials ( ActionListenerType  listener = nullptr)

Gets the email account credentials in order to send notices.

Parameters
listenerThe listener that will handle every action event.
Returns
The listener's onActionFinish method will be provided with the finished action.
If any error occurred, the action's getError method may be used to retrieve such error.
  • E_SUCCESS is returned on success.
  • E_PARAMETERS is returned when some parameters are missing or the provided ones are not valid.
  • E_UNEXPECTED is returned when unexpected behavior occurs.
Otherwise, the action's getPassword method may be used to retrieve the email account password.
The returned action type corresponds to NOTICE_CREDENTIALS.

◆ getOpenSecrets()

void iberbox::Iberbox::getOpenSecrets ( ActionListenerType  listener = nullptr)

Gets every open secret space within the account of the currently logged-in user.

Parameters
listenerThe listener that will handle every action event.
Returns
The listener's onActionFinish method will be provided with the finished action.
If any error occurred, the action's getError method may be used to retrieve such error.
  • E_SUCCESS is returned on success.
  • E_PARAMETERS is returned when some parameters are missing or the provided ones are not valid.
  • E_UNEXPECTED is returned when unexpected behavior occurs.
Otherwise, the action's getNodeList method may be used to retrieve the open secret nodes.
The returned action type corresponds to MANAGE_SECRETS.

◆ getPaymentInfo()

void iberbox::Iberbox::getPaymentInfo ( int  subscriptionId,
ActionListenerType  listener = nullptr 
)

Gets the information related to the payment of a given subscription.

Parameters
subscriptionIdThe identifier of the subscription.
listenerThe listener that will handle every action event.
Returns
The listener's onActionFinish method will be provided with the finished action.
If any error occurred, the action's getError method may be used to retrieve such error.
  • E_SUCCESS is returned on success.
  • E_PARAMETERS is returned when some parameters are missing or the provided ones are not valid.
  • E_UNEXPECTED is returned when unexpected behavior occurs.
Otherwise, the action's getPaymentInfo method may be used to retrieve the payment information.
The returned action type corresponds to PAYMENT_INFO.

◆ getPublicAccountInfo()

void iberbox::Iberbox::getPublicAccountInfo ( AccountHandle  account,
ActionListenerType  listener = nullptr 
)

Gets the public info of an account given its handle.

Parameters
accountAccount handle
listenerThe listener that will handle every action event.
Returns
The listener's onActionFinish method will be provided with the finished action.
If any error occurred, the action's getError method may be used to retrieve such error.
  • E_SUCCESS is returned on success.
  • E_PARAMETERS is returned when some parameters are missing or the provided ones are not valid.
  • E_UNEXPECTED is returned when unexpected behavior occurs.
Otherwise, the action's getName method may be used to retrieve the name of the owner of the account The returned action type corresponds to ACCOUNT_INFO.

◆ getPublicAccountInfoByLink()

void iberbox::Iberbox::getPublicAccountInfoByLink ( const std::string &  link,
ActionListenerType  listener = nullptr 
)

Gets the public info of the account associated to an account link.

Parameters
linkAccount link
listenerThe listener that will handle every action event.
Returns
The listener's onActionFinish method will be provided with the finished action.
If any error occurred, the action's getError method may be used to retrieve such error.
  • E_SUCCESS is returned on success.
  • E_PARAMETERS is returned when some parameters are missing or the provided ones are not valid.
  • E_UNEXPECTED is returned when unexpected behavior occurs.
Otherwise, the action's getName method may be used to retrieve the name of the owner of the account The returned action type corresponds to ACCOUNT_INFO.

◆ getPublicUserInfo()

void iberbox::Iberbox::getPublicUserInfo ( UserHandle  user,
ActionListenerType  listener = nullptr 
)

Gets the public info of a user given its handle.

Parameters
useruser handle
listenerThe listener that will handle every action event.
Returns
The listener's onActionFinish method will be provided with the finished action.
If any error occurred, the action's getError method may be used to retrieve such error.
  • E_SUCCESS is returned on success.
  • E_PARAMETERS is returned when some parameters are missing or the provided ones are not valid.
  • E_UNEXPECTED is returned when unexpected behavior occurs.
Otherwise, the action's getEmail method may be used to retrieve the email of the user. The returned action type corresponds to USER_INFO.

◆ getRecordInfo()

void iberbox::Iberbox::getRecordInfo ( const std::string &  recordLink,
ActionListenerType  listener = nullptr 
)

Gets the information of a record given its public link.

Parameters
recordLink
listenerThe listener that will handle every action event.
Returns
The listener's onActionFinish method will be provided with the finished action.
If any error occurred, the action's getError method may be used to retrieve such error.
  • E_SUCCESS is returned on success.
  • E_PARAMETERS is returned when some parameters are missing or the provided ones are not valid.
  • E_UNEXPECTED is returned when unexpected behavior occurs.
Otherwise, the action's getNode method may be used to retrieve the node representing the record and getNodeList method to retrieve the uploaded files in the record.
The returned action type corresponds to GET_RECORD_INFO.

◆ getRecoveryKey()

void iberbox::Iberbox::getRecoveryKey ( ActionListenerType  listener = nullptr)

Gets the recovery key of the currently logged-in user.

Parameters
listenerThe listener that will handle every action event.
Returns
The listener's onActionFinish method will be provided with the finished action.
If any error occurred, the action's getError method may be used to retrieve such error.
  • E_SUCCESS is returned on success.
  • E_PARAMETERS is returned when some parameters are missing or the provided ones are not valid.
  • E_UNEXPECTED is returned when unexpected behavior occurs.
Otherwise, the action's getText method may be used to retrieve the recovery key.
The returned action type corresponds to RECOVERY_KEY.

◆ getReferralsInfo()

void iberbox::Iberbox::getReferralsInfo ( ActionListenerType  listener = nullptr)

Gets the referrals information of the account of the currently logged-in user.

Referrals information includes the email of the new referred account and its creation time.

Parameters
listenerThe listener that will handle every action event.
Returns
The listener's onActionFinish method will be provided with the finished action.
If any error occurred, the action's getError method may be used to retrieve such error.
  • E_SUCCESS is returned on success.
  • E_PARAMETERS is returned when some parameters are missing or the provided ones are not valid.
  • E_UNEXPECTED is returned when unexpected behavior occurs.
Otherwise, the action's getNumberList method may be used to retrieve the referrals' creation time list and the getStringList method to retrieve the referrals' email list.
The returned action type corresponds to REFERRALS_INFO.

◆ getRootNode()

void iberbox::Iberbox::getRootNode ( int  type,
ActionListenerType  listener = nullptr 
)

Gets the root node in the filesystem that matches the given type.

Root nodes are those that have:

◆ getRootNodes()

void iberbox::Iberbox::getRootNodes ( ActionListenerType  listener = nullptr)

Gets every root node in the filesystem.

Root nodes are those that have:

◆ getSecretRecoveryKey()

void iberbox::Iberbox::getSecretRecoveryKey ( NodeHandle  secretHandle,
ActionListenerType  listener = nullptr 
)

Gets the recovery key for a secret space given its handle.

The secret space identified by secretHandle must have been opened previously.

Parameters
secretHandleThe handle of the secret space whose recovery key is being returned.
listenerThe listener that will handle every action event.
Returns
The listener's onActionFinish method will be provided with the finished action.
If any error occurred, the action's getError method may be used to retrieve such error.
  • E_SUCCESS is returned on success.
  • E_PARAMETERS is returned when some parameters are missing or the provided ones are not valid.
  • E_UNEXPECTED is returned when unexpected behavior occurs.
Otherwise, the action's getText method may be used to retrieve the recovery key of the secret space.
The returned action type corresponds to MANAGE_SECRETS.

◆ getSessionInfo()

void iberbox::Iberbox::getSessionInfo ( ActionListenerType  listener = nullptr)

Gets the information of the active and inactive sessions.

Parameters
listenerThe listener that will handle every action event.
Returns
The listener's onActionFinish method will be provided with the finished action.
If any error occurred, the action's getError method may be used to retrieve such error.
  • E_SUCCESS is returned on success.
  • E_PARAMETERS is returned when some parameters are missing or the provided ones are not valid.
  • E_UNEXPECTED is returned when unexpected behavior occurs.
Otherwise, the action's getActiveSessions method may be used to retrieve the active sessions, getInactiveSessions method to retrieve the inactive sessions and getNodeId method to retrieve the identifier of the node representing the current session.
The returned action type corresponds to SESSION_INFO.

◆ getSharedDriveInfo()

void iberbox::Iberbox::getSharedDriveInfo ( NodeHandle  sharedDrive,
ActionListenerType  listener = nullptr 
)

Gets information of a specific shared node given its handle.

Parameters
sharedDrive
listenerThe listener that will handle every action event.
Returns
The listener's onActionFinish method will be provided with the finished action.
If any error occurred, the action's getError method may be used to retrieve such error.
  • E_SUCCESS is returned on success.
  • E_PARAMETERS is returned when some parameters are missing or the provided ones are not valid.
  • E_UNEXPECTED is returned when unexpected behavior occurs.
The returned action type corresponds to MANAGE_SHARED_DRIVES.

◆ getSharedDrives()

void iberbox::Iberbox::getSharedDrives ( ActionListenerType  listener = nullptr)

Gets every shared drive within the account of the currently logged-in user.

Parameters
listenerThe listener that will handle every action event.
Returns
The listener's onActionFinish method will be provided with the finished action.
If any error occurred, the action's getError method may be used to retrieve such error.
  • E_SUCCESS is returned on success.
  • E_PARAMETERS is returned when some parameters are missing or the provided ones are not valid.
  • E_UNEXPECTED is returned when unexpected behavior occurs.
Otherwise, the action's getNodeList method may be used to retrieve the shared drive nodes.
The returned action type corresponds to MANAGE_SHARED_DRIVES.

◆ getSnapshots()

void iberbox::Iberbox::getSnapshots ( NodeHandle  backupId,
ActionListenerType  listener = nullptr 
)

Gets every snapshot of a given backup.

Parameters
backupIdThe handle of the node representing the backup whose snapshots will be returned.
listenerThe listener that will handle every action event.
Returns
The listener's onActionFinish method will be provided with the finished action.
If any error occurred, the action's getError method may be used to retrieve such error.
  • E_SUCCESS is returned on success.
  • E_PARAMETERS is returned when some parameters are missing or the provided ones are not valid.
  • E_UNEXPECTED is returned when unexpected behavior occurs.
Otherwise, the action's getNodeList method may be used to retrieve the node list representing the snapshots.
The returned action type corresponds to GET_NEXT_SNAPSHOTS.

◆ getSortedChildFiles()

void iberbox::Iberbox::getSortedChildFiles ( NodeHandle  id,
int  sortOrder = SORT_ORDER_DEFAULT,
ActionListenerType  listener = nullptr 
)

Gets every direct descendant file of a specified node using a specified sort order.

Parameters
idThe handle of the node whose children will be returned.
sortOrderThe order in which the returned node list will be sorted.
listenerThe listener that will handle every action event.
Returns
The listener's onActionFinish method will be provided with the finished action.
If any error occurred, the action's getError method may be used to retrieve such error.
  • E_SUCCESS is returned on success.
  • E_PARAMETERS is returned when some parameters are missing or the provided ones are not valid.
  • E_UNEXPECTED is returned when unexpected behavior occurs.
Otherwise, the action's getNodeList method may be used to retrieve the list of children nodes.
The returned action type corresponds to GET_CHILDREN.

◆ getSortedChildFolders()

void iberbox::Iberbox::getSortedChildFolders ( NodeHandle  id,
int  sortOrder = SORT_ORDER_DEFAULT,
ActionListenerType  listener = nullptr 
)

Gets every direct descendant folder of a specified node using a specified sort order.

Parameters
idThe handle of the node whose children will be returned.
sortOrderThe order in which the returned node list will be sorted.
listenerThe listener that will handle every action event.
Returns
The listener's onActionFinish method will be provided with the finished action.
If any error occurred, the action's getError method may be used to retrieve such error.
  • E_SUCCESS is returned on success.
  • E_PARAMETERS is returned when some parameters are missing or the provided ones are not valid.
  • E_UNEXPECTED is returned when unexpected behavior occurs.
Otherwise, the action's getNodeList method may be used to retrieve the list of children nodes.
The returned action type corresponds to GET_CHILDREN.

◆ getSortedChildren()

void iberbox::Iberbox::getSortedChildren ( NodeHandle  id,
int  sortOrder = SORT_ORDER_DEFAULT,
ActionListenerType  listener = nullptr 
)

Gets every direct descendant of a specified node using a specified sort order.

Parameters
idThe handle of the node whose children will be returned.
sortOrderThe order in which the returned node list will be sorted.
listenerThe listener that will handle every action event.
Returns
The listener's onActionFinish method will be provided with the finished action.
If any error occurred, the action's getError method may be used to retrieve such error.
  • E_SUCCESS is returned on success.
  • E_PARAMETERS is returned when some parameters are missing or the provided ones are not valid.
  • E_UNEXPECTED is returned when unexpected behavior occurs.
Otherwise, the action's getNodeList method may be used to retrieve the list of children nodes.
The returned action type corresponds to GET_CHILDREN.

◆ getSubscriptionOptions()

void iberbox::Iberbox::getSubscriptionOptions ( ActionListenerType  listener = nullptr)

Gets the list of subscription options and its information.

The returned list contains every available subscription option with their unique identifier when there is no logged-in user. Otherwise, the subscription option the user has previously selected will have 0 as its identifier while the others keep their identifier. This function only returns subscription options that allows to use all features.

Parameters
listenerThe listener that will handle every action event.
Returns
The listener's onActionFinish method will be provided with the finished action.
If any error occurred, the action's getError method may be used to retrieve such error.
  • E_SUCCESS is returned on success.
  • E_PARAMETERS is returned when some parameters are missing or the provided ones are not valid.
  • E_UNEXPECTED is returned when unexpected behavior occurs.
Otherwise, the action's getSubscriptionInfoList method may be used to retrieve the subscriptions options.
The returned action type corresponds to SUBSCRIPTION_OPTIONS.

◆ getSubscriptionOptionsWithFeatures()

void iberbox::Iberbox::getSubscriptionOptionsWithFeatures ( int  features,
ActionListenerType  listener = nullptr 
)

Gets the list of subscription options that have a set of required features.

The returned list contains every available subscription option that has the required features with their unique identifier when there is no logged-in user. Otherwise, the subscription option the user has previously selected will have 0 as its identifier while the others keep their identifier. If no features are required (the corresponding parameter is set to zero) this function will work exactly as Iberbox::getSubscriptionOptions.

Parameters
featuresRequired features as a bitmap.
See also
SubscriptionInfoData::FeatureType
Parameters
listenerThe listener that will handle every action event.
Returns
The listener's onActionFinish method will be provided with the finished action.
If any error occurred, the action's getError method may be used to retrieve such error.
  • E_SUCCESS is returned on success.
  • E_PARAMETERS is returned when some parameters are missing or the provided ones are not valid.
  • E_UNEXPECTED is returned when unexpected behavior occurs.
Otherwise, the action's getSubscriptionInfoList method may be used to retrieve the subscriptions options.
The returned action type corresponds to SUBSCRIPTION_OPTIONS.

◆ getTransfers()

void iberbox::Iberbox::getTransfers ( ActionListenerType  listener = nullptr)

Gets all the transfers.

Parameters
listenerThe listener that will handle every action event.
Returns
The listener's onActionFinish method will be provided with the finished action.
If any error occurred, the action's getError method may be used to retrieve such error.
  • E_SUCCESS is returned on success.
  • E_PARAMETERS is returned when some parameters are missing or the provided ones are not valid.
  • E_UNEXPECTED is returned when unexpected behavior occurs.
Otherwise, the action's getActionList method may be used to retrieve the list of transfer actions.
The returned action type corresponds to GET_TRANSFERS.

◆ getTransfersByStatus()

void iberbox::Iberbox::getTransfersByStatus ( int  type,
int  status,
ActionListenerType  listener = nullptr 
)

Gets every transfer that meets the type and status filter.

Parameters
typeThe transfer type which the list of transfers will be filtered with.
statusThe transfer status which the list of transfers will be filtered with.
listenerThe listener that will handle every action event.
Returns
The listener's onActionFinish method will be provided with the finished action.
If any error occurred, the action's getError method may be used to retrieve such error.
  • E_SUCCESS is returned on success.
  • E_PARAMETERS is returned when some parameters are missing or the provided ones are not valid.
  • E_UNEXPECTED is returned when unexpected behavior occurs.
Otherwise, the action's getActionList method may be used to retrieve the list of transfer actions.
The returned action type corresponds to GET_TRANSFERS.

◆ getTransfersByType()

void iberbox::Iberbox::getTransfersByType ( int  type,
ActionListenerType  listener = nullptr 
)

Gets every finished transfer that meets the type filter.

Parameters
typeThe transfer type which the list of transfers will be filtered with.
listenerThe listener that will handle every action event.
Returns
The listener's onActionFinish method will be provided with the finished action.
If any error occurred, the action's getError method may be used to retrieve such error.
  • E_SUCCESS is returned on success.
  • E_PARAMETERS is returned when some parameters are missing or the provided ones are not valid.
  • E_UNEXPECTED is returned when unexpected behavior occurs.
Otherwise, the action's getActionList method may be used to retrieve the list of transfer actions.
The returned action type corresponds to GET_TRANSFERS.

◆ getUnfinishedTransfers()

void iberbox::Iberbox::getUnfinishedTransfers ( int  type,
ActionListenerType  listener = nullptr 
)

Gets every unfinished transfer that meets the type filer.

Parameters
typeThe transfer type which the list of transfers will be filtered with.
listenerThe listener that will handle every action event.
Returns
The listener's onActionFinish method will be provided with the finished action.
If any error occurred, the action's getError method may be used to retrieve such error.
  • E_SUCCESS is returned on success.
  • E_PARAMETERS is returned when some parameters are missing or the provided ones are not valid.
  • E_UNEXPECTED is returned when unexpected behavior occurs.
Otherwise, the action's getActionList method may be used to retrieve the list of transfer actions.
The returned action type corresponds to GET_TRANSFERS.

◆ getUploadSpeedLimit()

void iberbox::Iberbox::getUploadSpeedLimit ( ActionListenerType  listener = nullptr)

Gets the upload speed limit using kbps unit.

Parameters
listenerThe listener that will handle every action event.
Returns
The listener's onActionFinish method will be provided with the finished action.
If any error occurred, the action's getError method may be used to retrieve such error.
  • E_SUCCESS is returned on success.
  • E_PARAMETERS is returned when some parameters are missing or the provided ones are not valid.
  • E_UNEXPECTED is returned when unexpected behavior occurs.
Otherwise, the action's getIntValue method may be used to retrieve the upload speed limit value.
The returned action type corresponds to GET_TRANSFER_SPEED_LIMIT.

◆ getUserInfo()

void iberbox::Iberbox::getUserInfo ( ActionListenerType  listener = nullptr)

Gets the info of the currently logged-in user.

Parameters
listenerThe listener that will handle every action event.
Returns
The listener's onActionFinish method will be provided with the finished action.
If any error occurred, the action's getError method may be used to retrieve such error.
  • E_SUCCESS is returned on success.
  • E_PARAMETERS is returned when some parameters are missing or the provided ones are not valid.
  • E_UNEXPECTED is returned when unexpected behavior occurs.
Otherwise, the action's getUserInfo method may be used to retrieve the info of the currently logged-in user, the getAccountId method to retrieve the default account identifier and getAccountPermissions method to retrieve the list of accounts the user has access to.
The returned action type corresponds to USER_INFO.

◆ globalCleanup()

static void iberbox::Iberbox::globalCleanup ( )
static

Releases global resources.

◆ globalInit()

static void iberbox::Iberbox::globalInit ( const std::string &  appId,
int  appVersion 
)
static

Initializes global resources.

Parameters
appIdThe identifier of the app.
appVersionThe version of the app.

◆ installUpdate()

void iberbox::Iberbox::installUpdate ( const std::string &  appName,
int  version,
const std::string &  downloadFolder,
const std::string &  installFolder,
ActionListenerType  listener = nullptr 
)

installUpdate

Todo:
Parameters
appName
version
downloadFolder
installFolder
listenerThe listener that will handle every action event.
Returns
The listener's onActionFinish method will be provided with the finished action.
If any error occurred, the action's getError method may be used to retrieve such error.
  • E_SUCCESS is returned on success.
  • E_PARAMETERS is returned when some parameters are missing or the provided ones are not valid.
  • E_UNEXPECTED is returned when unexpected behavior occurs.
The returned action type corresponds to UPDATE.

◆ inviteEmail()

void iberbox::Iberbox::inviteEmail ( const std::string &  email,
ActionListenerType  listener = nullptr 
)

Sends an invitation email to the given address.

Parameters
emailThe email address of the recipient of the invitation.
listenerThe listener that will handle every action event.
Returns
The listener's onActionFinish method will be provided with the finished action.
If any error occurred, the action's getError method may be used to retrieve such error.
  • E_SUCCESS is returned on success.
  • E_PARAMETERS is returned when some parameters are missing or the provided ones are not valid.
  • E_UNEXPECTED is returned when unexpected behavior occurs.
  • E_NOTFOUND is returned when the provided email is not previously added to the betatester program.
  • E_FORBIDDEN is returned when the user lacks permissions to call this method.
The returned action type corresponds to ADD_CONTACT.

◆ joinAccount()

void iberbox::Iberbox::joinAccount ( AccountHandle  account,
const std::string &  accountKey,
const std::string &  registrationId,
const std::string &  name,
const std::string &  lastName,
const std::string &  email,
const std::string &  password,
int  pin,
ActionListenerType  listener = nullptr 
)

Gives the currently logged-in user permission to access a specified account.

In order to get the required accountKey, checkJoinLink must have been used previously with the link obtained by the owner of the account after calling createJoinLink.

Parameters
accountThe handle of the account the currently logged-in user will have access to.
accountKeyThe master key of the account the currently logged-in user will have access to.
registrationIdThe registration identifier obtained after calling checkJoinLink.
nameThe name of the user.
lastNameThe last name of the user.
emailThe email that the user will use to log in.
passwordThe password that the user will use to log in.
pinThe 6-digit email verification code obtained after calling checkJoinLink.
listenerThe listener that will handle every action event.
Returns
The listener's onActionFinish method will be provided with the finished action.
If any error occurred, the action's getError method may be used to retrieve such error.
  • E_SUCCESS is returned on success.
  • E_PARAMETERS is returned when some parameters are missing or the provided ones are not valid.
  • E_UNEXPECTED is returned when unexpected behavior occurs.
Otherwise, the action's getSession method may be used to retrieve the session token into the account, the getAccountId method to retrieve the default account identifier, the getStatus method to retrieve the account features bitmap and the getAccountPermissions method to retrieve the list of accounts the user has access to.
The returned action type corresponds to JOIN_LINK.

◆ joinAccountWithCurrentUser()

void iberbox::Iberbox::joinAccountWithCurrentUser ( AccountHandle  account,
const std::string &  accountKey,
ActionListenerType  listener = nullptr 
)

Gives the currently logged-in user permission to access a specified account.

In order to get the required account and accountKey, checkJoinLink must have been used previously with the link obtained by the owner of the account after calling createJoinLink.

Parameters
accountThe handle of the account the currently logged-in user will have access to.
accountKeyThe master key of the account the currently logged-in user will have access to.
listenerThe listener that will handle every action event.
Returns
The listener's onActionFinish method will be provided with the finished action.
If any error occurred, the action's getError method may be used to retrieve such error.
  • E_SUCCESS is returned on success.
  • E_PARAMETERS is returned when some parameters are missing or the provided ones are not valid.
  • E_UNEXPECTED is returned when unexpected behavior occurs.
Otherwise, the action's getSession method may be used to retrieve the session token into the account, the getAccountId method to retrieve the default account identifier, the getStatus method to retrieve the account features bitmap and the getAccountPermissions method to retrieve the list of accounts the user has access to.
The returned action type corresponds to JOIN_LINK.

◆ logEvent()

void iberbox::Iberbox::logEvent ( int  eventId,
ActionListenerType  listener = nullptr 
)

Logs an event given its identifier.

The eventId must be in the range: [4000, 9000]

Parameters
eventIdThe identifier of the event to log.
listenerThe listener that will handle every action event.
Returns
The listener's onActionFinish method will be provided with the finished action.
If any error occurred, the action's getError method may be used to retrieve such error.
  • E_SUCCESS is returned on success.
  • E_PARAMETERS is returned when some parameters are missing or the provided ones are not valid.
  • E_UNEXPECTED is returned when unexpected behavior occurs.
The returned action type corresponds to LOG_EVENT.

◆ logEventData()

void iberbox::Iberbox::logEventData ( int  eventId,
const std::string &  message,
ActionListenerType  listener = nullptr 
)

Logs an event given its identifier and some data to include in the log.

The eventId must be in the range: [4000, 9000]

Parameters
eventIdThe identifier of the event to log.
messageThe message to include in the event log.
listenerThe listener that will handle every action event.
Returns
The listener's onActionFinish method will be provided with the finished action.
If any error occurred, the action's getError method may be used to retrieve such error.
  • E_SUCCESS is returned on success.
  • E_PARAMETERS is returned when some parameters are missing or the provided ones are not valid.
  • E_UNEXPECTED is returned when unexpected behavior occurs.
The returned action type corresponds to LOG_EVENT.

◆ login()

void iberbox::Iberbox::login ( const std::string &  login,
const std::string &  password,
ActionListenerType  listener = nullptr 
)

Performs account 1FA login using login and password credentials.

Parameters
loginThe email of the account used to log in.
passwordThe password of the account used to log in.
listenerThe listener that will handle every action event.
Returns
The listener's onActionFinish method will be provided with the finished action.
If any error occurred, the action's getError method may be used to retrieve such error.
  • E_SUCCESS is returned on success.
  • E_PARAMETERS is returned when some parameters are missing or the provided ones are not valid.
  • E_UNEXPECTED is returned when unexpected behavior occurs.
Otherwise, the action's getAccountPermissions method may be used to retrieve the list of accounts the user has access to, the getUserPermissions method to retrieve the list of users the account has granted access to, the getAccountId method to retrieve the default account identifier, the getStatus method to retrieve the account features bitmap and the getEmail method to retrieve the owner of the account.
The returned action type corresponds to LOGIN.

◆ login2fa()

void iberbox::Iberbox::login2fa ( const std::string &  login,
const std::string &  password,
int  code,
ActionListenerType  listener = nullptr 
)

Performs a 2FA login.

Performs account login using login and password credentials alongside a code generated by any TOTP generator using the account's secret key.

Parameters
loginThe email of the account used to log in.
passwordThe password of the account used to log in.
codeA code generated with any TOTP generator using the account's secret key.
listenerThe listener that will handle every action event.
Returns
The listener's onActionFinish method will be provided with the finished action.
If any error occurred, the action's getError method may be used to retrieve such error.
  • E_SUCCESS is returned on success.
  • E_PARAMETERS is returned when some parameters are missing or the provided ones are not valid.
  • E_UNEXPECTED is returned when unexpected behavior occurs.
Otherwise, the action's getAccountPermissions method may be used to retrieve the list of accounts the user has access to, the getUserPermissions method to retrieve the list of users the account has granted access to, the getAccountId method to retrieve the default account identifier, the getStatus method to retrieve the account features bitmap and the getEmail method to retrieve the owner of the account.
The returned action type corresponds to LOGIN.

◆ loginIntoAccount()

void iberbox::Iberbox::loginIntoAccount ( const std::string &  login,
const std::string &  password,
AccountHandle  account,
ActionListenerType  listener = nullptr 
)

Performs account 1FA login using login and password credentials.

The array of users allowed to log into the account will be of length 1 when the logged-in user hasn't got enough permissions to know the rest of the allow list.

Parameters
loginThe email of the account used to log in.
passwordThe password of the account used to log in.
accountThe handle of the account to which the login action will be performed.
listenerThe listener that will handle every action event.
Returns
The listener's onActionFinish method will be provided with the finished action.
If any error occurred, the action's getError method may be used to retrieve such error.
  • E_SUCCESS is returned on success.
  • E_PARAMETERS is returned when some parameters are missing or the provided ones are not valid.
  • E_UNEXPECTED is returned when unexpected behavior occurs.
Otherwise, the action's getAccountPermissions method may be used to retrieve the list of accounts the user has access to, the getUserPermissions method to retrieve the list of users the account has granted access to, the getAccountId method to retrieve the default account identifier, the getStatus method to retrieve the account features bitmap and the getEmail method to retrieve the owner of the account.
The returned action type corresponds to LOGIN.

◆ loginIntoAccount2fa()

void iberbox::Iberbox::loginIntoAccount2fa ( const std::string &  login,
const std::string &  password,
int  code,
AccountHandle  accountHandle,
ActionListenerType  listener = nullptr 
)

Performs a 2FA login.

Performs account login using login and password credentials alongside a code generated by any TOTP generator using the account's secret key.

Parameters
loginThe email of the account used to log in.
passwordThe password of the account used to log in.
codeA code generated with any TOTP generator using the account's secret key.
accountHandleThe handle of the account to which the login action will be performed.
listenerThe listener that will handle every action event.
Returns
The listener's onActionFinish method will be provided with the finished action.
If any error occurred, the action's getError method may be used to retrieve such error.
  • E_SUCCESS is returned on success.
  • E_PARAMETERS is returned when some parameters are missing or the provided ones are not valid.
  • E_UNEXPECTED is returned when unexpected behavior occurs.
Otherwise, the action's getAccountPermissions method may be used to retrieve the list of accounts the user has access to, the getUserPermissions method to retrieve the list of users the account has granted access to, the getAccountId method to retrieve the default account identifier, the getStatus method to retrieve the account features bitmap and the getEmail method to retrieve the owner of the account.
The returned action type corresponds to LOGIN.

◆ loginLink()

void iberbox::Iberbox::loginLink ( const std::string &  folderLink,
ActionListenerType  listener = nullptr 
)

loginLink

Todo:
1.

loginLink, 2. getNodes, 3. downloadZip

Parameters
folderLink
listenerThe listener that will handle every action event.
Returns
The listener's onActionFinish method will be provided with the finished action.
If any error occurred, the action's getError method may be used to retrieve such error.
  • E_SUCCESS is returned on success.
  • E_PARAMETERS is returned when some parameters are missing or the provided ones are not valid.
  • E_UNEXPECTED is returned when unexpected behavior occurs.
The returned action type corresponds to LOGIN_LINK.

◆ logout()

void iberbox::Iberbox::logout ( ActionListenerType  listener = nullptr)

Performs a logout of the currently logged-in user.

Parameters
listenerThe listener that will handle every action event.
Returns
The listener's onActionFinish method will be provided with the finished action.
If any error occurred, the action's getError method may be used to retrieve such error.
  • E_SUCCESS is returned on success.
  • E_PARAMETERS is returned when some parameters are missing or the provided ones are not valid.
  • E_UNEXPECTED is returned when unexpected behavior occurs.
The returned action type corresponds to LOGOUT.

◆ logoutLink()

void iberbox::Iberbox::logoutLink ( ActionListenerType  listener = nullptr)

logoutLink

Todo:
Parameters
listenerThe listener that will handle every action event.
Returns
The listener's onActionFinish method will be provided with the finished action.
If any error occurred, the action's getError method may be used to retrieve such error.
  • E_SUCCESS is returned on success.
  • E_PARAMETERS is returned when some parameters are missing or the provided ones are not valid.
  • E_UNEXPECTED is returned when unexpected behavior occurs.
The returned action type corresponds to LOGOUT_LINK.

◆ modifyBackup()

void iberbox::Iberbox::modifyBackup ( NodeHandle  backupId,
const std::string &  name,
unsigned long  startTime,
const std::string  cronExpr,
const std::string &  localPath,
int  maxSnapshots,
int  status,
ActionListenerType  listener = nullptr 
)

Modifies the configuration of a previously created backup.

cronExpr must follow the following format:

.--------------- minute (0-59)
|  .------------ hour (0-23)
|  |  .--------- day of the month (1-31)
|  |  |  .------ month (1-12) or jan,feb,mar,apr,may,jun,jul...
|  |  |  |  .--- day of the week (0-6) (sunday=0 or 7) or sun,mon,tue,wed,thu,fri,sat
|  |  |  |  |
*  *  *  *  *
Parameters
backupIdThe handle of the node representing the backup to modify.
nameThe name that will be given to the backup.
startTimeThe start time from which the snapshots will start being created.
cronExprThe cron expression of the interval between one snapshot and another.
localPathThe local path that will be backed up.
maxSnapshotsThe maximum number of the backup snapshots to be kept.
statusThe initial status of the backup.
listenerThe listener that will handle every action event.
Returns
The listener's onActionFinish method will be provided with the finished action.
If any error occurred, the action's getError method may be used to retrieve such error.
  • E_SUCCESS is returned on success.
  • E_PARAMETERS is returned when some parameters are missing or the provided ones are not valid.
  • E_UNEXPECTED is returned when unexpected behavior occurs.
Otherwise, the action's getNode method may be used to retrieve the modified node representing the backup.
The returned action type corresponds to MODIFY_BACKUP.

◆ modifyContact()

void iberbox::Iberbox::modifyContact ( NodeHandle  contact,
const std::string &  contactName,
ActionListenerType  listener = nullptr 
)

Modifies the alias name of a previously added contact.

Parameters
contactThe handle of the contact to be modified.
contactNameThe new name to be given to the contact.
listenerThe listener that will handle every action event.
Returns
The listener's onActionFinish method will be provided with the finished action.
If any error occurred, the action's getError method may be used to retrieve such error.
  • E_SUCCESS is returned on success.
  • E_PARAMETERS is returned when some parameters are missing or the provided ones are not valid.
  • E_UNEXPECTED is returned when unexpected behavior occurs.
Otherwise, the action's getAccountId method may be used to retrieve the new default account.
The returned action type corresponds to MANAGE_CONTACTS.

◆ modifySavedInbox()

void iberbox::Iberbox::modifySavedInbox ( NodeHandle  outbox,
const std::string &  outboxName,
ActionListenerType  listener = nullptr 
)

Modifies the alias name of a previously added outbox.

Parameters
outboxThe handle of the outbox to be updated.
outboxNameThe new name to be given to the outbox.
listenerThe listener that will handle every action event.
Returns
The listener's onActionFinish method will be provided with the finished action.
If any error occurred, the action's getError method may be used to retrieve such error.
  • E_SUCCESS is returned on success.
  • E_PARAMETERS is returned when some parameters are missing or the provided ones are not valid.
  • E_UNEXPECTED is returned when unexpected behavior occurs.
The returned action type corresponds to MANAGE_OUTBOXES.

◆ moveNode()

void iberbox::Iberbox::moveNode ( NodeHandle  node,
NodeHandle  parent,
ActionListenerType  listener = nullptr 
)

Changes the parent node of another node.

Parameters
nodeThe handle of the node whose parent will be changed.
parentThe handle of the new parent of the node.
listenerThe listener that will handle every action event.
Returns
The listener's onActionFinish method will be provided with the finished action.
If any error occurred, the action's getError method may be used to retrieve such error.
  • E_SUCCESS is returned on success.
  • E_PARAMETERS is returned when some parameters are missing or the provided ones are not valid.
  • E_UNEXPECTED is returned when unexpected behavior occurs.
Otherwise, the action's getNode method may be used to retrieve the modified node and getParentId to retrieve the handle of the new parent node.
The returned action type corresponds to MOVE_NODE.

◆ nestSharedDrive()

void iberbox::Iberbox::nestSharedDrive ( NodeHandle  sharedDrive,
NodeHandle  parent,
ActionListenerType  listener = nullptr 
)

◆ newSession()

void iberbox::Iberbox::newSession ( ActionListenerType  listener = nullptr)

Creates a new session.

The returned session string will be required by resumeSession.

Parameters
listenerThe listener that will handle every action event.
Returns
The listener's onActionFinish method will be provided with the finished action.
If any error occurred, the action's getError method may be used to retrieve such error.
  • E_SUCCESS is returned on success.
  • E_PARAMETERS is returned when some parameters are missing or the provided ones are not valid.
  • E_UNEXPECTED is returned when unexpected behavior occurs.
Otherwise, the action's getSession method may be used to retrieve the session string.
The returned action type corresponds to NEW_SESSION.

◆ newSessionIntoAccount()

void iberbox::Iberbox::newSessionIntoAccount ( AccountHandle  accountHandle,
ActionListenerType  listener = nullptr 
)

Creates a new session within an specific account.

The returned session string will be required by resumeSession.

Parameters
accountHandleThe handle of the account for which the new session will be created.
listenerThe listener that will handle every action event.
Returns
The listener's onActionFinish method will be provided with the finished action.
If any error occurred, the action's getError method may be used to retrieve such error.
  • E_SUCCESS is returned on success.
  • E_PARAMETERS is returned when some parameters are missing or the provided ones are not valid.
  • E_UNEXPECTED is returned when unexpected behavior occurs.
Otherwise, the action's getSession method may be used to retrieve the session string, the getNodeId method to retrieve the session identifier and getAccountId method to retrieve the account identifier.
The returned action type corresponds to NEW_SESSION.

◆ onActionFinish()

virtual void iberbox::Iberbox::onActionFinish ( Action  action)
overridevirtual

The method that will be executed when the action finishes.

Parameters
actionThe finished action.

Reimplemented from iberbox::ActionListener.

◆ openSecret()

void iberbox::Iberbox::openSecret ( const std::string &  name,
const std::string &  password,
ActionListenerType  listener = nullptr 
)

Opens a secret spaced given its credentials (name and password).

Parameters
nameThe name of the secret space to be opened.
passwordThe password of the secret space to be opened.
listenerThe listener that will handle every action event.
Returns
The listener's onActionFinish method will be provided with the finished action.
If any error occurred, the action's getError method may be used to retrieve such error.
  • E_SUCCESS is returned on success.
  • E_PARAMETERS is returned when some parameters are missing or the provided ones are not valid.
  • E_UNEXPECTED is returned when unexpected behavior occurs.
Otherwise, the action's getNode method to retrieve the open secret space's root node.
The returned action type corresponds to MANAGE_SECRETS.

◆ readLink()

void iberbox::Iberbox::readLink ( const std::string &  link,
unsigned long  startPositon,
unsigned long  size,
ActionListenerType  listener = nullptr 
)

readLink

Todo:
Parameters
link
startPositon
size
listenerThe listener that will handle every action event.
Returns
The listener's onActionFinish method will be provided with the finished action.
If any error occurred, the action's getError method may be used to retrieve such error.
  • E_SUCCESS is returned on success.
  • E_PARAMETERS is returned when some parameters are missing or the provided ones are not valid.
  • E_UNEXPECTED is returned when unexpected behavior occurs.
The returned action type corresponds to STREAM.

◆ readNode()

void iberbox::Iberbox::readNode ( NodeHandle  file,
unsigned long  startPositon,
unsigned long  size,
ActionListenerType  listener = nullptr 
)

readNode

Todo:
Parameters
file
startPositon
size
listenerThe listener that will handle every action event.
Returns
The listener's onActionFinish method will be provided with the finished action.
If any error occurred, the action's getError method may be used to retrieve such error.
  • E_SUCCESS is returned on success.
  • E_PARAMETERS is returned when some parameters are missing or the provided ones are not valid.
  • E_UNEXPECTED is returned when unexpected behavior occurs.
The returned action type corresponds to STREAM.

◆ recoverAccount()

void iberbox::Iberbox::recoverAccount ( const std::string &  recoveryId,
const std::string &  login,
const std::string &  recoveryKey,
int  pin,
ActionListenerType  listener = nullptr 
)

Recovers the account of a user.

Parameters
recoveryIdThe recovery id obtained after using forgotPassword method.
loginThe email of the account to be recovered.
recoveryKeyThe recovery key of the account to be recovered.
pinThe pin sent to the account's email address after using forgotPassword method.
listenerThe listener that will handle every action event.
Returns
The listener's onActionFinish method will be provided with the finished action.
If any error occurred, the action's getError method may be used to retrieve such error.
  • E_SUCCESS is returned on success.
  • E_PARAMETERS is returned when some parameters are missing or the provided ones are not valid.
  • E_UNEXPECTED is returned when unexpected behavior occurs.
Otherwise, the action's getSession method may be used to retrieve the session string and getIntValue method to retrieve the multifactor auth boolean-like value.
The returned action type corresponds to LOGIN.

◆ recoverAccount2fa()

void iberbox::Iberbox::recoverAccount2fa ( const std::string &  recoveryId,
const std::string &  login,
const std::string &  recoveryKey,
int  pin,
int  code,
ActionListenerType  listener = nullptr 
)

Recovers the account of a user like recoverAccount method does but with the code special param corresponding to the One-Time Password required by 2FA method.

Parameters
recoveryIdThe recovery id obtained after using forgotPassword method.
loginThe email of the account to be recovered.
recoveryKeyThe recovery key of the account to be recovered.
pinThe pin sent to the account's email address after using forgotPassword method.
codeThe 2FA One-Time Password the user obtained from their Authenticator app.
listenerThe listener that will handle every action event.
Returns
The listener's onActionFinish method will be provided with the finished action.
If any error occurred, the action's getError method may be used to retrieve such error.
  • E_SUCCESS is returned on success.
  • E_PARAMETERS is returned when some parameters are missing or the provided ones are not valid.
  • E_UNEXPECTED is returned when unexpected behavior occurs.
Otherwise, the action's getSession method may be used to retrieve the session string and getIntValue method to retrieve the multifactor auth boolean-like value.
The returned action type corresponds to LOGIN.

◆ recoverSecret()

void iberbox::Iberbox::recoverSecret ( const std::string &  recoveryKey,
const std::string &  newName,
const std::string &  newPassword,
ActionListenerType  listener = nullptr 
)

Recovers a secret space given its recovery key.

The recoveryKey should have been obtained using getSecretRecoverykey method.
A secret space recovery implies opening it. A call to updateSecret is performed once the secret space recovery is completed.

Parameters
recoveryKeyThe recovery key of the secret to be recovered.
newNameThe new name the secret to be recovered will be given.
newPasswordThe new password the secret to be recovered will be given.
listenerThe listener that will handle every action event.
Returns
The listener's onActionFinish method will be provided with the finished action.
If any error occurred, the action's getError method may be used to retrieve such error.
  • E_SUCCESS is returned on success.
  • E_PARAMETERS is returned when some parameters are missing or the provided ones are not valid.
  • E_UNEXPECTED is returned when unexpected behavior occurs.
Otherwise, the action's getNode method may be used to retrieve the secret space's root node.
The returned action type corresponds to MANAGE_SECRETS.

◆ registerDevice()

void iberbox::Iberbox::registerDevice ( const std::string &  name,
ActionListenerType  listener = nullptr 
)

Registers a new device in the account of the currently logged-in user.

Parameters
nameThe name of the new device to be created.
listenerThe listener that will handle every action event.
Returns
The listener's onActionFinish method will be provided with the finished action.
If any error occurred, the action's getError method may be used to retrieve such error.
  • E_SUCCESS is returned on success.
  • E_PARAMETERS is returned when some parameters are missing or the provided ones are not valid.
  • E_UNEXPECTED is returned when unexpected behavior occurs.
Otherwise, the action's getNode method may be used to retrieve the node representing the new device.
The returned action type corresponds to REGISTER_DEVICE.

◆ removeActionListener()

void iberbox::Iberbox::removeActionListener ( ActionListenerType  listener)

Removes a previously added action listener.

Parameters
listenerThe listener that will handle every action event.
Returns
The listener's onActionFinish method will be provided with the finished action.
If any error occurred, the action's getError method may be used to retrieve such error.
  • E_SUCCESS is returned on success.
  • E_PARAMETERS is returned when some parameters are missing or the provided ones are not valid.
  • E_UNEXPECTED is returned when unexpected behavior occurs.

◆ removeContact()

void iberbox::Iberbox::removeContact ( NodeHandle  contact,
ActionListenerType  listener = nullptr 
)

Removes a contact from the current account.

Parameters
contactThe handle of the contact to be removed.
listenerThe listener that will handle every action event.
Returns
The listener's onActionFinish method will be provided with the finished action.
If any error occurred, the action's getError method may be used to retrieve such error.
  • E_SUCCESS is returned on success.
  • E_PARAMETERS is returned when some parameters are missing or the provided ones are not valid.
  • E_UNEXPECTED is returned when unexpected behavior occurs.
The returned action type corresponds to MANAGE_CONTACTS.

◆ removeEventListener()

void iberbox::Iberbox::removeEventListener ( EventListenerType  listener)

Removes a previously added event listener.

Parameters
listenerThe listener that will handle every action event.
Returns
The listener's onActionFinish method will be provided with the finished action.
If any error occurred, the action's getError method may be used to retrieve such error.
  • E_SUCCESS is returned on success.
  • E_PARAMETERS is returned when some parameters are missing or the provided ones are not valid.
  • E_UNEXPECTED is returned when unexpected behavior occurs.

◆ removeFromRecord()

void iberbox::Iberbox::removeFromRecord ( NodeHandle  fileHandle,
ActionListenerType  listener = nullptr 
)

Removes a file from a record given its node handle.

Parameters
fileHandleThe handle of the node representing the file to be removed.
listenerThe listener that will handle every action event.
Returns
The listener's onActionFinish method will be provided with the finished action.
If any error occurred, the action's getError method may be used to retrieve such error.
  • E_SUCCESS is returned on success.
  • E_PARAMETERS is returned when some parameters are missing or the provided ones are not valid.
  • E_UNEXPECTED is returned when unexpected behavior occurs.
The returned action type corresponds to REMOVE_FROM_RECORD.

◆ removePaymentMethod()

void iberbox::Iberbox::removePaymentMethod ( ActionListenerType  listener = nullptr)

Removes the configured payment method for the account of the currently logged-in user.

Parameters
listenerThe listener that will handle every action event.
Returns
The listener's onActionFinish method will be provided with the finished action.
If any error occurred, the action's getError method may be used to retrieve such error.
  • E_SUCCESS is returned on success.
  • E_PARAMETERS is returned when some parameters are missing or the provided ones are not valid.
  • E_UNEXPECTED is returned when unexpected behavior occurs.
The returned action type corresponds to REMOVE_PAYMENT_METHOD.

◆ removeProxy()

void iberbox::Iberbox::removeProxy ( ActionListenerType  listener = nullptr)

Disables the current active proxy server configuration.

Parameters
listenerThe listener that will handle every action event.
Returns
The listener's onActionFinish method will be provided with the finished action.
If any error occurred, the action's getError method may be used to retrieve such error.
  • E_SUCCESS is returned on success.
  • E_PARAMETERS is returned when some parameters are missing or the provided ones are not valid.
  • E_UNEXPECTED is returned when unexpected behavior occurs.
The returned action type corresponds to SET_PROXY.

◆ removeRecord()

void iberbox::Iberbox::removeRecord ( ActionListenerType  listener = nullptr)

Removes a record from...

Todo:
What record does it remove?
Parameters
listenerThe listener that will handle every action event.
Returns
The listener's onActionFinish method will be provided with the finished action.
If any error occurred, the action's getError method may be used to retrieve such error.
  • E_SUCCESS is returned on success.
  • E_PARAMETERS is returned when some parameters are missing or the provided ones are not valid.
  • E_UNEXPECTED is returned when unexpected behavior occurs.
The returned action type corresponds to LOGOUT_LINK.

◆ removeSavedInbox()

void iberbox::Iberbox::removeSavedInbox ( NodeHandle  outbox,
ActionListenerType  listener = nullptr 
)

Removes an outbox from the current account.

Parameters
outboxThe handle of the outbox to be removed.
listenerThe listener that will handle every action event.
Returns
The listener's onActionFinish method will be provided with the finished action.
If any error occurred, the action's getError method may be used to retrieve such error.
  • E_SUCCESS is returned on success.
  • E_PARAMETERS is returned when some parameters are missing or the provided ones are not valid.
  • E_UNEXPECTED is returned when unexpected behavior occurs.
The returned action type corresponds to MANAGE_OUTBOXES.

◆ renameBackup()

void iberbox::Iberbox::renameBackup ( NodeHandle  backupId,
const std::string &  newName,
ActionListenerType  listener = nullptr 
)

Renames a specified backup.

Parameters
backupIdThe handle of the node representing the backup whose name will be changed.
newNameThe new name to be set in the specified backup.
listenerThe listener that will handle every action event.
Returns
The listener's onActionFinish method will be provided with the finished action.
If any error occurred, the action's getError method may be used to retrieve such error.
  • E_SUCCESS is returned on success.
  • E_PARAMETERS is returned when some parameters are missing or the provided ones are not valid.
  • E_UNEXPECTED is returned when unexpected behavior occurs.
Otherwise, the action's getNode method may be used to retrieve the modified node representing the backup.
The returned action type corresponds to RENAME_BACKUP.

◆ renameDevice()

void iberbox::Iberbox::renameDevice ( NodeHandle  deviceId,
const std::string &  newName,
ActionListenerType  listener = nullptr 
)

Set a new name to the device identified by deviceId.

Parameters
deviceIdThe handle of the node that uniquely identifies the requested device.
newNameThe new name to be set to the requested device.
listenerThe listener that will handle every action event.
Returns
The listener's onActionFinish method will be provided with the finished action.
If any error occurred, the action's getError method may be used to retrieve such error.
  • E_SUCCESS is returned on success.
  • E_PARAMETERS is returned when some parameters are missing or the provided ones are not valid.
  • E_UNEXPECTED is returned when unexpected behavior occurs.
  • E_DUPLICATE is returned when another device already has the given newName.
Otherwise, the action's getNode method may be used to retrieve the updated device.
The returned action type corresponds to RENAME_DEVICE.

◆ renameNode()

void iberbox::Iberbox::renameNode ( NodeHandle  node,
const std::string &  name,
ActionListenerType  listener = nullptr 
)

Sets a new name to the specified node.

Parameters
nodeThe handle of the node that will be renamed.
nameThe new name to be set to the specified node.
listenerThe listener that will handle every action event.
Returns
The listener's onActionFinish method will be provided with the finished action.
If any error occurred, the action's getError method may be used to retrieve such error.
  • E_SUCCESS is returned on success.
  • E_PARAMETERS is returned when some parameters are missing or the provided ones are not valid.
  • E_UNEXPECTED is returned when unexpected behavior occurs.
Otherwise, the action's getNode method may be used to retrieve the modified node.
The returned action type corresponds to RENAME_NODE.

◆ resumeRecord()

void iberbox::Iberbox::resumeRecord ( const std::string &  newRecordLink,
ActionListenerType  listener = nullptr 
)

Resumes the creation of a record.

Parameters
newRecordLinkThe record creation link.
listenerThe listener that will handle every action event.
Returns
The listener's onActionFinish method will be provided with the finished action.
If any error occurred, the action's getError method may be used to retrieve such error.
  • E_SUCCESS is returned on success.
  • E_PARAMETERS is returned when some parameters are missing or the provided ones are not valid.
  • E_UNEXPECTED is returned when unexpected behavior occurs.
Otherwise, the action's getSession method may be used to retrieve the session string.
The returned action type corresponds to LOGIN_LINK.

◆ resumeSession()

void iberbox::Iberbox::resumeSession ( const std::string &  session,
ActionListenerType  listener = nullptr 
)

Resumes an user's session given a previously obtained session string.

Resuming the session involves performing a login action.

Parameters
sessionThe JWT string representing the session.
listenerThe listener that will handle every action event.
Returns
The listener's onActionFinish method will be provided with the finished action.
If any error occurred, the action's getError method may be used to retrieve such error.
  • E_SUCCESS is returned on success.
  • E_PARAMETERS is returned when some parameters are missing or the provided ones are not valid.
  • E_UNEXPECTED is returned when unexpected behavior occurs.
The returned action type corresponds to LOGIN.

◆ revokeAccountAccess()

void iberbox::Iberbox::revokeAccountAccess ( UserHandle  user,
ActionListenerType  listener = nullptr 
)

Revokes access of a specific user to the current account.

Access can only be revoked by the owner of the account.

Parameters
userThe handle of the user whose access to the current account will be revoked.
listenerThe listener that will handle every action event.
Returns
The listener's onActionFinish method will be provided with the finished action.
If any error occurred, the action's getError method may be used to retrieve such error.
  • E_SUCCESS is returned on success.
  • E_PARAMETERS is returned when some parameters are missing or the provided ones are not valid.
  • E_UNEXPECTED is returned when unexpected behavior occurs.
Otherwise, the action's getAccountId method may be used to retrieve the new default account.
The returned action type corresponds to REVOKE_ACCOUNT_ACCESS.

◆ revokeAccountAccessOfCurrentUser()

void iberbox::Iberbox::revokeAccountAccessOfCurrentUser ( ActionListenerType  listener = nullptr)

Revokes access of currently logged-in user to the current account.

Access can only be revoked by the owner of the account.

Parameters
listenerThe listener that will handle every action event.
Returns
The listener's onActionFinish method will be provided with the finished action.
If any error occurred, the action's getError method may be used to retrieve such error.
  • E_SUCCESS is returned on success.
  • E_PARAMETERS is returned when some parameters are missing or the provided ones are not valid.
  • E_UNEXPECTED is returned when unexpected behavior occurs.
Otherwise, the action's getAccountId method may be used to retrieve the new default account.
The returned action type corresponds to REVOKE_ACCOUNT_ACCESS.

◆ saveInbox()

void iberbox::Iberbox::saveInbox ( NodeHandle  contact,
const std::string &  inboxLink,
const std::string &  outboxName,
ActionListenerType  listener = nullptr 
)

Saves an inbox corresponded to an existing contact in order to keep track of the sent records.

Parameters
contactThe handle of the contact whom the inbox belongs to.
inboxLinkThe public link of the inbox to be saved.
outboxNameAn alias name to be given to the specified inbox.
listenerThe listener that will handle every action event.
Returns
The listener's onActionFinish method will be provided with the finished action.
If any error occurred, the action's getError method may be used to retrieve such error.
  • E_SUCCESS is returned on success.
  • E_PARAMETERS is returned when some parameters are missing or the provided ones are not valid.
  • E_UNEXPECTED is returned when unexpected behavior occurs.
The returned action type corresponds to MANAGE_OUTBOXES.

◆ saveSentRecord()

void iberbox::Iberbox::saveSentRecord ( NodeHandle  outbox,
const std::string &  recordLink,
ActionListenerType  listener = nullptr 
)
Parameters
outbox
recordLink
listenerThe listener that will handle every action event.
Returns
The listener's onActionFinish method will be provided with the finished action.
If any error occurred, the action's getError method may be used to retrieve such error.
  • E_SUCCESS is returned on success.
  • E_PARAMETERS is returned when some parameters are missing or the provided ones are not valid.
  • E_UNEXPECTED is returned when unexpected behavior occurs.
The returned action type corresponds to MANAGE_SENT_RECORDS.

◆ selectDevice()

void iberbox::Iberbox::selectDevice ( NodeHandle  deviceId,
ActionListenerType  listener = nullptr 
)

Selects a given device from the account of the currently logged-in user.

Parameters
deviceIdThe handle of the node representing the device to be selected.
listenerThe listener that will handle every action event.
Returns
The listener's onActionFinish method will be provided with the finished action.
If any error occurred, the action's getError method may be used to retrieve such error.
  • E_SUCCESS is returned on success.
  • E_PARAMETERS is returned when some parameters are missing or the provided ones are not valid.
  • E_UNEXPECTED is returned when unexpected behavior occurs.
Otherwise, the action's getNodeList method may be used to retrieve the configured backups of the given device.
The returned action type corresponds to SELECT_DEVICE.

◆ sendCrashReport()

void iberbox::Iberbox::sendCrashReport ( const std::string &  file,
ActionListenerType  listener = nullptr 
)

sendCrashReport

Todo:
Parameters
file
listenerThe listener that will handle every action event.
Returns
The listener's onActionFinish method will be provided with the finished action.
If any error occurred, the action's getError method may be used to retrieve such error.
  • E_SUCCESS is returned on success.
  • E_PARAMETERS is returned when some parameters are missing or the provided ones are not valid.
  • E_UNEXPECTED is returned when unexpected behavior occurs.
The returned action type corresponds to CRASH_REPORT.

◆ setAccessLevel()

void iberbox::Iberbox::setAccessLevel ( UserHandle  user,
int  accessLevel,
ActionListenerType  listener = nullptr 
)

Sets an user's access level to the current account.

Valid status values are described in AccessLevel enum.

Parameters
userThe handle of the user.
accessLevelThe new access level to be set.
listenerThe listener that will handle every action event.
Returns
The listener's onActionFinish method will be provided with the finished action.
If any error occurred, the action's getError method may be used to retrieve such error.
  • E_SUCCESS is returned on success.
  • E_PARAMETERS is returned when some parameters are missing or the provided ones are not valid.
  • E_UNEXPECTED is returned when unexpected behavior occurs.
The returned action type corresponds to SET_ACCESS_LEVEL.

◆ setAccountCryptoScheme()

void iberbox::Iberbox::setAccountCryptoScheme ( int  cryptoScheme,
ActionListenerType  listener = nullptr 
)

Set the default crypto scheme for the account.

Iberbox supports multiple crypto schemes to encrypt / decrypt and protect your files. This allows the platforms to evolve and use the newer, safer or faster crypto algorithms as needed. By default, Iberbox uses AES256, because it's the strongest crypto algorithm with a good native support on all platforms (including the web using HTML5 Web Crypto). However, depending on different needs, different algoritms could be used. Uploaded files are ciphered using the default crypto algorithm set for the account when the upload starts and, even if this setting is changed later, uploaded files keep being ciphered with that algorithm. They are not reencrypted, among other things because that would require to download each file, decrypt it, encrypt it with the new algorithm and upload it. So if you want to keep a file stored in Iberbox ciphered with a specific crypto algorithm, you have to set this setting before the file is uploaded. Files encrypted with different crypto algorithms can coexist in the same account without problems.

Parameters
cryptoSchemeDefault crypto scheme for the account Currently, the available options are:
  • CryptoSchemeType::AES256_CRYPTO_SCHEME = 0 (default, stronger)
  • CryptoSchemeType::AES128_CRYPTO_SCHEME = 2 (faster)
listenerThe listener that will handle every action event.
Returns
The listener's onActionFinish method will be provided with the finished action.
If any error occurred, the action's getError method may be used to retrieve such error.
  • E_SUCCESS is returned on success.
  • E_PARAMETERS is returned when some parameters are missing or the provided ones are not valid.
  • E_UNEXPECTED is returned when unexpected behavior occurs.
The returned action type corresponds to SET_ACCOUNT_VALUE.

◆ setAuthProxy()

void iberbox::Iberbox::setAuthProxy ( const std::string &  url,
const std::string &  user,
const std::string &  password,
ActionListenerType  listener = nullptr 
)

Sets up an authenticated proxy server.

Parameters
urlThe URL of the proxy server (protocol://ip:port).
userThe user credential for the server connection.
passwordThe password credential for the server connection.
listenerThe listener that will handle every action event.
Returns
The listener's onActionFinish method will be provided with the finished action.
If any error occurred, the action's getError method may be used to retrieve such error.
  • E_SUCCESS is returned on success.
  • E_PARAMETERS is returned when some parameters are missing or the provided ones are not valid.
  • E_UNEXPECTED is returned when unexpected behavior occurs.
The returned action type corresponds to SET_PROXY.

◆ setDefaultAccount()

void iberbox::Iberbox::setDefaultAccount ( AccountHandle  account,
ActionListenerType  listener = nullptr 
)

Sets the default account for the currently logged-in user.

The account is the one the user will be logged in by default if no other is specified when using login and loginIntoAccount methods.

Parameters
accountThe handle of the account the currently logged-in user will have access to.
listenerThe listener that will handle every action event.
Returns
The listener's onActionFinish method will be provided with the finished action.
If any error occurred, the action's getError method may be used to retrieve such error.
  • E_SUCCESS is returned on success.
  • E_PARAMETERS is returned when some parameters are missing or the provided ones are not valid.
  • E_UNEXPECTED is returned when unexpected behavior occurs.
The returned action type corresponds to DEFAULT_ACCOUNT.

◆ setDownloadSpeedLimit()

void iberbox::Iberbox::setDownloadSpeedLimit ( int  kbps,
ActionListenerType  listener = nullptr 
)

Sets the download speed limit setting.

Parameters
kbpsThe new value to be set using kbps unit.
listenerThe listener that will handle every action event.
Returns
The listener's onActionFinish method will be provided with the finished action.
If any error occurred, the action's getError method may be used to retrieve such error.
  • E_SUCCESS is returned on success.
  • E_PARAMETERS is returned when some parameters are missing or the provided ones are not valid.
  • E_UNEXPECTED is returned when unexpected behavior occurs.
The returned action type corresponds to SET_TRANSFER_SPEED_LIMIT.

◆ setEmailRecordInfo()

void iberbox::Iberbox::setEmailRecordInfo ( const std::string &  from,
const std::string &  to,
const std::string &  subject,
const std::string &  message,
ActionListenerType  listener = nullptr 
)

Sets the information of a record sent by email.

Parameters
fromThe contact who registers the record.
toThe email of the contact that should receive the record
subjectThe subject of the record.
messageThe message of the record.
listenerThe listener that will handle every action event.
Returns
The listener's onActionFinish method will be provided with the finished action.
If any error occurred, the action's getError method may be used to retrieve such error.
  • E_SUCCESS is returned on success.
  • E_PARAMETERS is returned when some parameters are missing or the provided ones are not valid.
  • E_UNEXPECTED is returned when unexpected behavior occurs.
Otherwise, the action's getNode method may be used to retrieve the updated node representing the record.
The returned action type corresponds to SET_RECORD_INFO.

◆ setInboxInfo()

void iberbox::Iberbox::setInboxInfo ( NodeHandle  inboxHandle,
const std::string &  name,
const std::string &  message,
ActionListenerType  listener = nullptr 
)

Sets new information related to a given inbox.

Parameters
inboxHandleThe handle of the node representing the inbox to modify.
nameThe new name for the given inbox.
messageThe new description for the given inbox.
listenerThe listener that will handle every action event.
Returns
The listener's onActionFinish method will be provided with the finished action.
If any error occurred, the action's getError method may be used to retrieve such error.
  • E_SUCCESS is returned on success.
  • E_PARAMETERS is returned when some parameters are missing or the provided ones are not valid.
  • E_UNEXPECTED is returned when unexpected behavior occurs.
Otherwise, the action's getNode method may be used to retrieve the node representing the modified inbox.
The returned action type corresponds to SET_INBOX_INFO.

◆ setInvoicingAddress()

void iberbox::Iberbox::setInvoicingAddress ( const std::string &  companyName,
const std::string &  companyAddress,
const std::string &  companyAddress2,
const std::string &  companyID,
ActionListenerType  listener = nullptr 
)

Sets the invoicing address for the currently logged-in user.

Invoicing address requires the business name, two address lines (the second one is optional), and a company identifier.

Parameters
companyNameThe bussiness name.
companyAddressThe address line 1.
companyAddress2The address line 2 (optional).
companyIDThe company identifier.
listenerThe listener that will handle every action event.
Returns
The listener's onActionFinish method will be provided with the finished action.
If any error occurred, the action's getError method may be used to retrieve such error.
  • E_SUCCESS is returned on success.
  • E_PARAMETERS is returned when some parameters are missing or the provided ones are not valid.
  • E_UNEXPECTED is returned when unexpected behavior occurs.
The returned action type corresponds to SET_INVOICING_ADDRESS.

◆ setLogLevel()

static void iberbox::Iberbox::setLogLevel ( int  logLevel)
static

Set the active log level Possible log levels are specified by the LogLevelType enum:

  • LOG_LEVEL_TRACE = 0,
  • LOG_LEVEL_DEBUG = 1,
  • LOG_LEVEL_INFO = 2,
  • LOG_LEVEL_WARN = 3,
  • LOG_LEVEL_ERROR = 4,
  • LOG_LEVEL_CRITICAL = 5,
  • LOG_LEVEL_OFF = 6
    Parameters
    logLevelLog level to apply

◆ setNodeTag()

void iberbox::Iberbox::setNodeTag ( NodeHandle  node,
unsigned char  tag,
ActionListenerType  listener = nullptr 
)

Sets a new tag to the specified node.

Only files and folders may hold this value.
Valid tag values are described in TagType enum.

Parameters
nodeThe handle of the node that will be modified.
tagThe new tag to be set to the specified node.
listenerThe listener that will handle every action event.
Returns
The listener's onActionFinish method will be provided with the finished action.
If any error occurred, the action's getError method may be used to retrieve such error.
  • E_SUCCESS is returned on success.
  • E_PARAMETERS is returned when some parameters are missing or the provided ones are not valid.
  • E_UNEXPECTED is returned when unexpected behavior occurs.
Otherwise, the action's getNode method may be used to retrieve the modified node.
The returned action type corresponds to MANAGE_NODE_TAG.

◆ setProxy()

void iberbox::Iberbox::setProxy ( const std::string &  url,
ActionListenerType  listener = nullptr 
)

Sets up an unauthenticated proxy server.

Parameters
urlThe URL of the proxy server (protocol://ip:port).
listenerThe listener that will handle every action event.
Returns
The listener's onActionFinish method will be provided with the finished action.
If any error occurred, the action's getError method may be used to retrieve such error.
  • E_SUCCESS is returned on success.
  • E_PARAMETERS is returned when some parameters are missing or the provided ones are not valid.
  • E_UNEXPECTED is returned when unexpected behavior occurs.
The returned action type corresponds to SET_PROXY.

◆ setRecordInfo()

void iberbox::Iberbox::setRecordInfo ( const std::string &  contactInfo,
const std::string &  subject,
const std::string &  message,
ActionListenerType  listener = nullptr 
)

Sets the information of a record.

Parameters
contactInfoThe email of the contact who registers the record.
subjectThe subject of the record.
messageThe message of the record.
listenerThe listener that will handle every action event.
Returns
The listener's onActionFinish method will be provided with the finished action.
If any error occurred, the action's getError method may be used to retrieve such error.
  • E_SUCCESS is returned on success.
  • E_PARAMETERS is returned when some parameters are missing or the provided ones are not valid.
  • E_UNEXPECTED is returned when unexpected behavior occurs.
Otherwise, the action's getNode method may be used to retrieve the updated node representing the record.
The returned action type corresponds to SET_RECORD_INFO.

◆ setRecordStatus()

void iberbox::Iberbox::setRecordStatus ( NodeHandle  record,
unsigned char  status,
ActionListenerType  listener = nullptr 
)

Sets the status of a record given its handle.

Valid status values are described in RecordStatus enum.

Parameters
recordThe handle of the record whose status is to be set.
statusThe new status to be set.
listenerThe listener that will handle every action event.
Returns
The listener's onActionFinish method will be provided with the finished action.
If any error occurred, the action's getError method may be used to retrieve such error.
  • E_SUCCESS is returned on success.
  • E_PARAMETERS is returned when some parameters are missing or the provided ones are not valid.
  • E_UNEXPECTED is returned when unexpected behavior occurs.
Otherwise, the action's getNode method may be used to retrieve the node representing the updated record.
The returned action type corresponds to SET_RECORD_STATUS.

◆ setSubscription()

void iberbox::Iberbox::setSubscription ( int  subscriptionId,
ActionListenerType  listener = nullptr 
)

Sets a specific subscription for the current account.

The available subscription options for a user may be retrieved using getSubscriptionOptions.

Parameters
subscriptionIdThe identifier of the subscription that will be configured for the current account.
listenerThe listener that will handle every action event.
Returns
The listener's onActionFinish method will be provided with the finished action.
If any error occurred, the action's getError method may be used to retrieve such error.
  • E_SUCCESS is returned on success.
  • E_PARAMETERS is returned when some parameters are missing or the provided ones are not valid.
  • E_UNEXPECTED is returned when unexpected behavior occurs.
The returned action type corresponds to SUBSCRIPTION_OPTIONS.

◆ setUploadSpeedLimit()

void iberbox::Iberbox::setUploadSpeedLimit ( int  kbps,
ActionListenerType  listener = nullptr 
)

Sets the upload speed limit setting.

Parameters
kbpsThe new value to be set using kbps unit.
listenerThe listener that will handle every action event.
Returns
The listener's onActionFinish method will be provided with the finished action.
If any error occurred, the action's getError method may be used to retrieve such error.
  • E_SUCCESS is returned on success.
  • E_PARAMETERS is returned when some parameters are missing or the provided ones are not valid.
  • E_UNEXPECTED is returned when unexpected behavior occurs.
The returned action type corresponds to SET_TRANSFER_SPEED_LIMIT.

◆ shareDriveWithAccount()

void iberbox::Iberbox::shareDriveWithAccount ( NodeHandle  sharedDrive,
AccountHandle  account,
ActionListenerType  listener = nullptr 
)

Shares a drive with an account given their respective handles.

An account link may also be provided in the account param. The account will get read/write access to the shared drive. To grant read access only, use Iberbox::shareDriveWithAccountAndAccessLevel

Parameters
sharedDriveThe handle of the drive to be shared.
accountThe handle of the account the drive will be shared with.
listenerThe listener that will handle every action event.
Returns
The listener's onActionFinish method will be provided with the finished action.
If any error occurred, the action's getError method may be used to retrieve such error.
  • E_SUCCESS is returned on success.
  • E_PARAMETERS is returned when some parameters are missing or the provided ones are not valid.
  • E_UNEXPECTED is returned when unexpected behavior occurs.
The returned action type corresponds to MANAGE_SHARED_DRIVES.

◆ shareDriveWithAccountAndAccessLevel()

void iberbox::Iberbox::shareDriveWithAccountAndAccessLevel ( NodeHandle  sharedDrive,
AccountHandle  account,
int  accessLevel,
ActionListenerType  listener = nullptr 
)

Shares a drive with an account given their respective handles.

An account link may also be provided in the account param. This function can also be used to change the access level of an already shared drive.

Parameters
sharedDriveThe handle of the drive to be shared.
accountThe handle of the account the drive will be shared with.
accessLevelThe access level granted to the account. Valid values are:
listenerThe listener that will handle every action event.
Returns
The listener's onActionFinish method will be provided with the finished action.
If any error occurred, the action's getError method may be used to retrieve such error.
  • E_SUCCESS is returned on success.
  • E_PARAMETERS is returned when some parameters are missing or the provided ones are not valid.
  • E_UNEXPECTED is returned when unexpected behavior occurs.
The returned action type corresponds to MANAGE_SHARED_DRIVES.

◆ shareDriveWithAccountByLink()

void iberbox::Iberbox::shareDriveWithAccountByLink ( NodeHandle  sharedDrive,
const std::string &  accountLink,
ActionListenerType  listener = nullptr 
)

Shares a drive with an account given the drive handle and the account link.

An account link may also be provided in the account param. The account will get read/write access to the shared drive. To grant read access only, use Iberbox::shareDriveWithAccountByLinkWithAccessLevel

Parameters
sharedDriveThe handle of the drive to be shared.
accountLinkThe link of the account the drive will be shared with.
listenerThe listener that will handle every action event.
Returns
The listener's onActionFinish method will be provided with the finished action.
If any error occurred, the action's getError method may be used to retrieve such error.
  • E_SUCCESS is returned on success.
  • E_PARAMETERS is returned when some parameters are missing or the provided ones are not valid.
  • E_UNEXPECTED is returned when unexpected behavior occurs.
The returned action type corresponds to MANAGE_SHARED_DRIVES.

◆ shareDriveWithAccountByLinkWithAccessLevel()

void iberbox::Iberbox::shareDriveWithAccountByLinkWithAccessLevel ( NodeHandle  sharedDrive,
const std::string &  accountLink,
int  accessLevel,
ActionListenerType  listener = nullptr 
)

Shares a drive with an account given the drive handle and the account link.

An account link may also be provided in the account param. This function can also be used to change the access level of an already shared drive.

Parameters
sharedDriveThe handle of the drive to be shared.
accountLinkThe link of the account the drive will be shared with.
accessLevelThe access level granted to the account. Valid values are:
listenerThe listener that will handle every action event.
Returns
The listener's onActionFinish method will be provided with the finished action.
If any error occurred, the action's getError method may be used to retrieve such error.
  • E_SUCCESS is returned on success.
  • E_PARAMETERS is returned when some parameters are missing or the provided ones are not valid.
  • E_UNEXPECTED is returned when unexpected behavior occurs.
The returned action type corresponds to MANAGE_SHARED_DRIVES.

◆ startRecord()

void iberbox::Iberbox::startRecord ( const std::string &  inboxLink,
ActionListenerType  listener = nullptr 
)

Starts a new record in an inbox.

Parameters
inboxLinkThe public link pointing to a specific inbox.
listenerThe listener that will handle every action event.
Returns
The listener's onActionFinish method will be provided with the finished action.
If any error occurred, the action's getError method may be used to retrieve such error.
  • E_SUCCESS is returned on success.
  • E_PARAMETERS is returned when some parameters are missing or the provided ones are not valid.
  • E_UNEXPECTED is returned when unexpected behavior occurs.
Otherwise, the action's getSession method may be used to retrieve the record creation link.
The returned action type corresponds to LOGIN_LINK.

◆ test()

int iberbox::Iberbox::test ( )

test

Todo:
Returns
int

◆ testProxy()

void iberbox::Iberbox::testProxy ( const std::string &  url,
const std::string &  user,
const std::string &  password,
ActionListenerType  listener = nullptr 
)

testProxy

Todo:
Parameters
url
user
password
listenerThe listener that will handle every action event.
Returns
The listener's onActionFinish method will be provided with the finished action.
If any error occurred, the action's getError method may be used to retrieve such error.
  • E_SUCCESS is returned on success.
  • E_PARAMETERS is returned when some parameters are missing or the provided ones are not valid.
  • E_UNEXPECTED is returned when unexpected behavior occurs.
The returned action type corresponds to TEST_PROXY.

◆ testRequest()

void iberbox::Iberbox::testRequest ( ActionListenerType  listener = nullptr)

testRequest

Todo:
Parameters
listenerThe listener that will handle every action event.
Returns
The listener's onActionFinish method will be provided with the finished action.
If any error occurred, the action's getError method may be used to retrieve such error.
  • E_SUCCESS is returned on success.
  • E_PARAMETERS is returned when some parameters are missing or the provided ones are not valid.
  • E_UNEXPECTED is returned when unexpected behavior occurs.
The returned action type corresponds to TEST.

◆ toggleFolderSync()

void iberbox::Iberbox::toggleFolderSync ( NodeHandle  node,
ActionListenerType  listener = nullptr 
)

Toggle the sync flag of a folder.

Only folders may hold this value.

Parameters
nodeThe handle of the node that will be modified.
listenerThe listener that will handle every action event.
Returns
The listener's onActionFinish method will be provided with the finished action.
If any error occurred, the action's getError method may be used to retrieve such error.
  • E_SUCCESS is returned on success.
  • E_PARAMETERS is returned when some parameters are missing or the provided ones are not valid.
  • E_UNEXPECTED is returned when unexpected behavior occurs.
Otherwise, the action's getNode method may be used to retrieve the modified node.
The returned action type corresponds to MANAGE_FOLDER_SYNC.

◆ unarchiveSharedDrive()

void iberbox::Iberbox::unarchiveSharedDrive ( NodeHandle  sharedDrive,
ActionListenerType  listener = nullptr 
)

unarchiveSharedDrive

// TODO:

Parameters
sharedDrive
listener

◆ unnestSharedDrive()

void iberbox::Iberbox::unnestSharedDrive ( NodeHandle  sharedDrive,
ActionListenerType  listener = nullptr 
)

◆ unshareDriveWithAccount()

void iberbox::Iberbox::unshareDriveWithAccount ( NodeHandle  sharedDrive,
AccountHandle  account,
ActionListenerType  listener = nullptr 
)

Unshares a drive with an account given their respective handles.

An account link may also be provided in the account param.

Parameters
sharedDriveThe handle of the shared drive to be unshared.
accountThe handle of the account the drive will be unshared with.
listenerThe listener that will handle every action event.
Returns
The listener's onActionFinish method will be provided with the finished action.
If any error occurred, the action's getError method may be used to retrieve such error.
  • E_SUCCESS is returned on success.
  • E_PARAMETERS is returned when some parameters are missing or the provided ones are not valid.
  • E_UNEXPECTED is returned when unexpected behavior occurs.
The returned action type corresponds to MANAGE_SHARED_DRIVES.

◆ updateSecret()

void iberbox::Iberbox::updateSecret ( NodeHandle  secretHandle,
const std::string &  name,
const std::string &  password,
ActionListenerType  listener = nullptr 
)

Updates the credentials of a secret space given its handle and new credentials values.

Parameters
secretHandleThe handle of the secret space to be updated.
nameThe new name for the secret space.
passwordThe new password for the secret space.
listenerThe listener that will handle every action event.
Returns
The listener's onActionFinish method will be provided with the finished action.
If any error occurred, the action's getError method may be used to retrieve such error.
  • E_SUCCESS is returned on success.
  • E_PARAMETERS is returned when some parameters are missing or the provided ones are not valid.
  • E_UNEXPECTED is returned when unexpected behavior occurs.
Otherwise, the action's getNode method to retrieve the updated secret space's node.
The returned action type corresponds to MANAGE_SECRETS.

◆ upload()

void iberbox::Iberbox::upload ( const std::string &  file,
NodeHandle  parent,
ActionListenerType  listener = nullptr 
)

Uploads a file or folder to a specific folder.

Parameters
fileThe path to the file in the client filesystem.
parentThe handler of the parent node in which the file will be uploaded.
listenerThe listener that will handle every action event.
Returns
The listener's onActionFinish method will be provided with the finished action.
If any error occurred, the action's getError method may be used to retrieve such error.
  • E_SUCCESS is returned on success.
  • E_PARAMETERS is returned when some parameters are missing or the provided ones are not valid.
  • E_UNEXPECTED is returned when unexpected behavior occurs.
Otherwise, the action's getNode method may be used to retrieve the uploaded file or root folder node.
The returned action type corresponds to UPLOAD.

◆ uploadMetadata()

void iberbox::Iberbox::uploadMetadata ( const std::string &  file,
NodeHandle  node,
int  metadataType,
ActionListenerType  listener = nullptr 
)

Uploads specific metadata for a given node.

metadataType valid values are described in NodeData::MetadataType.

Parameters
fileThe metadata file path.
nodeThe handle of the node whose metadata will be uploaded.
metadataTypeThe type of the metadata that will be uploaded.
listenerThe listener that will handle every action event.
Returns
The listener's onActionFinish method will be provided with the finished action.
If any error occurred, the action's getError method may be used to retrieve such error.
  • E_SUCCESS is returned on success.
  • E_PARAMETERS is returned when some parameters are missing or the provided ones are not valid.
  • E_UNEXPECTED is returned when unexpected behavior occurs.
Otherwise, the action's getNode method may be used to retrieve the node whose metadata has been updated.
The returned action type corresponds to UPLOAD_METADATA.

◆ uploadToRecord()

void iberbox::Iberbox::uploadToRecord ( const std::string &  file,
ActionListenerType  listener = nullptr 
)

Uploads a file to a record.

Parameters
fileThe local filesystem path to the file to be uploaded.
listenerThe listener that will handle every action event.
Returns
The listener's onActionFinish method will be provided with the finished action.
If any error occurred, the action's getError method may be used to retrieve such error.
  • E_SUCCESS is returned on success.
  • E_PARAMETERS is returned when some parameters are missing or the provided ones are not valid.
  • E_UNEXPECTED is returned when unexpected behavior occurs.
The returned action type corresponds to UPLOAD_TO_RECORD.

◆ uploadWithCustomData()

void iberbox::Iberbox::uploadWithCustomData ( const std::string &  file,
NodeHandle  parent,
const std::string &  customData,
ActionListenerType  listener = nullptr 
)

Uploads a file or folder to a specific folder, associating application data to the transfer.

Parameters
fileThe path to the file in the client filesystem.
parentThe handler of the parent node in which the file will be uploaded.
customDataCustom data set by the app that can be accessed using getCustomData in callbacks.
listenerThe listener that will handle every action event.
Returns
The listener's onActionFinish method will be provided with the finished action.
If any error occurred, the action's getError method may be used to retrieve such error.
  • E_SUCCESS is returned on success.
  • E_PARAMETERS is returned when some parameters are missing or the provided ones are not valid.
  • E_UNEXPECTED is returned when unexpected behavior occurs.
Otherwise, the action's getNode method may be used to retrieve the uploaded file or root folder node.
The returned action type corresponds to UPLOAD.

◆ verifyEmail()

void iberbox::Iberbox::verifyEmail ( const std::string &  email,
const std::string &  firstName,
const std::string &  lastName,
ActionListenerType  listener = nullptr 
)

Verifies if an email already exists alongside a first name and last name.

A registration identifier will be returned and a 6-digit verification code will be sent to the email address. Both will be needed in order to use createAccount method.

Parameters
emailThe email to be verified.
firstNameThe first name of the account owner whose email will be verified.
lastNameThe last name of the account owner whose email will be verified.
listenerThe listener that will handle every action event.
Returns
The listener's onActionFinish method will be provided with the finished action.
If any error occurred, the action's getError method may be used to retrieve such error.
  • E_SUCCESS is returned on success.
  • E_PARAMETERS is returned when some parameters are missing or the provided ones are not valid.
  • E_UNEXPECTED is returned when unexpected behavior occurs.
  • E_DUPLICATE is returned when the given email has already been registered.
Otherwise, the action's getText method may be used to retrieve the registration identifier.
The returned action type corresponds to VERIFY_EMAIL.

◆ verifyHash()

void iberbox::Iberbox::verifyHash ( const std::string  base64Hash,
const std::string  filePath,
ActionListenerType  listener = nullptr 
)

Verifies if a given hash corresponds to a specific file.

The file hash is calculated using BLAKE2 hash function.

Parameters
base64HashBase64 formatted file hash obtained from any cloud file node.
filePathThe path to the file whose hash will be verified against base64Hash.
listenerThe listener that will handle every action event.
Returns
The listener's onActionFinish method will be provided with the finished action.
If any error occurred, the action's getError method may be used to retrieve such error.
  • E_SUCCESS is returned on success.
  • E_PARAMETERS is returned when some parameters are missing or the provided ones are not valid.
  • E_UNEXPECTED is returned when unexpected behavior occurs.
Otherwise, the action's getIntValue method may be used to retrieve the hashes comparison result, being 0 the value corresponding to both hashes matching.
The returned action type corresponds to VERIFY_HASH.

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