iberbox
2.1.2
|
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 ®istrationId, 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 ®istrationId, 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 ®istrationId, 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 ®istrationId, 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... | |
The Iberbox class.
The SortOrderType enum.
This enumeration specifies the different ways of sorting a node list or in general any array-like object.
iberbox::Iberbox::Iberbox | ( | TaskManagerType | taskManager = nullptr , |
IberboxSettingsType | settings = nullptr |
||
) |
Iberbox default constructor.
taskManager | The task manager. |
settings | The settings. |
|
virtual |
~Iberbox default destructor
void iberbox::Iberbox::addActionListener | ( | ActionListenerType | listener | ) |
Adds a new action listener.
listener | The listener that will handle every action event. |
listener's
onActionFinish method will be provided with the finished action.void iberbox::Iberbox::addBankTransferAsPaymentMethod | ( | ActionListenerType | listener = nullptr | ) |
Adds bank transfer as a payment method for the currently logged-in user's account.
listener | The listener that will handle every action event. |
listener's
onActionFinish method will be provided with the finished action.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.
account | The handle of the account to be added as a contact. |
contactName | The alias name to be given to the contact. |
listener | The listener that will handle every action event. |
listener's
onActionFinish method will be provided with the finished action.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.
iban | The international bank account number. |
holder | The bank account holder. |
listener | The listener that will handle every action event. |
listener's
onActionFinish method will be provided with the finished action.void iberbox::Iberbox::addEventListener | ( | EventListenerType | listener | ) |
Adds a new event listener.
listener | The listener that will handle every action event. |
listener's
onActionFinish method will be provided with the finished action.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.
code | The reseller's code. |
listener | The listener that will handle every action event. |
listener's
onActionFinish method will be provided with the finished action.void iberbox::Iberbox::archiveSharedDrive | ( | NodeHandle | sharedDrive, |
ActionListenerType | listener = nullptr |
||
) |
Archives an owned shared drive removing every permission to other accounts.
// TODO:
sharedDrive | The handle of the shared drive to be archived. |
listener | The listener that will handle every action event. |
void iberbox::Iberbox::authorizeBackup | ( | NodeHandle | backupId, |
ActionListenerType | listener = nullptr |
||
) |
Authorizes an existing backup.
backupId | The handle of the node representing the backup to authorize. |
listener | The listener that will handle every action event. |
listener's
onActionFinish method will be provided with the finished action.void iberbox::Iberbox::cancelTransferByTag | ( | int | tag, |
ActionListenerType | listener = nullptr |
||
) |
Cancels the transfer identified by tag
.
tag | The identifier of the transfer that will be canceled. |
listener | The listener that will handle every action event. |
listener's
onActionFinish method will be provided with the finished action.void iberbox::Iberbox::cancelTransfers | ( | ActionListenerType | listener = nullptr | ) |
Cancels every transfer.
listener | The listener that will handle every action event. |
listener's
onActionFinish method will be provided with the finished action.void iberbox::Iberbox::cancelTransfersByType | ( | int | type, |
ActionListenerType | listener = nullptr |
||
) |
Cancels every transfer that meets the type
filter.
type | The transfer type which the list of transfers will be filtered with. |
listener | The listener that will handle every action event. |
listener's
onActionFinish method will be provided with the finished action.void iberbox::Iberbox::changeBackupPath | ( | NodeHandle | backupId, |
const std::string & | localPath, | ||
ActionListenerType | listener = nullptr |
||
) |
Changes the path of a specified backup.
backupId | The handle of the node representing the backup whose path will be changed. |
localPath | The new path in the local filesystem to be set in the specified backup. |
listener | The listener that will handle every action event. |
listener's
onActionFinish method will be provided with the finished action.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 | | | | | * * * * *
backupId | The handle of the node representing the backup whose schedule will be changed. |
startTime | The new start time from which the snapshots will start being created. |
cronExpr | The cron expression of the interval between one snapshot and another. |
listener | The listener that will handle every action event. |
listener's
onActionFinish method will be provided with the finished action.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.
backupId | The handle of the node representing the backup whose status will be changed. |
status | The new status to be set. |
listener | The listener that will handle every action event. |
listener's
onActionFinish method will be provided with the finished action.void iberbox::Iberbox::changePassword | ( | const std::string & | password, |
ActionListenerType | listener = nullptr |
||
) |
Changes the password of the currently logged-in user.
password | The new password to be set. |
listener | The listener that will handle every action event. |
listener's
onActionFinish method will be provided with the finished action.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.
link | The link to be checked. |
The email of the receiver of the invitation. | |
listener | The listener that will handle every action event. |
listener's
onActionFinish method will be provided with the finished action.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.
password | |
listener | The listener that will handle every action event. |
listener's
onActionFinish method will be provided with the finished action.void iberbox::Iberbox::checkUpdate | ( | const std::string & | appName, |
int | version, | ||
ActionListenerType | listener = nullptr |
||
) |
appName | |
version | |
listener | The listener that will handle every action event. |
listener's
onActionFinish method will be provided with the finished action.void iberbox::Iberbox::clearFinishedTransferByTag | ( | int | tag, |
ActionListenerType | listener = nullptr |
||
) |
Clears the transfer identified by tag
if it has finished.
tag | The identifier of the transfer that will be cleared if it has finished. |
listener | The listener that will handle every action event. |
listener's
onActionFinish method will be provided with the finished action.void iberbox::Iberbox::clearFinishedTransfers | ( | ActionListenerType | listener = nullptr | ) |
Clears every finished transfer.
listener | The listener that will handle every action event. |
listener's
onActionFinish method will be provided with the finished action.void iberbox::Iberbox::clearFinishedTransfersByType | ( | int | type, |
ActionListenerType | listener = nullptr |
||
) |
Clears every finished transfer that meets the type
filter.
type | The transfer type which the list of transfers will be filtered with. |
listener | The listener that will handle every action event. |
listener's
onActionFinish method will be provided with the finished action.void iberbox::Iberbox::closeSecret | ( | NodeHandle | secretHandle, |
ActionListenerType | listener = nullptr |
||
) |
Closes a secret space given its handle.
secretHandle | The handle of the secret space that will be closed. |
listener | The listener that will handle every action event. |
listener's
onActionFinish method will be provided with the finished action.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.
node | The handle of the node that will be copied. |
parent | The handle of the node from which the node will descend. |
listener | The listener that will handle every action event. |
listener's
onActionFinish method will be provided with the finished action.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.
registrationId | The registration identifier. |
name | The name of the user. |
lastName | The last name of the user. |
The email that the user will use to log in. | |
password | The password that the user will use to log in. |
pin | The 6-digit email verification code. This code cannot be 0. |
listener | The listener that will handle every action event. |
listener's
onActionFinish method will be provided with the finished action.registrationId
and the provided email
.pin
does not match the emailed one.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.
coupon | The discount coupon. |
listener | The listener that will handle every action event. |
listener's
onActionFinish method will be provided with the finished action.coupon
does not exist or is no longer valid.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.
registrationId | The registration identifier. |
name | The name of the user. |
lastName | The last name of the user. |
The email that the user will use to log in. | |
password | The password that the user will use to log in. |
pin | The 6-digit email verification code. This code cannot be 0. |
coupon | The discount coupon. |
listener | The listener that will handle every action event. |
listener's
onActionFinish method will be provided with the finished action.registrationId
and the provided email
.pin
does not match the emailed one.coupon
does not exist or is no longer valid.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.
registrationId | The registration identifier. |
name | The name of the user. |
lastName | The last name of the user. |
The email that the user will use to log in. | |
password | The password that the user will use to log in. |
pin | The 6-digit email verification code. This code cannot be 0. |
coupon | The discount coupon. |
planId | The plan identifier. |
listener | The listener that will handle every action event. |
listener's
onActionFinish method will be provided with the finished action.registrationId
and the provided email
.pin
does not match the emailed one.coupon
does not exist or is no longer valid.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 | | | | | * * * * *
name | The name that will be given to the backup. |
startTime | The start time from which the snapshots will start being created. |
cronExpr | The cron expression of the interval between one snapshot and another. |
localPath | The local path that will be backed up. |
maxSnapshots | The maximum number of the backup snapshots to be kept. |
status | The initial status of the backup. |
listener | The listener that will handle every action event. |
listener's
onActionFinish method will be provided with the finished action.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
.
parent | The handler of the node from which the new folder will descend. |
name | The name of the folder that will be created. |
listener | The listener that will handle every action event. |
listener's
onActionFinish method will be provided with the finished action.void iberbox::Iberbox::createInbox | ( | const std::string & | name, |
const std::string & | message, | ||
ActionListenerType | listener = nullptr |
||
) |
Creates a new inbox for electronic record management.
name | The name of the inbox. |
message | The description of the inbox. |
listener | The listener that will handle every action event. |
listener's
onActionFinish method will be provided with the finished action.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
The email of the receiver of the invitation. | |
listener | The listener that will handle every action event. |
listener's
onActionFinish method will be provided with the finished action.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
The email of the receiver of the invitation. | |
accessLevel | Access level granted to the user. Valid values are:
|
listener | The listener that will handle every action event. |
listener's
onActionFinish method will be provided with the finished action.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.
node | The node whose |
listener | The listener that will handle every action event. |
listener's
onActionFinish method will be provided with the finished action.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.
The email of the coupon's beneficiary. | |
listener | The listener that will handle every action event. |
listener's
onActionFinish method will be provided with the finished action.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.
planId | The identifier of the plan that the coupon will be valid for. |
The email of the coupon's beneficiary. | |
listener | The listener that will handle every action event. |
listener's
onActionFinish method will be provided with the finished action.void iberbox::Iberbox::createSecret | ( | const std::string & | name, |
const std::string & | password, | ||
ActionListenerType | listener = nullptr |
||
) |
Creates a secret space with the specified credentials.
name | The name of the new secret space. |
password | The password of the new secret space. |
listener | The listener that will handle every action event. |
listener's
onActionFinish method will be provided with the finished action.void iberbox::Iberbox::createSharedDrive | ( | const std::string & | name, |
ActionListenerType | listener = nullptr |
||
) |
Creates a shared drive with the specified name.
name | The name of the new shared drive. |
listener | The listener that will handle every action event. |
listener's
onActionFinish method will be provided with the finished action.void iberbox::Iberbox::createSharedDriveLink | ( | NodeHandle | node, |
int | accessLevel, | ||
ActionListenerType | listener = nullptr |
||
) |
Creates a link to a specified shared drive node
.
node | The shared drive node to share |
accessLevel | The access level to apply to the link. This parameter is only valid for shared drive links. Valid values are:
|
listener | The listener that will handle every action event. |
listener's
onActionFinish method will be provided with the finished action.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".
parent | The handle of the "parent" shared drive. |
name | The name of the new shared drive. |
listener | The listener that will handle every action event. |
listener's
onActionFinish method will be provided with the finished action.void iberbox::Iberbox::currentEmail | ( | ActionListenerType | listener = nullptr | ) |
Gets the email of the currently logged-in user.
listener | The listener that will handle every action event. |
listener's
onActionFinish method will be provided with the finished action.void iberbox::Iberbox::deauthorizeBackup | ( | NodeHandle | backupId, |
ActionListenerType | listener = nullptr |
||
) |
Deauthorizes an existing backup.
backupId | The handle of the node representing the backup to deauthorize. |
listener | The listener that will handle every action event. |
listener's
onActionFinish method will be provided with the finished action.void iberbox::Iberbox::deleteAccount | ( | const std::string & | reason, |
ActionListenerType | listener = nullptr |
||
) |
Deletes the current account.
reason | Reason to delete the account. It can be an empty string. |
listener | The listener that will handle every action event. |
listener's
onActionFinish method will be provided with the finished action.void iberbox::Iberbox::deleteBackup | ( | NodeHandle | backupId, |
ActionListenerType | listener = nullptr |
||
) |
Deletes an existing backup.
backupId | The handle of the node representing the backup to be removed. |
listener | The listener that will handle every action event. |
listener's
onActionFinish method will be provided with the finished action.void iberbox::Iberbox::deleteCoupon | ( | int | id, |
ActionListenerType | listener = nullptr |
||
) |
Deletes a coupon given its identifier.
id | The coupon identifier. |
listener | The listener that will handle every action event. |
listener's
onActionFinish method will be provided with the finished action.void iberbox::Iberbox::deleteDevice | ( | NodeHandle | deviceId, |
ActionListenerType | listener = nullptr |
||
) |
Deletes the deviced identified by deviceId
.
deviceId | The handle of the node that uniquely identifies the requested device. |
listener | The listener that will handle every action event. |
listener's
onActionFinish method will be provided with the finished action.void iberbox::Iberbox::deleteLink | ( | const std::string & | link, |
ActionListenerType | listener = nullptr |
||
) |
Deletes a public link.
link | Link to delete |
listener | The listener that will handle every action event. |
listener's
onActionFinish method will be provided with the finished action.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.
node | |
listener | The listener that will handle every action event. |
listener's
onActionFinish method will be provided with the finished action.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.
node | |
listener | The listener that will handle every action event. |
listener's
onActionFinish method will be provided with the finished action.void iberbox::Iberbox::deleteSecret | ( | NodeHandle | secretHandle, |
ActionListenerType | listener = nullptr |
||
) |
Deletes a secret space given its handle.
secretHandle | The handle of the secret to be deleted. |
listener | The listener that will handle every action event. |
listener's
onActionFinish method will be provided with the finished action.void iberbox::Iberbox::deleteSharedDrive | ( | NodeHandle | sharedDrive, |
ActionListenerType | listener = nullptr |
||
) |
Deletes a shared drive given its handle.
sharedDrive | The handle of the shared drive to be deleted. |
listener | The listener that will handle every action event. |
listener's
onActionFinish method will be provided with the finished action.void iberbox::Iberbox::disable2fa | ( | int | code, |
ActionListenerType | listener = nullptr |
||
) |
Disables the 2FA method for the currently logged-in user.
code | A code generated with any TOTP generator using the URL generated after calling generate2faUrl. |
listener | The listener that will handle every action event. |
listener's
onActionFinish method will be provided with the finished action.void iberbox::Iberbox::download | ( | NodeHandle | node, |
const std::string & | parent, | ||
ActionListenerType | listener = nullptr |
||
) |
Downloads a file or folder to a specific local filesystem directory.
node | The node handler of the file or folder to be downloaded. |
parent | The path to the local filesystem where the node will be downloaded. |
listener | The listener that will handle every action event. |
listener's
onActionFinish method will be provided with the finished action.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
.
invoiceId | The identifier of the invoice to be downloaded. |
path | The path where the invoice file will be written to. |
listener | The listener that will handle every action event. |
listener's
onActionFinish method will be provided with the finished action.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.
link | The public link to a file or folder hosted by an iberbox account. |
parent | The path to the folder where the file or folder will be downloaded. |
listener | The listener that will handle every action event. |
listener's
onActionFinish method will be provided with the finished action.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.
link | The public link to a file or folder hosted by an iberbox account. |
parent | The path to the folder where the file or folder will be downloaded. |
customData | Custom data set by the app that can be accessed using getCustomData in callbacks. |
listener | The listener that will handle every action event. |
listener's
onActionFinish method will be provided with the finished action.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.
node | The handle of the node whose metadata will be downloaded. |
metadataType | The type of the metadata that will be downloaded. |
parent | The file path where to download the metadata. |
listener | The listener that will handle every action event. |
listener's
onActionFinish method will be provided with the finished action.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.
metadataInfo | The public metadata info of a node. |
metadataType | The type of the metadata that will be downloaded. |
parent | The file path where to download the metadata. |
listener | The listener that will handle every action event. |
listener's
onActionFinish method will be provided with the finished action.void iberbox::Iberbox::downloadUpdate | ( | const std::string & | appName, |
int | version, | ||
const std::string & | downloadFolder, | ||
const std::string & | installFolder, | ||
ActionListenerType | listener = nullptr |
||
) |
downloadUpdate
appName | |
version | |
downloadFolder | |
installFolder | |
listener | The listener that will handle every action event. |
listener's
onActionFinish method will be provided with the finished action.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.
node | The node handler of the file or folder to be downloaded. |
parent | The path to the local filesystem where the node will be downloaded. |
customData | Custom data set by the app that can be accessed using getCustomData in callbacks. |
listener | The listener that will handle every action event. |
listener's
onActionFinish method will be provided with the finished action.void iberbox::Iberbox::downloadZip | ( | NodeHandle | node, |
const std::string & | parent, | ||
ActionListenerType | listener = nullptr |
||
) |
Generates a downloadable zipped file or folder.
node | The handle of the file or folder node. |
parent | The path to the local filesystem where the zip file will be downloaded. |
listener | The listener that will handle every action event. |
listener's
onActionFinish method will be provided with the finished action.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.
node | The handle of the file or folder node. |
parent | The path to the local filesystem where the zip file will be downloaded. |
listener | The listener that will handle every action event. |
customData | Custom data set by the app that can be accessed using getCustomData in callbacks. |
listener's
onActionFinish method will be provided with the finished action.void iberbox::Iberbox::enable2fa | ( | int | code, |
ActionListenerType | listener = nullptr |
||
) |
Enables the 2FA method for the currently logged-in user.
code | A code generated with any TOTP generator using the URL generated after calling generate2faUrl. |
listener | The listener that will handle every action event. |
listener's
onActionFinish method will be provided with the finished action.
|
static |
Initializes the crash manager and enables the crash handler.
callback | The callback that will handle every crash in the app. |
void iberbox::Iberbox::finishRecord | ( | ActionListenerType | listener = nullptr | ) |
Finishes the creation of a record.
listener | The listener that will handle every action event. |
listener's
onActionFinish method will be provided with the finished action.void iberbox::Iberbox::finishRecordWithRecipient | ( | const std::string & | recipient, |
ActionListenerType | listener = nullptr |
||
) |
Finishes the creation of a record and sends its link to the recipient
.
recipient | The email address the record link will be sent to. |
listener | The listener that will handle every action event. |
listener's
onActionFinish method will be provided with the finished action.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.
The email address used to login into the account whose password has been forgotten. | |
listener | The listener that will handle every action event. |
listener's
onActionFinish method will be provided with the finished action.email
.void iberbox::Iberbox::generate2faUrl | ( | ActionListenerType | listener = nullptr | ) |
Generates the 2FA URL for the currently logged-in user.
Reference here.
listener | The listener that will handle every action event. |
listener's
onActionFinish method will be provided with the finished action.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
appName | |
version | |
platform | |
updateFolder | |
updateUrl | |
changelog | |
outputFile | |
privateKey | |
listener | The listener that will handle every action event. |
listener's
onActionFinish method will be provided with the finished action.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.
listener | The listener that will handle every action event. |
listener's
onActionFinish method will be provided with the finished action.void iberbox::Iberbox::getAccountInfo | ( | ActionListenerType | listener = nullptr | ) |
Gets the info of the currently logged-in user account.
listener | The listener that will handle every action event. |
listener's
onActionFinish method will be provided with the finished action.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.
page | The page of the log to retrieve. Page size is defined in the server. |
listener | The listener that will handle every action event. |
listener's
onActionFinish method will be provided with the finished action.void iberbox::Iberbox::getActiveBackups | ( | ActionListenerType | listener = nullptr | ) |
Gets every active backup of the devices owned by the currently logged-in user.
listener | The listener that will handle every action event. |
listener's
onActionFinish method will be provided with the finished action.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
.
backupId | The handle of the node that uniquely identifies the requested backup. |
listener | The listener that will handle every action event. |
listener's
onActionFinish method will be provided with the finished action.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
.
deviceId | The handle of the node that uniquely identifies the requested device. |
name | The name that uniquely identifies the requested backup. |
listener | The listener that will handle every action event. |
listener's
onActionFinish method will be provided with the finished action.void iberbox::Iberbox::getBackups | ( | NodeHandle | deviceId, |
ActionListenerType | listener = nullptr |
||
) |
Gets every backup of a specific device identified by deviceId
.
deviceId | The handle of the node that uniquely identifies the requested device. |
listener | The listener that will handle every action event. |
listener's
onActionFinish method will be provided with the finished action.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.
listener | The listener that will handle every action event. |
listener's
onActionFinish method will be provided with the finished action.void iberbox::Iberbox::getChildFiles | ( | NodeHandle | id, |
ActionListenerType | listener = nullptr |
||
) |
Gets every direct descendant file of a specified node using default sort order.
id | The handle of the node whose children will be returned. |
listener | The listener that will handle every action event. |
listener's
onActionFinish method will be provided with the finished action.void iberbox::Iberbox::getChildFolders | ( | NodeHandle | id, |
ActionListenerType | listener = nullptr |
||
) |
Gets every direct descendant folder of a specified node using default sort order.
id | The handle of the node whose children will be returned. |
listener | The listener that will handle every action event. |
listener's
onActionFinish method will be provided with the finished action.void iberbox::Iberbox::getChildren | ( | NodeHandle | id, |
ActionListenerType | listener = nullptr |
||
) |
Gets every direct descendant of a specified node using default sort order.
id | The handle of the node whose children will be returned. |
listener | The listener that will handle every action event. |
listener's
onActionFinish method will be provided with the finished action.void iberbox::Iberbox::getCouponInfo | ( | const std::string & | coupon, |
ActionListenerType | listener = nullptr |
||
) |
Gets the information of a given coupon.
coupon | |
listener | The listener that will handle every action event. |
listener's
onActionFinish method will be provided with the finished action.void iberbox::Iberbox::getCurrentDevice | ( | ActionListenerType | listener = nullptr | ) |
Gets the current device from which the desktop app has been launched.
listener | The listener that will handle every action event. |
listener's
onActionFinish method will be provided with the finished action.void iberbox::Iberbox::getDeviceById | ( | NodeHandle | deviceId, |
ActionListenerType | listener = nullptr |
||
) |
Gets the requested device.
The requested device is uniquely identified by its deviceId
.
deviceId | The handle of the node that uniquely identifies the requested device. |
listener | The listener that will handle every action event. |
listener's
onActionFinish method will be provided with the finished action.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
.
name | The unique name that identifies the requested device owned by the currently logged-in user. |
listener | The listener that will handle every action event. |
listener's
onActionFinish method will be provided with the finished action.void iberbox::Iberbox::getDevices | ( | ActionListenerType | listener = nullptr | ) |
Gets every device owned by the currently logged-in user.
listener | The listener that will handle every action event. |
listener's
onActionFinish method will be provided with the finished action.void iberbox::Iberbox::getDownloadSpeedLimit | ( | ActionListenerType | listener = nullptr | ) |
Gets the download speed limit using kbps unit.
listener | The listener that will handle every action event. |
listener's
onActionFinish method will be provided with the finished action.void iberbox::Iberbox::getExternalInbox | ( | ActionListenerType | listener = nullptr | ) |
Get an external inbox to send records to users without an Iberbox account.
listener | The listener that will handle every action event. |
listener's
onActionFinish method will be provided with the finished action.void iberbox::Iberbox::getInboxInfo | ( | const std::string & | inboxLink, |
ActionListenerType | listener = nullptr |
||
) |
Gets the information related to a given inbox by its public link.
inboxLink | The public link pointing to a specific inbox. |
listener | The listener that will handle every action event. |
listener's
onActionFinish method will be provided with the finished action.void iberbox::Iberbox::getInvoicingInfo | ( | ActionListenerType | listener = nullptr | ) |
Gets the invoicing information of the currently logged-in user.
listener | The listener that will handle every action event. |
listener's
onActionFinish method will be provided with the finished action.void iberbox::Iberbox::getLastSnapshots | ( | ActionListenerType | listener = nullptr | ) |
Gets the last created snapshots of every backup in the current device.
listener | The listener that will handle every action event. |
listener's
onActionFinish method will be provided with the finished action.void iberbox::Iberbox::getLastSnapshotsForAccount | ( | ActionListenerType | listener = nullptr | ) |
Gets the last created snapshots for the account of the currently logged-in user.
listener | The listener that will handle every action event. |
listener's
onActionFinish method will be provided with the finished action.void iberbox::Iberbox::getLastSnapshotsForBackup | ( | NodeHandle | backupId, |
int | count, | ||
ActionListenerType | listener = nullptr |
||
) |
Gets the n (count
) latest created snapshots of a given backup.
backupId | The handle of the node representing a backup. |
count | The amount of snapshots to be returned. |
listener | The listener that will handle every action event. |
listener's
onActionFinish method will be provided with the finished action.void iberbox::Iberbox::getLastSnapshotsForDevice | ( | NodeHandle | deviceId, |
ActionListenerType | listener = nullptr |
||
) |
Gets the last created snapshots of every backup in the specified device.
deviceId | |
listener | The listener that will handle every action event. |
listener's
onActionFinish method will be provided with the finished action.void iberbox::Iberbox::getLinkInfo | ( | const std::string & | link, |
ActionListenerType | listener = nullptr |
||
) |
Gets the node which the link
points to.
link | The link whose info is requested. |
listener | The listener that will handle every action event. |
listener's
onActionFinish method will be provided with the finished action.link
points to and getName method to retrieve such node's name.
|
static |
Get the active log level Possible log levels are specified by the LogLevelType enum:
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.
sharedDrive | The handle of the shared drive that will handle the meeting. |
listener | The listener that will handle every action event. |
listener's
onActionFinish method will be provided with the finished action.void iberbox::Iberbox::getNextSnapshots | ( | ActionListenerType | listener = nullptr | ) |
Gets next scheduled snapshots of every backup in the current device.
listener | The listener that will handle every action event. |
listener's
onActionFinish method will be provided with the finished action.void iberbox::Iberbox::getNextSnapshotsForAccount | ( | ActionListenerType | listener = nullptr | ) |
Gets the next scheduled snapshots of every backup in the account of the currently logged-in user.
listener | The listener that will handle every action event. |
listener's
onActionFinish method will be provided with the finished action.void iberbox::Iberbox::getNextSnapshotsForBackup | ( | NodeHandle | backupId, |
int | count, | ||
ActionListenerType | listener = nullptr |
||
) |
Gets n (count
) next scheduled snapshots for a given backup.
backupId | The handle of the node representing a backup. |
count | The amount of snapshots to be returned. |
listener | The listener that will handle every action event. |
listener's
onActionFinish method will be provided with the finished action.void iberbox::Iberbox::getNextSnapshotsForDevice | ( | NodeHandle | deviceId, |
ActionListenerType | listener = nullptr |
||
) |
Gets next scheduled snapshots of every backup in a given device.
deviceId | The handle of the node representing a device. |
listener | The listener that will handle every action event. |
listener's
onActionFinish method will be provided with the finished action.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 | | | | | * * * * *
startTime | The time from where to start taking the cron expression into consideration. |
cronExpr | The cron expression for scheduling snapshots. |
count | The amount of timestamps to be returned. |
listener | The listener that will handle every action event. |
listener's
onActionFinish method will be provided with the finished action.void iberbox::Iberbox::getNodeById | ( | NodeHandle | id, |
ActionListenerType | listener = nullptr |
||
) |
Gets a node given its node handle.
id | The handle of the requested node. |
listener | The listener that will handle every action event. |
listener's
onActionFinish method will be provided with the finished action.void iberbox::Iberbox::getNodeByPath | ( | const std::string & | path, |
ActionListenerType | listener = nullptr |
||
) |
Gets a node given its path.
path | The path of the requested node. |
listener | The listener that will handle every action event. |
listener's
onActionFinish method will be provided with the finished action.void iberbox::Iberbox::getNodePath | ( | NodeHandle | id, |
ActionListenerType | listener = nullptr |
||
) |
Gets the path of a given node.
id | The handle of the node whose path will be returned. |
listener | The listener that will handle every action event. |
listener's
onActionFinish method will be provided with the finished action.void iberbox::Iberbox::getNodes | ( | ActionListenerType | listener = nullptr | ) |
Get the cloud root node.
listener | The listener that will handle every action event. |
listener's
onActionFinish method will be provided with the finished action.void iberbox::Iberbox::getNoticeCredentials | ( | ActionListenerType | listener = nullptr | ) |
Gets the email account credentials in order to send notices.
listener | The listener that will handle every action event. |
listener's
onActionFinish method will be provided with the finished action.void iberbox::Iberbox::getOpenSecrets | ( | ActionListenerType | listener = nullptr | ) |
Gets every open secret space within the account of the currently logged-in user.
listener | The listener that will handle every action event. |
listener's
onActionFinish method will be provided with the finished action.void iberbox::Iberbox::getPaymentInfo | ( | int | subscriptionId, |
ActionListenerType | listener = nullptr |
||
) |
Gets the information related to the payment of a given subscription.
subscriptionId | The identifier of the subscription. |
listener | The listener that will handle every action event. |
listener's
onActionFinish method will be provided with the finished action.void iberbox::Iberbox::getPublicAccountInfo | ( | AccountHandle | account, |
ActionListenerType | listener = nullptr |
||
) |
Gets the public info of an account given its handle.
account | Account handle |
listener | The listener that will handle every action event. |
listener's
onActionFinish method will be provided with the finished action.void iberbox::Iberbox::getPublicAccountInfoByLink | ( | const std::string & | link, |
ActionListenerType | listener = nullptr |
||
) |
Gets the public info of the account associated to an account link.
link | Account link |
listener | The listener that will handle every action event. |
listener's
onActionFinish method will be provided with the finished action.void iberbox::Iberbox::getPublicUserInfo | ( | UserHandle | user, |
ActionListenerType | listener = nullptr |
||
) |
Gets the public info of a user given its handle.
user | user handle |
listener | The listener that will handle every action event. |
listener's
onActionFinish method will be provided with the finished action.void iberbox::Iberbox::getRecordInfo | ( | const std::string & | recordLink, |
ActionListenerType | listener = nullptr |
||
) |
Gets the information of a record given its public link.
recordLink | |
listener | The listener that will handle every action event. |
listener's
onActionFinish method will be provided with the finished action.void iberbox::Iberbox::getRecoveryKey | ( | ActionListenerType | listener = nullptr | ) |
Gets the recovery key of the currently logged-in user.
listener | The listener that will handle every action event. |
listener's
onActionFinish method will be provided with the finished action.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.
listener | The listener that will handle every action event. |
listener's
onActionFinish method will be provided with the finished action.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:
type | The type of root node to be returned. |
listener | The listener that will handle every action event. |
listener's
onActionFinish method will be provided with the finished action.void iberbox::Iberbox::getRootNodes | ( | ActionListenerType | listener = nullptr | ) |
Gets every root node in the filesystem.
Root nodes are those that have:
listener | The listener that will handle every action event. |
listener's
onActionFinish method will be provided with the finished action.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.
secretHandle | The handle of the secret space whose recovery key is being returned. |
listener | The listener that will handle every action event. |
listener's
onActionFinish method will be provided with the finished action.void iberbox::Iberbox::getSessionInfo | ( | ActionListenerType | listener = nullptr | ) |
Gets the information of the active and inactive sessions.
listener | The listener that will handle every action event. |
listener's
onActionFinish method will be provided with the finished action.void iberbox::Iberbox::getSharedDriveInfo | ( | NodeHandle | sharedDrive, |
ActionListenerType | listener = nullptr |
||
) |
Gets information of a specific shared node given its handle.
sharedDrive | |
listener | The listener that will handle every action event. |
listener's
onActionFinish method will be provided with the finished action.void iberbox::Iberbox::getSharedDrives | ( | ActionListenerType | listener = nullptr | ) |
Gets every shared drive within the account of the currently logged-in user.
listener | The listener that will handle every action event. |
listener's
onActionFinish method will be provided with the finished action.void iberbox::Iberbox::getSnapshots | ( | NodeHandle | backupId, |
ActionListenerType | listener = nullptr |
||
) |
Gets every snapshot of a given backup.
backupId | The handle of the node representing the backup whose snapshots will be returned. |
listener | The listener that will handle every action event. |
listener's
onActionFinish method will be provided with the finished action.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.
id | The handle of the node whose children will be returned. |
sortOrder | The order in which the returned node list will be sorted. |
listener | The listener that will handle every action event. |
listener's
onActionFinish method will be provided with the finished action.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.
id | The handle of the node whose children will be returned. |
sortOrder | The order in which the returned node list will be sorted. |
listener | The listener that will handle every action event. |
listener's
onActionFinish method will be provided with the finished action.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.
id | The handle of the node whose children will be returned. |
sortOrder | The order in which the returned node list will be sorted. |
listener | The listener that will handle every action event. |
listener's
onActionFinish method will be provided with the finished action.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.
listener | The listener that will handle every action event. |
listener's
onActionFinish method will be provided with the finished action.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.
features | Required features as a bitmap. |
listener | The listener that will handle every action event. |
listener's
onActionFinish method will be provided with the finished action.void iberbox::Iberbox::getTransfers | ( | ActionListenerType | listener = nullptr | ) |
Gets all the transfers.
listener | The listener that will handle every action event. |
listener's
onActionFinish method will be provided with the finished action.void iberbox::Iberbox::getTransfersByStatus | ( | int | type, |
int | status, | ||
ActionListenerType | listener = nullptr |
||
) |
Gets every transfer that meets the type
and status
filter.
type | The transfer type which the list of transfers will be filtered with. |
status | The transfer status which the list of transfers will be filtered with. |
listener | The listener that will handle every action event. |
listener's
onActionFinish method will be provided with the finished action.void iberbox::Iberbox::getTransfersByType | ( | int | type, |
ActionListenerType | listener = nullptr |
||
) |
Gets every finished transfer that meets the type
filter.
type | The transfer type which the list of transfers will be filtered with. |
listener | The listener that will handle every action event. |
listener's
onActionFinish method will be provided with the finished action.void iberbox::Iberbox::getUnfinishedTransfers | ( | int | type, |
ActionListenerType | listener = nullptr |
||
) |
Gets every unfinished transfer that meets the type
filer.
type | The transfer type which the list of transfers will be filtered with. |
listener | The listener that will handle every action event. |
listener's
onActionFinish method will be provided with the finished action.void iberbox::Iberbox::getUploadSpeedLimit | ( | ActionListenerType | listener = nullptr | ) |
Gets the upload speed limit using kbps unit.
listener | The listener that will handle every action event. |
listener's
onActionFinish method will be provided with the finished action.void iberbox::Iberbox::getUserInfo | ( | ActionListenerType | listener = nullptr | ) |
Gets the info of the currently logged-in user.
listener | The listener that will handle every action event. |
listener's
onActionFinish method will be provided with the finished action.
|
static |
Releases global resources.
|
static |
Initializes global resources.
appId | The identifier of the app. |
appVersion | The version of the app. |
void iberbox::Iberbox::installUpdate | ( | const std::string & | appName, |
int | version, | ||
const std::string & | downloadFolder, | ||
const std::string & | installFolder, | ||
ActionListenerType | listener = nullptr |
||
) |
installUpdate
appName | |
version | |
downloadFolder | |
installFolder | |
listener | The listener that will handle every action event. |
listener's
onActionFinish method will be provided with the finished action.void iberbox::Iberbox::inviteEmail | ( | const std::string & | email, |
ActionListenerType | listener = nullptr |
||
) |
Sends an invitation email to the given address.
The email address of the recipient of the invitation. | |
listener | The listener that will handle every action event. |
listener's
onActionFinish method will be provided with the finished action.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.
account | The handle of the account the currently logged-in user will have access to. |
accountKey | The master key of the account the currently logged-in user will have access to. |
registrationId | The registration identifier obtained after calling checkJoinLink. |
name | The name of the user. |
lastName | The last name of the user. |
The email that the user will use to log in. | |
password | The password that the user will use to log in. |
pin | The 6-digit email verification code obtained after calling checkJoinLink. |
listener | The listener that will handle every action event. |
listener's
onActionFinish method will be provided with the finished action.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.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.
account | The handle of the account the currently logged-in user will have access to. |
accountKey | The master key of the account the currently logged-in user will have access to. |
listener | The listener that will handle every action event. |
listener's
onActionFinish method will be provided with the finished action.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.void iberbox::Iberbox::logEvent | ( | int | eventId, |
ActionListenerType | listener = nullptr |
||
) |
Logs an event given its identifier.
The eventId
must be in the range: [4000, 9000]
eventId | The identifier of the event to log. |
listener | The listener that will handle every action event. |
listener's
onActionFinish method will be provided with the finished action.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]
eventId | The identifier of the event to log. |
message | The message to include in the event log. |
listener | The listener that will handle every action event. |
listener's
onActionFinish method will be provided with the finished action.void iberbox::Iberbox::login | ( | const std::string & | login, |
const std::string & | password, | ||
ActionListenerType | listener = nullptr |
||
) |
Performs account 1FA login using login
and password
credentials.
login | The email of the account used to log in. |
password | The password of the account used to log in. |
listener | The listener that will handle every action event. |
listener's
onActionFinish method will be provided with the finished action.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.
login | The email of the account used to log in. |
password | The password of the account used to log in. |
code | A code generated with any TOTP generator using the account's secret key. |
listener | The listener that will handle every action event. |
listener's
onActionFinish method will be provided with the finished action.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.
login | The email of the account used to log in. |
password | The password of the account used to log in. |
account | The handle of the account to which the login action will be performed. |
listener | The listener that will handle every action event. |
listener's
onActionFinish method will be provided with the finished action.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.
login | The email of the account used to log in. |
password | The password of the account used to log in. |
code | A code generated with any TOTP generator using the account's secret key. |
accountHandle | The handle of the account to which the login action will be performed. |
listener | The listener that will handle every action event. |
listener's
onActionFinish method will be provided with the finished action.void iberbox::Iberbox::loginLink | ( | const std::string & | folderLink, |
ActionListenerType | listener = nullptr |
||
) |
loginLink
loginLink, 2. getNodes, 3. downloadZip
folderLink | |
listener | The listener that will handle every action event. |
listener's
onActionFinish method will be provided with the finished action.void iberbox::Iberbox::logout | ( | ActionListenerType | listener = nullptr | ) |
Performs a logout of the currently logged-in user.
listener | The listener that will handle every action event. |
listener's
onActionFinish method will be provided with the finished action.void iberbox::Iberbox::logoutLink | ( | ActionListenerType | listener = nullptr | ) |
logoutLink
listener | The listener that will handle every action event. |
listener's
onActionFinish method will be provided with the finished action.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 | | | | | * * * * *
backupId | The handle of the node representing the backup to modify. |
name | The name that will be given to the backup. |
startTime | The start time from which the snapshots will start being created. |
cronExpr | The cron expression of the interval between one snapshot and another. |
localPath | The local path that will be backed up. |
maxSnapshots | The maximum number of the backup snapshots to be kept. |
status | The initial status of the backup. |
listener | The listener that will handle every action event. |
listener's
onActionFinish method will be provided with the finished action.void iberbox::Iberbox::modifyContact | ( | NodeHandle | contact, |
const std::string & | contactName, | ||
ActionListenerType | listener = nullptr |
||
) |
Modifies the alias name of a previously added contact.
contact | The handle of the contact to be modified. |
contactName | The new name to be given to the contact. |
listener | The listener that will handle every action event. |
listener's
onActionFinish method will be provided with the finished action.void iberbox::Iberbox::modifySavedInbox | ( | NodeHandle | outbox, |
const std::string & | outboxName, | ||
ActionListenerType | listener = nullptr |
||
) |
Modifies the alias name of a previously added outbox.
outbox | The handle of the outbox to be updated. |
outboxName | The new name to be given to the outbox. |
listener | The listener that will handle every action event. |
listener's
onActionFinish method will be provided with the finished action.void iberbox::Iberbox::moveNode | ( | NodeHandle | node, |
NodeHandle | parent, | ||
ActionListenerType | listener = nullptr |
||
) |
Changes the parent node of another node.
node | The handle of the node whose parent will be changed. |
parent | The handle of the new parent of the node . |
listener | The listener that will handle every action event. |
listener's
onActionFinish method will be provided with the finished action.void iberbox::Iberbox::nestSharedDrive | ( | NodeHandle | sharedDrive, |
NodeHandle | parent, | ||
ActionListenerType | listener = nullptr |
||
) |
void iberbox::Iberbox::newSession | ( | ActionListenerType | listener = nullptr | ) |
Creates a new session.
The returned session string will be required by resumeSession.
listener | The listener that will handle every action event. |
listener's
onActionFinish method will be provided with the finished action.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.
accountHandle | The handle of the account for which the new session will be created. |
listener | The listener that will handle every action event. |
listener's
onActionFinish method will be provided with the finished action.
|
overridevirtual |
The method that will be executed when the action finishes.
action | The finished action. |
Reimplemented from iberbox::ActionListener.
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).
name | The name of the secret space to be opened. |
password | The password of the secret space to be opened. |
listener | The listener that will handle every action event. |
listener's
onActionFinish method will be provided with the finished action.void iberbox::Iberbox::readLink | ( | const std::string & | link, |
unsigned long | startPositon, | ||
unsigned long | size, | ||
ActionListenerType | listener = nullptr |
||
) |
readLink
link | |
startPositon | |
size | |
listener | The listener that will handle every action event. |
listener's
onActionFinish method will be provided with the finished action.void iberbox::Iberbox::readNode | ( | NodeHandle | file, |
unsigned long | startPositon, | ||
unsigned long | size, | ||
ActionListenerType | listener = nullptr |
||
) |
readNode
file | |
startPositon | |
size | |
listener | The listener that will handle every action event. |
listener's
onActionFinish method will be provided with the finished action.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.
recoveryId | The recovery id obtained after using forgotPassword method. |
login | The email of the account to be recovered. |
recoveryKey | The recovery key of the account to be recovered. |
pin | The pin sent to the account's email address after using forgotPassword method. |
listener | The listener that will handle every action event. |
listener's
onActionFinish method will be provided with the finished action.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.
recoveryId | The recovery id obtained after using forgotPassword method. |
login | The email of the account to be recovered. |
recoveryKey | The recovery key of the account to be recovered. |
pin | The pin sent to the account's email address after using forgotPassword method. |
code | The 2FA One-Time Password the user obtained from their Authenticator app. |
listener | The listener that will handle every action event. |
listener's
onActionFinish method will be provided with the finished action.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.
recoveryKey | The recovery key of the secret to be recovered. |
newName | The new name the secret to be recovered will be given. |
newPassword | The new password the secret to be recovered will be given. |
listener | The listener that will handle every action event. |
listener's
onActionFinish method will be provided with the finished action.void iberbox::Iberbox::registerDevice | ( | const std::string & | name, |
ActionListenerType | listener = nullptr |
||
) |
Registers a new device in the account of the currently logged-in user.
name | The name of the new device to be created. |
listener | The listener that will handle every action event. |
listener's
onActionFinish method will be provided with the finished action.void iberbox::Iberbox::removeActionListener | ( | ActionListenerType | listener | ) |
Removes a previously added action listener.
listener | The listener that will handle every action event. |
listener's
onActionFinish method will be provided with the finished action.void iberbox::Iberbox::removeContact | ( | NodeHandle | contact, |
ActionListenerType | listener = nullptr |
||
) |
Removes a contact from the current account.
contact | The handle of the contact to be removed. |
listener | The listener that will handle every action event. |
listener's
onActionFinish method will be provided with the finished action.void iberbox::Iberbox::removeEventListener | ( | EventListenerType | listener | ) |
Removes a previously added event listener.
listener | The listener that will handle every action event. |
listener's
onActionFinish method will be provided with the finished action.void iberbox::Iberbox::removeFromRecord | ( | NodeHandle | fileHandle, |
ActionListenerType | listener = nullptr |
||
) |
Removes a file from a record given its node handle.
fileHandle | The handle of the node representing the file to be removed. |
listener | The listener that will handle every action event. |
listener's
onActionFinish method will be provided with the finished action.void iberbox::Iberbox::removePaymentMethod | ( | ActionListenerType | listener = nullptr | ) |
Removes the configured payment method for the account of the currently logged-in user.
listener | The listener that will handle every action event. |
listener's
onActionFinish method will be provided with the finished action.void iberbox::Iberbox::removeProxy | ( | ActionListenerType | listener = nullptr | ) |
Disables the current active proxy server configuration.
listener | The listener that will handle every action event. |
listener's
onActionFinish method will be provided with the finished action.void iberbox::Iberbox::removeRecord | ( | ActionListenerType | listener = nullptr | ) |
Removes a record from...
listener | The listener that will handle every action event. |
listener's
onActionFinish method will be provided with the finished action.void iberbox::Iberbox::removeSavedInbox | ( | NodeHandle | outbox, |
ActionListenerType | listener = nullptr |
||
) |
Removes an outbox from the current account.
outbox | The handle of the outbox to be removed. |
listener | The listener that will handle every action event. |
listener's
onActionFinish method will be provided with the finished action.void iberbox::Iberbox::renameBackup | ( | NodeHandle | backupId, |
const std::string & | newName, | ||
ActionListenerType | listener = nullptr |
||
) |
Renames a specified backup.
backupId | The handle of the node representing the backup whose name will be changed. |
newName | The new name to be set in the specified backup. |
listener | The listener that will handle every action event. |
listener's
onActionFinish method will be provided with the finished action.void iberbox::Iberbox::renameDevice | ( | NodeHandle | deviceId, |
const std::string & | newName, | ||
ActionListenerType | listener = nullptr |
||
) |
Set a new name to the device identified by deviceId
.
deviceId | The handle of the node that uniquely identifies the requested device. |
newName | The new name to be set to the requested device. |
listener | The listener that will handle every action event. |
listener's
onActionFinish method will be provided with the finished action.newName
.void iberbox::Iberbox::renameNode | ( | NodeHandle | node, |
const std::string & | name, | ||
ActionListenerType | listener = nullptr |
||
) |
Sets a new name to the specified node.
node | The handle of the node that will be renamed. |
name | The new name to be set to the specified node. |
listener | The listener that will handle every action event. |
listener's
onActionFinish method will be provided with the finished action.void iberbox::Iberbox::resumeRecord | ( | const std::string & | newRecordLink, |
ActionListenerType | listener = nullptr |
||
) |
Resumes the creation of a record.
newRecordLink | The record creation link. |
listener | The listener that will handle every action event. |
listener's
onActionFinish method will be provided with the finished action.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.
session | The JWT string representing the session. |
listener | The listener that will handle every action event. |
listener's
onActionFinish method will be provided with the finished action.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.
user | The handle of the user whose access to the current account will be revoked. |
listener | The listener that will handle every action event. |
listener's
onActionFinish method will be provided with the finished action.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.
listener | The listener that will handle every action event. |
listener's
onActionFinish method will be provided with the finished action.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.
contact | The handle of the contact whom the inbox belongs to. |
inboxLink | The public link of the inbox to be saved. |
outboxName | An alias name to be given to the specified inbox. |
listener | The listener that will handle every action event. |
listener's
onActionFinish method will be provided with the finished action.void iberbox::Iberbox::saveSentRecord | ( | NodeHandle | outbox, |
const std::string & | recordLink, | ||
ActionListenerType | listener = nullptr |
||
) |
outbox | |
recordLink | |
listener | The listener that will handle every action event. |
listener's
onActionFinish method will be provided with the finished action.void iberbox::Iberbox::selectDevice | ( | NodeHandle | deviceId, |
ActionListenerType | listener = nullptr |
||
) |
Selects a given device from the account of the currently logged-in user.
deviceId | The handle of the node representing the device to be selected. |
listener | The listener that will handle every action event. |
listener's
onActionFinish method will be provided with the finished action.void iberbox::Iberbox::sendCrashReport | ( | const std::string & | file, |
ActionListenerType | listener = nullptr |
||
) |
sendCrashReport
file | |
listener | The listener that will handle every action event. |
listener's
onActionFinish method will be provided with the finished action.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.
user | The handle of the user. |
accessLevel | The new access level to be set. |
listener | The listener that will handle every action event. |
listener's
onActionFinish method will be provided with the finished action.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.
cryptoScheme | Default crypto scheme for the account Currently, the available options are:
|
listener | The listener that will handle every action event. |
listener's
onActionFinish method will be provided with the finished action.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.
url | The URL of the proxy server (protocol://ip:port). |
user | The user credential for the server connection. |
password | The password credential for the server connection. |
listener | The listener that will handle every action event. |
listener's
onActionFinish method will be provided with the finished action.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.
account | The handle of the account the currently logged-in user will have access to. |
listener | The listener that will handle every action event. |
listener's
onActionFinish method will be provided with the finished action.void iberbox::Iberbox::setDownloadSpeedLimit | ( | int | kbps, |
ActionListenerType | listener = nullptr |
||
) |
Sets the download speed limit setting.
kbps | The new value to be set using kbps unit. |
listener | The listener that will handle every action event. |
listener's
onActionFinish method will be provided with the finished action.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.
from | The contact who registers the record. |
to | The email of the contact that should receive the record |
subject | The subject of the record. |
message | The message of the record. |
listener | The listener that will handle every action event. |
listener's
onActionFinish method will be provided with the finished action.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.
inboxHandle | The handle of the node representing the inbox to modify. |
name | The new name for the given inbox. |
message | The new description for the given inbox. |
listener | The listener that will handle every action event. |
listener's
onActionFinish method will be provided with the finished action.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.
companyName | The bussiness name. |
companyAddress | The address line 1. |
companyAddress2 | The address line 2 (optional). |
companyID | The company identifier. |
listener | The listener that will handle every action event. |
listener's
onActionFinish method will be provided with the finished action.
|
static |
Set the active log level Possible log levels are specified by the LogLevelType enum:
logLevel | Log level to apply |
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.
node | The handle of the node that will be modified. |
tag | The new tag to be set to the specified node. |
listener | The listener that will handle every action event. |
listener's
onActionFinish method will be provided with the finished action.void iberbox::Iberbox::setProxy | ( | const std::string & | url, |
ActionListenerType | listener = nullptr |
||
) |
Sets up an unauthenticated proxy server.
url | The URL of the proxy server (protocol://ip:port). |
listener | The listener that will handle every action event. |
listener's
onActionFinish method will be provided with the finished action.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.
contactInfo | The email of the contact who registers the record. |
subject | The subject of the record. |
message | The message of the record. |
listener | The listener that will handle every action event. |
listener's
onActionFinish method will be provided with the finished action.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.
record | The handle of the record whose status is to be set. |
status | The new status to be set. |
listener | The listener that will handle every action event. |
listener's
onActionFinish method will be provided with the finished action.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.
subscriptionId | The identifier of the subscription that will be configured for the current account. |
listener | The listener that will handle every action event. |
listener's
onActionFinish method will be provided with the finished action.void iberbox::Iberbox::setUploadSpeedLimit | ( | int | kbps, |
ActionListenerType | listener = nullptr |
||
) |
Sets the upload speed limit setting.
kbps | The new value to be set using kbps unit. |
listener | The listener that will handle every action event. |
listener's
onActionFinish method will be provided with the finished action.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
sharedDrive | The handle of the drive to be shared. |
account | The handle of the account the drive will be shared with. |
listener | The listener that will handle every action event. |
listener's
onActionFinish method will be provided with the finished action.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.
sharedDrive | The handle of the drive to be shared. |
account | The handle of the account the drive will be shared with. |
accessLevel | The access level granted to the account. Valid values are:
|
listener | The listener that will handle every action event. |
listener's
onActionFinish method will be provided with the finished action.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
sharedDrive | The handle of the drive to be shared. |
accountLink | The link of the account the drive will be shared with. |
listener | The listener that will handle every action event. |
listener's
onActionFinish method will be provided with the finished action.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.
sharedDrive | The handle of the drive to be shared. |
accountLink | The link of the account the drive will be shared with. |
accessLevel | The access level granted to the account. Valid values are:
|
listener | The listener that will handle every action event. |
listener's
onActionFinish method will be provided with the finished action.void iberbox::Iberbox::startRecord | ( | const std::string & | inboxLink, |
ActionListenerType | listener = nullptr |
||
) |
Starts a new record in an inbox.
inboxLink | The public link pointing to a specific inbox. |
listener | The listener that will handle every action event. |
listener's
onActionFinish method will be provided with the finished action.int iberbox::Iberbox::test | ( | ) |
void iberbox::Iberbox::testProxy | ( | const std::string & | url, |
const std::string & | user, | ||
const std::string & | password, | ||
ActionListenerType | listener = nullptr |
||
) |
testProxy
url | |
user | |
password | |
listener | The listener that will handle every action event. |
listener's
onActionFinish method will be provided with the finished action.void iberbox::Iberbox::testRequest | ( | ActionListenerType | listener = nullptr | ) |
testRequest
listener | The listener that will handle every action event. |
listener's
onActionFinish method will be provided with the finished action.void iberbox::Iberbox::toggleFolderSync | ( | NodeHandle | node, |
ActionListenerType | listener = nullptr |
||
) |
Toggle the sync flag of a folder.
Only folders may hold this value.
node | The handle of the node that will be modified. |
listener | The listener that will handle every action event. |
listener's
onActionFinish method will be provided with the finished action.void iberbox::Iberbox::unarchiveSharedDrive | ( | NodeHandle | sharedDrive, |
ActionListenerType | listener = nullptr |
||
) |
unarchiveSharedDrive
// TODO:
sharedDrive | |
listener |
void iberbox::Iberbox::unnestSharedDrive | ( | NodeHandle | sharedDrive, |
ActionListenerType | listener = nullptr |
||
) |
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.
sharedDrive | The handle of the shared drive to be unshared. |
account | The handle of the account the drive will be unshared with. |
listener | The listener that will handle every action event. |
listener's
onActionFinish method will be provided with the finished action.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.
secretHandle | The handle of the secret space to be updated. |
name | The new name for the secret space. |
password | The new password for the secret space. |
listener | The listener that will handle every action event. |
listener's
onActionFinish method will be provided with the finished action.void iberbox::Iberbox::upload | ( | const std::string & | file, |
NodeHandle | parent, | ||
ActionListenerType | listener = nullptr |
||
) |
Uploads a file or folder to a specific folder.
file | The path to the file in the client filesystem. |
parent | The handler of the parent node in which the file will be uploaded. |
listener | The listener that will handle every action event. |
listener's
onActionFinish method will be provided with the finished action.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.
file | The metadata file path. |
node | The handle of the node whose metadata will be uploaded. |
metadataType | The type of the metadata that will be uploaded. |
listener | The listener that will handle every action event. |
listener's
onActionFinish method will be provided with the finished action.void iberbox::Iberbox::uploadToRecord | ( | const std::string & | file, |
ActionListenerType | listener = nullptr |
||
) |
Uploads a file to a record.
file | The local filesystem path to the file to be uploaded. |
listener | The listener that will handle every action event. |
listener's
onActionFinish method will be provided with the finished action.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.
file | The path to the file in the client filesystem. |
parent | The handler of the parent node in which the file will be uploaded. |
customData | Custom data set by the app that can be accessed using getCustomData in callbacks. |
listener | The listener that will handle every action event. |
listener's
onActionFinish method will be provided with the finished action.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.
The email to be verified. | |
firstName | The first name of the account owner whose email will be verified. |
lastName | The last name of the account owner whose email will be verified. |
listener | The listener that will handle every action event. |
listener's
onActionFinish method will be provided with the finished action.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.
base64Hash | Base64 formatted file hash obtained from any cloud file node. |
filePath | The path to the file whose hash will be verified against base64Hash . |
listener | The listener that will handle every action event. |
listener's
onActionFinish method will be provided with the finished action.