Table of Contents

TTMSFNCCloudMicrosoftOneDrive Class

Component that connects to a Microsoft OneDrive 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: TMSFNCCloudMicrosoftOneDrive Inherits from: TTMSFNCCustomCloudMicrosoftOneDrive

Syntax

TTMSFNCCloudMicrosoftOneDrive = class(TTMSFNCCustomCloudMicrosoftOneDrive)

Remarks

Drop this component on a form, configure the authentication settings, then call the operation methods. Publishes the options and events declared by TTMSFNCCustomCloudMicrosoftOneDrive.

Properties

Name Description
Info Account information for the connected user, populated by GetAccountInfo. (inherited from TTMSFNCCustomCloudMicrosoftOneDrive)
Language Preferred language used by the service for localized responses. (inherited from TTMSFNCCustomCloudMicrosoftOneDrive)
PromiseFileInfo Read-only item holding the file metadata retrieved by the most recent promise-based file-info request. (inherited from TTMSFNCCustomCloudMicrosoftOneDrive)

Methods

Name Description
CreateFolder Creates a new folder. (inherited from TTMSFNCCustomCloudMicrosoftOneDrive)
CreateFolderPromise Promise-based variant of CreateFolder. (inherited from TTMSFNCCustomCloudMicrosoftOneDrive)
Delete Deletes an item. (inherited from TTMSFNCCustomCloudMicrosoftOneDrive)
Download Downloads an item to a local file. (inherited from TTMSFNCCustomCloudMicrosoftOneDrive)
GetAccountInfo Requests the connected account's information, raising OnGetAccountInfo when the result is available. (inherited from TTMSFNCCustomCloudMicrosoftOneDrive)
GetAccountInfoPromise Promise-based variant of GetAccountInfo. (inherited from TTMSFNCCustomCloudMicrosoftOneDrive)
GetDriveInfo Requests the account drive information by listing the root folder, raising OnGetFolderList when the result is available. (inherited from TTMSFNCCustomCloudMicrosoftOneDrive)
GetFileByID Retrieves a single item by its provider identifier. (inherited from TTMSFNCCustomCloudMicrosoftOneDrive)
GetFileInfo Requests metadata for a single file, raising OnGetFileInfo when the result is available. (inherited from TTMSFNCCustomCloudMicrosoftOneDrive)
GetFolderInfo Requests metadata for a single folder, raising OnGetFileInfo when the result is available. (inherited from TTMSFNCCustomCloudMicrosoftOneDrive)
GetFolderList Lists the immediate contents of a folder. (inherited from TTMSFNCCustomCloudMicrosoftOneDrive)
GetFolderListHierarchical Lists a folder and recursively its sub-folders. (inherited from TTMSFNCCustomCloudMicrosoftOneDrive)
GetFolderListHierarchicalPromise Promise-based variant of GetFolderListHierarchical. (inherited from TTMSFNCCustomCloudMicrosoftOneDrive)
GetFolderListPromise Promise-based variant of GetFolderList. (inherited from TTMSFNCCustomCloudMicrosoftOneDrive)
GetShare Requests a public share URL for an item, raising OnGetShare when the URL is available. (inherited from TTMSFNCCustomCloudMicrosoftOneDrive)
GetSharePromise Promise-based variant of GetShare. (inherited from TTMSFNCCustomCloudMicrosoftOneDrive)
GetTestTokensResult Determines whether a token-test request succeeded. (inherited from TTMSFNCCustomCloudMicrosoftOneDrive)
MoveFile Moves an item into a target folder. (inherited from TTMSFNCCustomCloudMicrosoftOneDrive)
MoveFileToRoot Moves an item to the account root. (inherited from TTMSFNCCustomCloudMicrosoftOneDrive)
RenameFile Renames an item. (inherited from TTMSFNCCustomCloudMicrosoftOneDrive)
Search Searches the account for items matching a query. (inherited from TTMSFNCCustomCloudMicrosoftOneDrive)
SearchList Searches a folder for items matching a query and returns the result list. (inherited from TTMSFNCCustomCloudMicrosoftOneDrive)
SearchListPromise Promise-based variant of SearchList. (inherited from TTMSFNCCustomCloudMicrosoftOneDrive)
SearchPromise Promise-based variant of Search. (inherited from TTMSFNCCustomCloudMicrosoftOneDrive)
TestTokens Validates the current access token by requesting the connected drive. (inherited from TTMSFNCCustomCloudMicrosoftOneDrive)
Upload Uploads a local file into a folder. (inherited from TTMSFNCCustomCloudMicrosoftOneDrive)

Events

Name Description
OnCreateFolder Occurs when a folder has been created. (inherited from TTMSFNCCustomCloudMicrosoftOneDrive)
OnDeleteItem Occurs when a delete operation has finished. (inherited from TTMSFNCCustomCloudMicrosoftOneDrive)
OnDownloadFile Occurs when a download has finished. (inherited from TTMSFNCCustomCloudMicrosoftOneDrive)
OnGetAccountInfo Occurs when the account information has been retrieved. (inherited from TTMSFNCCustomCloudMicrosoftOneDrive)
OnGetFileInfo Occurs when metadata for a single file has been retrieved. (inherited from TTMSFNCCustomCloudMicrosoftOneDrive)
OnGetFolderList Occurs when a folder listing returns its items. (inherited from TTMSFNCCustomCloudMicrosoftOneDrive)
OnGetLink Occurs when a download link has been retrieved. (inherited from TTMSFNCCustomCloudMicrosoftOneDrive)
OnGetShare Occurs when a public share URL has been retrieved. (inherited from TTMSFNCCustomCloudMicrosoftOneDrive)
OnMoveFile Occurs when a file or folder has been moved. (inherited from TTMSFNCCustomCloudMicrosoftOneDrive)
OnRenameFile Occurs when a file or folder has been renamed. (inherited from TTMSFNCCustomCloudMicrosoftOneDrive)
OnSearch Occurs when a search request completes, exposing the matched items. (inherited from TTMSFNCCustomCloudMicrosoftOneDrive)
OnUploadFile Occurs when an upload has finished. (inherited from TTMSFNCCustomCloudMicrosoftOneDrive)
OneDrive Read-only root collection holding the items retrieved from the account. (inherited from TTMSFNCCustomCloudMicrosoftOneDrive)