Table of Contents

TTMSFNCCustomCloudMicrosoftOneDrive Class

Base storage component that connects to a Microsoft OneDrive account and exposes file and folder operations such as listing, search, upload, download, delete, move, rename, folder creation, and link or share generation, with both synchronous and promise-based variants.

API unit family: TMSFNCCloudMicrosoftOneDrive Inherits from: TTMSFNCCustomCloudMicrosoftStorage

Syntax

TTMSFNCCustomCloudMicrosoftOneDrive = class(TTMSFNCCustomCloudMicrosoftStorage)

Remarks

This is the non-published base class; use the published TTMSFNCCloudMicrosoftOneDrive component on a form. Authentication is configured through the inherited authentication settings before any operation is called.

Properties

Name Description
Info Account information for the connected user, populated by GetAccountInfo.
PromiseFileInfo Read-only item holding the file metadata retrieved by the most recent promise-based file-info request.

Methods

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

Events

Name Description
OneDrive Read-only root collection holding the items retrieved from the account.