TTMSFNCCloudDropBox Class
Component that connects to a DropBox account and provides file and folder management, including listing, search, upload, download, delete, move, rename, folder creation, and link or share generation.
API unit family: TMSFNCCloudDropBox
Inherits from: TTMSFNCCustomCloudDropBox
Syntax
TTMSFNCCloudDropBox = class(TTMSFNCCustomCloudDropBox)
Remarks
Drop this component on a form, configure the authentication settings, then call the operation methods. Publishes the options and events declared by TTMSFNCCustomCloudDropBox.
Properties
| Name | Description |
|---|---|
| DDrive | Read-only root collection holding the items retrieved from the account. (inherited from TTMSFNCCustomCloudDropBox) |
| FileLimit | Maximum number of items returned when listing a folder. (inherited from TTMSFNCCustomCloudDropBox) |
| Info | Account information for the connected user, populated by GetAccountInfo and GetDriveInfo. (inherited from TTMSFNCCustomCloudDropBox) |
| Language | Preferred language used by the service for localized responses. (inherited from TTMSFNCCustomCloudDropBox) |
| Mode | Root scope the component operates against. (inherited from TTMSFNCCustomCloudDropBox) |
| PromiseFileInfo | Read-only item holding the file metadata retrieved by the most recent promise-based file-info request. (inherited from TTMSFNCCustomCloudDropBox) |
| UploadMode | Behavior applied when an uploaded file name already exists at the destination. (inherited from TTMSFNCCustomCloudDropBox) |
Methods
| Name | Description |
|---|---|
| CreateFolder | Creates a new folder. (inherited from TTMSFNCCustomCloudDropBox) |
| CreateFolderPromise | Promise-based variant of CreateFolder. (inherited from TTMSFNCCustomCloudDropBox) |
| Delete | Deletes an item. (inherited from TTMSFNCCustomCloudDropBox) |
| Download | Downloads an item to a local file. (inherited from TTMSFNCCustomCloudDropBox) |
| DownloadFolderAsZip | Downloads a folder and its contents as a single ZIP archive. (inherited from TTMSFNCCustomCloudDropBox) |
| GetAccountInfo | Requests the connected account's information, raising OnGetCurrentAccount when the result is available. (inherited from TTMSFNCCustomCloudDropBox) |
| GetAccountInfoPromise | Promise-based variant of GetAccountInfo. (inherited from TTMSFNCCustomCloudDropBox) |
| GetDriveInfo | Requests the account's storage usage, raising OnGetSpaceUsage when the result is available. (inherited from TTMSFNCCustomCloudDropBox) |
| GetFileByID | Retrieves a single item by its provider identifier. (inherited from TTMSFNCCustomCloudDropBox) |
| GetFileInfo | Requests metadata for a single file, raising OnGetFileInfo when the result is available. (inherited from TTMSFNCCustomCloudDropBox) |
| GetFileInfoPromise | Promise-based variant of GetFileInfo. (inherited from TTMSFNCCustomCloudDropBox) |
| GetFolderInfo | Requests the contents of a folder, raising OnGetFolderInfo when the request finishes. (inherited from TTMSFNCCustomCloudDropBox) |
| GetFolderInfoPromise | Promise-based variant of GetFolderInfo. (inherited from TTMSFNCCustomCloudDropBox) |
| GetFolderList | Lists the immediate contents of a folder. (inherited from TTMSFNCCustomCloudDropBox) |
| GetFolderListHierarchical | Lists a folder and recursively its sub-folders. (inherited from TTMSFNCCustomCloudDropBox) |
| GetFolderListHierarchicalPromise | Promise-based variant of GetFolderListHierarchical. (inherited from TTMSFNCCustomCloudDropBox) |
| GetFolderListPromise | Promise-based variant of GetFolderList. (inherited from TTMSFNCCustomCloudDropBox) |
| GetLink | Requests a temporary download link for an item, raising OnGetLink when the link is available. (inherited from TTMSFNCCustomCloudDropBox) |
| GetLinkPromise | Promise-based variant of GetLink. (inherited from TTMSFNCCustomCloudDropBox) |
| GetShare | Requests a public share URL for an item, raising OnGetShare when the URL is available. (inherited from TTMSFNCCustomCloudDropBox) |
| GetSharePromise | Promise-based variant of GetShare. (inherited from TTMSFNCCustomCloudDropBox) |
| GetTestTokensResult | Determines whether a token-test request succeeded. (inherited from TTMSFNCCustomCloudDropBox) |
| MoveFile | Moves an item into a target folder. (inherited from TTMSFNCCustomCloudDropBox) |
| MoveFileToRoot | Moves an item to the account root. (inherited from TTMSFNCCustomCloudDropBox) |
| RenameFile | Renames an item. (inherited from TTMSFNCCustomCloudDropBox) |
| Search | Searches a folder for items matching a query. (inherited from TTMSFNCCustomCloudDropBox) |
| SearchList | Searches for items matching a query and returns the result list. (inherited from TTMSFNCCustomCloudDropBox) |
| SearchListPromise | Promise-based variant of SearchList. (inherited from TTMSFNCCustomCloudDropBox) |
| SearchPromise | Promise-based variant of Search. (inherited from TTMSFNCCustomCloudDropBox) |
| Test | Runs a built-in connectivity check against a sample account path. (inherited from TTMSFNCCustomCloudDropBox) |
| TestTokens | Validates the current access token by requesting the connected account. (inherited from TTMSFNCCustomCloudDropBox) |
| Upload | Uploads a local file into a folder. (inherited from TTMSFNCCustomCloudDropBox) |
Events
| Name | Description |
|---|---|
| OnCreateFolder | Occurs when a folder has been created. (inherited from TTMSFNCCustomCloudDropBox) |
| OnCreateShare | Occurs when a public share URL has been created. (inherited from TTMSFNCCustomCloudDropBox) |
| OnDeleteItem | Occurs when a delete operation has finished. (inherited from TTMSFNCCustomCloudDropBox) |
| OnDownloadFile | Occurs when a download has finished. (inherited from TTMSFNCCustomCloudDropBox) |
| OnGetCurrentAccount | Occurs when the current account information has been retrieved. (inherited from TTMSFNCCustomCloudDropBox) |
| OnGetFileInfo | Occurs when metadata for a single file has been retrieved. (inherited from TTMSFNCCustomCloudDropBox) |
| OnGetFolderInfo | Occurs when a folder-info request has finished. (inherited from TTMSFNCCustomCloudDropBox) |
| OnGetFolderList | Occurs when a folder listing returns its first page of items. (inherited from TTMSFNCCustomCloudDropBox) |
| OnGetFolderListComplete | Occurs when a folder listing has retrieved all items across all pages. (inherited from TTMSFNCCustomCloudDropBox) |
| OnGetLink | Occurs when a temporary download link has been retrieved. (inherited from TTMSFNCCustomCloudDropBox) |
| OnGetShare | Occurs when a public share URL has been retrieved. (inherited from TTMSFNCCustomCloudDropBox) |
| OnGetSpaceUsage | Occurs when account storage usage has been retrieved. (inherited from TTMSFNCCustomCloudDropBox) |
| OnMoveFile | Occurs when a file or folder has been moved. (inherited from TTMSFNCCustomCloudDropBox) |
| OnRenameFile | Occurs when a file or folder has been renamed. (inherited from TTMSFNCCustomCloudDropBox) |
| OnSearch | Occurs when a search request completes, exposing the matched items. (inherited from TTMSFNCCustomCloudDropBox) |
| OnUploadFile | Occurs when an upload has finished. (inherited from TTMSFNCCustomCloudDropBox) |