OneDrive Component

Properties   Methods   Events   Config Settings   Errors  

The OneDrive component makes it easy to upload, download, and manage files and folders within Microsoft OneDrive.

Syntax

TcsOneDrive

Remarks

The OneDrive component provides a simple interface to working with Microsoft OneDrive. Capabilities include uploading and downloading files, strong encryption support, creating folders, moving and copying resources, OneDrive for Business and SharePoint Online support, and more.

To begin, first create an account and register your application with the Microsoft Graph API. Consult the Microsoft Graph API documentation for instructions on this process.

Authentication

This component requires authentication via OAuth 2.0. First, perform OAuth authentication using the OAuth* properties to set the appropriate fields for the chosen OAuthClientProfile and OAuthGrantType.

The component has the following default OAuthServerAuthURL and OAuthServerTokenURL properties. Additionally, below is a common scope for the component:

Additionally, depending on how the application is registered (Ex. Multi-tenant) and what OAuthGrantType is selected (Ex. Client Credentials and Password), it may be required to use the tenant ID rather than "common" in the OAuthServerAuthURL and OAuthServerTokenURL properties. In the case of Client Credentials and Password grant types, it is also required to use the "default" scopes of the app registration. See below for examples of the modified URLs and scopes:

Below is a brief description of the different OAuthClientProfile and OAuthGrantType values that are supported by this component. For a more in-depth description of what needs to be set, refer to the service documentation.

Application Profile

This profile encompasses the most basic grant types that OAuth supports. When this profile is set, all the requests and response handling is done by the component. Depending on the grant type, this may involve launching a browser so a user can login to authenticate with a authorization server. It may also involve starting an embedded web server to receive a response from a redirect.

To start the authentication and authorization process, the Authorize method should be called. If the authorization and authentication was successful, then the OAuthAccessToken property will be populated. Additionally, if a refresh token was provided the OAuthRefreshToken property will be populated as well. These values of the fields are for informational purposes. The component will also cache these tokens along with when the OAuthAccessToken will be expired. When a method that makes requests to the service provider is called or the Authorize method is called the component will automatically check to see if the access token is expired. If it is, it will then automatically try to get a new OAuthAccessToken. If the Authorize method was not used and user interaction would be required, the component will throw an error which can be caught. When user interaction is needed depends on what grant type is set in the OAuthGrantType property. To force the component to only check the access token when the Authorize method is called, the OAuthAutomaticRefresh configuration setting can be set to false.

A brief description of the supported values for the OAuthGrantType property are below. For more information, see the service documentation.

Authorization Code

When using the Authorization Code grant type, the component will use an authorization code to get an access token. For this OAuthGrantType the component expects a OAuthClientId, OAuthClientSecret, OAuthServerAuthURL, and OAuthServerTokenURL to be set. When the Authorize method is called, the component will start the embedded web server and launch the browser so the user can authorize the application. Once the user authorizes, the service provider will redirect them to the embedded web server and the component will parse the authorization code, setting the OAuthAuthorizationCode property, from the redirect. Immediately, the component will make a request to the token server to exchange the authorization code for an access token. The token server will return an access token and possibly a refresh token. If the OAuthRefreshToken property is set, or a refresh token is cached, then the component will not launch the browser and use the refresh token in its request to the token server instead of an authorization code.

Example: Onedrive onedrive = new Onedrive(); onedrive.OAuth.ClientProfile = OAuthClientProfiles.cocpApplication; onedrive.OAuth.GrantType = OAuthGrantTypes.cogtAuthorizationCode; onedrive.OAuth.ClientId = CLIENT_ID; onedrive.OAuth.ClientSecret = CLIENT_SECRET; onedrive.OAuth.AuthorizationScope = "offline_access files.readwrite files.readwrite.all"; onedrive.Authorize();

Client Credentials

When using the Client Credentials grant type, the component will act as a service instead of authorizing and authenticating as a user. This allows for the component to avoid user interaction. This is typically used when running in an application that can not have user access. This grant type requires additional set up to be done in the service providers portal before it can be used. For this OAuthGrantType the component expects a OAuthClientId, OAuthClientSecret, and OAuthServerTokenURL to be set. When the Authorize method is called, the component will make a request to the token server for an access token. The token server will return an access token if the application has the authorization to do so. When this access token is expired, the component will automatically (see above for detailed description) make a new request to get a fresh one.

Implicit

Note: This grant type is considered insecure and should only be used when necessary.

When using the Implicit grant type, the component will request the authorization server to get an access token. For this OAuthGrantType the component expects a OAuthClientId, OAuthClientSecret, and OAuthServerAuthURL to be set. When the Authorize method is called, the component will start the embedded web server and launch the browser so the user can authorize the application. Once the user authorizes, the service provider will redirect them to the embedded web server and the component will parse the access token from the redirect.

A disadvantage of the grant type is that can not use a refresh token to silently get a new access token. Most service providers offer a way to silently get a new access token. See the service documentation for specifics. This means the component will not be able to automatically get a fresh token once it expires.

Password

Note: This grant type is considered insecure and should only be used when necessary.

When using the Resource Owner Password Credentials grant type, the component will authenticate as the resource owner. This allows for the component to avoid user interaction. This grant type often has specific limitations put on it by the service provider. See the service documentation for more details.

For this OAuthGrantType the component requires OAuthPasswordGrantUsername, OAuthClientSecret, and OAuthServerTokenURL to be set. The OAuthClientSecret should be set to the password of the account instead of a typical secret. In some cases, the OAuthClientId also needs to be set. When the Authorize method is called, the component will make a request to the token server for an access token using the username and password. The token server will return an access token if the authentication was successful. When this access token is expired, the component will automatically (see above for detailed description) make a new request to get a fresh one.

Web Profile

External OAuth Support

Bearer ACCESS_TOKEN_VALUE

Assign this value to the Authorization property before attempting any operations. Setting the Authorization property will cause the component to ignore the values set in the OAuth property.

For Example: Oauth oauth = new Oauth(); oauth.ClientId = "CLIENT_ID"; oauth.ClientSecret = "CLIENT_SECRET; oauth.ServerAuthURL = "https://login.microsoftonline.com/common/oauth2/v2.0/authorize"; oauth.ServerTokenURL = "https://login.microsoftonline.com/common/oauth2/v2.0/token"; oauth.AuthorizationScope = "offline_access files.readwrite files.readwrite.all"; oauth.GrantType = OauthGrantTypes.ogtAuthorizationCode; onedrive.Authorization = oauth.GetAuthorization(); Consult the documentation for the service for more information about supported scope values and more details on OAuth authentication.

Note: There are a couple of extra factors to consider when doing OAuth for OneDrive; please refer to the Authorization property documentation for more information.

Listing Resources

ListResources lists resources within the folder resource currently selected by RemoteId or RemotePath. Calling this method will fire the ResourceList event once for each resource, and will also populate the Resource* properties.

If there are still more resources available to list when this method returns, the ResourceMarker property will be populated. Continue to call this method until ResourceMarker is empty to accumulate all pages of results in the Resource* properties. // ResourceList event handler. onedrive.OnResourceList += (s, e) => { Console.WriteLine(e.Name); }; // (Assume that the RemoteId property isn't set; it takes precedence if it is.) onedrive.RemotePath = "/work_files/serious_business/cats"; do { onedrive.ListResources(); for (int i = 0; i < onedrive.Resources.Count; i++) { // Process resources here. } } while (!string.IsNullOrEmpty(onedrive.ResourceMarker));

Downloading Files

The DownloadFile method downloads the file resource currently selected by RemoteId or RemotePath.

If LocalFile is set, the file will be saved to the specified location; otherwise, the file data will be held by ResourceData.

To download and decrypt an encrypted file, set EncryptionAlgorithm and EncryptionPassword before calling this method.

Download Notes

In the simplest use-case, downloading a file looks like this: onedrive.LocalFile = "../MyFile.zip"; onedrive.RemoteId = onedrive.Resources[0].Id; onedrive.DownloadFile();

Resuming Downloads

The component also supports resuming failed downloads by using the StartByte property. If a download is interrupted, set StartByte to the appropriate offset before calling this method to resume the download. string downloadFile = "../MyFile.zip"; onedrive.LocalFile = downloadFile; onedrive.RemoteId = onedrive.Resources[0].Id; onedrive.DownloadFile(); //The transfer is interrupted and DownloadFile() above fails. Later, resume the download: //Get the size of the partially downloaded file onedrive.StartByte = new FileInfo(downloadFile).Length; onedrive.DownloadFile();

Resuming Encrypted File Downloads

Resuming encrypted file downloads is only supported when LocalFile was set in the initial download attempt.

If LocalFile is set when beginning an encrypted download, the component creates a temporary file in TempPath to hold the encrypted data until the download is complete. If the download is interrupted, DownloadTempFile will be populated with the path of the temporary file that holds the partial data.

To resume, DownloadTempFile must be populated, along with StartByte, to allow the remainder of the encrypted data to be downloaded. Once the encrypted data is downloaded it will be decrypted and written to LocalFile. onedrive.LocalFile = "../MyFile.zip"; onedrive.EncryptionPassword = "password"; onedrive.RemoteId = onedrive.Resources[0].Id; onedrive.DownloadFile(); //The transfer is interrupted and DownloadFile() above fails. Later, resume the download: //Get the size of the partially download temp file onedrive.StartByte = new FileInfo(onedrive.Config("DownloadTempFile")).Length; onedrive.DownloadFile();

Uploading Files

The UploadFile method uploads new file resources to the folder resource currently selected by RemoteId or RemotePath.

If LocalFile is set the file will be uploaded from the specified path. If LocalFile is not set the data in ResourceData will be used.

To encrypt the file before uploading it, set EncryptionAlgorithm and EncryptionPassword.

Upload Notes

OneDrive offers two ways to upload a file. For smaller files a simple upload option is provided to upload data in one request. This is the default option. For larger files, uploads can be fragmented into multiple pieces, allowing resuming of uploads that may be interrupted.

Simple

By default the component uses the simple upload mechanism. onedrive.LocalFile = "../MyFile.zip"; onedrive.UploadFile("MyFile.zip");

Resumable

To enable resumable uploads set UseResumableUpload to true. This is recommended for large files. The component will automatically fragment the specified file into smaller pieces and upload each individually. FragmentSize may be set to specify the size of the fragment if desired. The default fragment size is 10 MB.

When UseResumableUpload is set to true and UploadFile is called, a resumable upload session is started by the component. ResumeURL is populated with a URL identifying the session (this value may be needed for additional operations if the upload does not complete normally).

During a resumable upload, the FragmentComplete event fires after each fragment is uploaded to indicate overall progress. The component also updates StartByte as necessary to indicate the current offset in the file.

If the upload is interrupted for any reason, resuming it is easy. First, verify that ResumeURL and StartByte are populated (if the same instance of the component is used, they should already be populated, and no special action should be needed). Then call UploadFile again to resume the upload at the specified StartByte offset.

Note that if the upload is not resumed after some time the upload session will expire. PollUploadStatus may be used to check the status of a resumable upload, including when it will expire (which is stored in the UploadExpDate configuration setting). An interrupted upload can be aborted explicitly using the AbortUpload method. onedrive.LocalFile = "../MyFile.zip"; onedrive.UploadFile("MyFile.zip"); //The transfer is interrupted and UploadFile() above fails. Later, resume the download. //Using the same instance StartByte and ResumeURL are already populated from the previous //upload attempt. onedrive.UploadFile("MyFile.zip");

Additional Functionality

The OneDrive component offers advanced functionality beyond simple uploads and downloads. For instance:

• Encrypt and decrypt files using the EncryptionAlgorithm and EncryptionPassword properties.
• Basic file and folder manipulation and organization using methods such as CopyResource, CreateFolder, DeleteResource, MoveResource, and UpdateResource.
• Creation of resource sharing links using CreateLink.
• Change tracking with ListChanges.
• Advanced resource listing using the Search method.
• Support for OneDrive for Business and SharePoint Online functionality, including drive selection using ListDrives, Drive, and other API members.
• And more!

Property List

The following is the full list of the properties of the component with short descriptions. Click on the links for further details.

Method List

The following is the full list of the methods of the component with short descriptions. Click on the links for further details.

Event List

The following is the full list of the events fired by the component with short descriptions. Click on the links for further details.

Config Settings

The following is a list of config settings for the component with short descriptions. Click on the links for further details.

Authorization Property (OneDrive Component)

OAuth 2.0 Authorization Token.

Syntax

__property String Authorization = { read=FAuthorization, write=FSetAuthorization };

Default Value

""

Remarks

This component supports authentication via OAuth 2.0. First, perform OAuth authentication using the OAuth* properties, using the OAuth component or a separate process. If using the OAuth* properties, then the Authorization property will not be used. Once complete you should have an authorization string which looks like:

Bearer ACCESS_TOKEN

Authorization Notes

At this time, the most straightforward instructions available for registering an application for use with Microsoft Graph can be found on Register your app page of the Microsoft Graph API documentation. One of the steps on that page is selecting the application's supported account types. In most cases, the "Accounts in any organizational directory and personal Microsoft accounts" option is the most appropriate.

Once the application is registered, refer to the instructions on the Get access on behalf of a user page of the Microsoft Graph API documentation for information about what endpoints to use with the OAuth component for authentication. Pay special attention to the description of the possible value for the {tenent} segment of the OAuth endpoints.

The relevant OAuth scopes vary based on whether the application will use OneDrive (Personal), or OneDrive for Business and/or SharePoint Online.

• OneDrive (Personal): The Files.* scopes.
• OneDrive for Business / SharePoint Online: The Files.* and Sites.* scopes (to use the UsersGroups configuration setting, the Group.Read.All and/or Directory.Read.All scopes are also relevant).

Refer to the Microsoft Graph API's permissions documentation for more information about the OAuth scopes that Microsoft Graph supports.

Data Type

String

ChangeMarker Property (OneDrive Component)

A marker indicating what page of changes to return next.

Syntax

__property String ChangeMarker = { read=FChangeMarker, write=FSetChangeMarker };

Default Value

""

Remarks

This property will be populated when ListChanges is called if the results are paged and there are more pages. To list all changes, continue to call ListChanges until this property returns empty string.

Setting ChangeMarker will cause NextChangeMarker to be set to empty string.

Refer to ListChanges for more information.

This property is not available at design time.

Data Type

String

CopiedResourceId Property (OneDrive Component)

The Id of a newly-copied resource.

Syntax

__property String CopiedResourceId = { read=FCopiedResourceId };

Default Value

""

Remarks

This property reflects the Id of a newly-copied resource. It is populated after the PollCopyStatus method is called if the copy operation has completed successfully (or cleared if the copy operation is still in progress, or has failed).

This property is read-only and not available at design time.

Data Type

String

CopyPercentDone Property (OneDrive Component)

Progress percentage of a copy operation.

Syntax

__property String CopyPercentDone = { read=FCopyPercentDone };

Default Value

""

Remarks

This property reflects the progress of a copy operation, as a percentage (e.g., 87.3). It is populated after the PollCopyStatus method is called.

This property is read-only and not available at design time.

Data Type

String

CopyStatus Property (OneDrive Component)

Status of a copy operation.

Syntax

__property String CopyStatus = { read=FCopyStatus };

Default Value

""

Remarks

This property reflects the status of a copy operation. It is populated after the PollCopyStatus method is called. Possible values strings are:

• notStarted
• inProgress
• completed
• updating
• failed
• waiting

This property is read-only and not available at design time.

Data Type

String

Drive Property (OneDrive Component)

Selects a drive.

Syntax

__property String Drive = { read=FDrive, write=FSetDrive };

Default Value

""

Remarks

This property can be set to the Id of a specific drive to select it for use.

When this property is empty (default), the component uses the following logic to determine which drive to select:

1. If the GroupId and SiteId configuration settings are both empty (also default), the current user's default drive is used.
2. Otherwise, if the GroupId configuration setting is populated, that group's default drive is used.
3. Otherwise, if the SiteId configuration setting is populated, that site's default drive is used.

Note: For use-cases that only make use of the current user's default drive (e.g., when authenticated with a personal Microsoft account), there is no need to ever call ListDrives, set the Drive property, or use any of the component's other drive-related API members. By default, the Drive property and the GroupId and SiteId configuration settings are all empty, which causes the component to use the current user's default drive.

This property is not available at design time.

Data Type

String

DriveMarker Property (OneDrive Component)

A marker indicating what page of drives to return next.

Syntax

__property String DriveMarker = { read=FDriveMarker, write=FSetDriveMarker };

Default Value

""

Remarks

This property will be populated when ListDrives is called if the results are paged and there are more pages. To list all drives, continue to call ListDrives until this property returns empty string.

Refer to ListDrives for more information

This property is not available at design time.

Data Type

String

DriveCount Property (OneDrive Component)

The number of records in the Drive arrays.

Syntax

__property int DriveCount = { read=FDriveCount };

Default Value

0

Remarks

This property controls the size of the following arrays:

• DriveDeletedSpace
• DriveDescription
• DriveId
• DriveName
• DriveOwnerId
• DriveOwnerName
• DriveRemainingSpace
• DriveState
• DriveTotalSpace
• DriveType
• DriveUsedSpace

The array indices start at 0 and end at DriveCount - 1.

This property is read-only and not available at design time.

Data Type

Integer

DriveDeletedSpace Property (OneDrive Component)

The amount of drive space consumed by deleted resources.

Syntax

__property __int64 DriveDeletedSpace[int DriveIndex] = { read=FDriveDeletedSpace };

Default Value

0

Remarks

The amount of drive space consumed by deleted resources.

This property reflects the amount of drive space, in bytes, consumed by deleted resources.

The DriveIndex parameter specifies the index of the item in the array. The size of the array is controlled by the DriveCount property.

This property is read-only and not available at design time.

Data Type

Long64

DriveDescription Property (OneDrive Component)

A description of the drive.

Syntax

__property String DriveDescription[int DriveIndex] = { read=FDriveDescription };

Default Value

""

Remarks

A description of the drive.

This property holds a description of the drive.

The DriveIndex parameter specifies the index of the item in the array. The size of the array is controlled by the DriveCount property.

This property is read-only and not available at design time.

Data Type

String

DriveId Property (OneDrive Component)

The Id of the drive.

Syntax

__property String DriveId[int DriveIndex] = { read=FDriveId };

Default Value

""

Remarks

The Id of the drive.

This property holds the Id of the drive. (Note that the format of the drive's Id may differ depending on its DriveType.)

The DriveIndex parameter specifies the index of the item in the array. The size of the array is controlled by the DriveCount property.

This property is read-only and not available at design time.

Data Type

String

DriveName Property (OneDrive Component)

The name of the drive.

Syntax

__property String DriveName[int DriveIndex] = { read=FDriveName };

Default Value

""

Remarks

The name of the drive.

This property holds the name of the drive.

The DriveIndex parameter specifies the index of the item in the array. The size of the array is controlled by the DriveCount property.

This property is read-only and not available at design time.

Data Type

String

DriveOwnerId Property (OneDrive Component)

The Id of the drive's owner.

Syntax

__property String DriveOwnerId[int DriveIndex] = { read=FDriveOwnerId };

Default Value

""

Remarks

The Id of the drive's owner.

This property holds the Id of the drive's owner.

The DriveIndex parameter specifies the index of the item in the array. The size of the array is controlled by the DriveCount property.

This property is read-only and not available at design time.

Data Type

String

DriveOwnerName Property (OneDrive Component)

The name of the drive's owner.

Syntax

__property String DriveOwnerName[int DriveIndex] = { read=FDriveOwnerName };

Default Value

""

Remarks

The name of the drive's owner.

This property holds the name of the drive's owner.

The DriveIndex parameter specifies the index of the item in the array. The size of the array is controlled by the DriveCount property.

This property is read-only and not available at design time.

Data Type

String

DriveRemainingSpace Property (OneDrive Component)

The amount of drive space currently available.

Syntax

__property __int64 DriveRemainingSpace[int DriveIndex] = { read=FDriveRemainingSpace };

Default Value

0

Remarks

The amount of drive space currently available.

This property reflects the amount of drive space, in bytes, that is currently available.

The DriveIndex parameter specifies the index of the item in the array. The size of the array is controlled by the DriveCount property.

This property is read-only and not available at design time.

Data Type

Long64

DriveState Property (OneDrive Component)

The drive's storage quota state.

Syntax

__property TcsOneDriveDriveStates DriveState[int DriveIndex] = { read=FDriveState };

enum TcsOneDriveDriveStates {
  dsNormal=0,
  dsNearing=1,
  dsCritical=2,
  dsExceeded=3
};

Default Value

dsNormal

Remarks

The drive's storage quota state.

This property reflects the drive's current storage quota state. Possible values are:

The DriveIndex parameter specifies the index of the item in the array. The size of the array is controlled by the DriveCount property.

This property is read-only and not available at design time.

Data Type

Integer

DriveTotalSpace Property (OneDrive Component)

The total capacity of the drive.

Syntax

__property __int64 DriveTotalSpace[int DriveIndex] = { read=FDriveTotalSpace };

Default Value

0

Remarks

The total capacity of the drive.

This property reflects the total capacity, in bytes, of the drive.

The DriveIndex parameter specifies the index of the item in the array. The size of the array is controlled by the DriveCount property.

This property is read-only and not available at design time.

Data Type

Long64

DriveType Property (OneDrive Component)

The drive's type.

Syntax

__property TcsOneDriveDriveTypes DriveType[int DriveIndex] = { read=FDriveType };

enum TcsOneDriveDriveTypes {
  oddtPersonal=0,
  oddtBusiness=1,
  oddtDocumentLibrary=2
};

Default Value

oddtPersonal

Remarks

The drive's type.

This property reflects the drive's type. Possible values are:

The DriveIndex parameter specifies the index of the item in the array. The size of the array is controlled by the DriveCount property.

This property is read-only and not available at design time.

Data Type

Integer

DriveUsedSpace Property (OneDrive Component)

The amount of drive space that has been consumed.

Syntax

__property __int64 DriveUsedSpace[int DriveIndex] = { read=FDriveUsedSpace };

Default Value

0

Remarks

The amount of drive space that has been consumed.

This property reflects the amount of drive space, in bytes, that has been consumed.

The DriveIndex parameter specifies the index of the item in the array. The size of the array is controlled by the DriveCount property.

This property is read-only and not available at design time.

Data Type

Long64

EncryptionAlgorithm Property (OneDrive Component)

The encryption algorithm.

Syntax

__property TcsOneDriveEncryptionAlgorithms EncryptionAlgorithm = { read=FEncryptionAlgorithm, write=FSetEncryptionAlgorithm };

enum TcsOneDriveEncryptionAlgorithms {
  eaAES=0,
  eaBlowfish=1,
  eaCAST=2,
  eaDES=3,
  eaIDEA=4,
  eaRC2=5,
  eaRC4=6,
  eaTEA=7,
  eaTripleDES=8,
  eaTwofish=9,
  eaRijndael=10,
  eaChaCha=11,
  eaXSalsa20=12
};

Default Value

eaAES

Remarks

This property specifies the encryption algorithm to be used. The maximum allowable key size is automatically used for the selected algorithm. Possible values are:

Data Type

Integer

EncryptionPassword Property (OneDrive Component)

The encryption password.

Syntax

__property String EncryptionPassword = { read=FEncryptionPassword, write=FSetEncryptionPassword };

Default Value

""

Remarks

If this property is populated when UploadFile or DownloadFile is called, the component will attempt to encrypt or decrypt the data before uploading or after downloading it.

The component uses the value specified here to generate the necessary encryption Key and IV values using the PKCS5 password digest algorithm. This provides a simpler alternative to creating and managing Key and IV values directly.

However, it is also possible to explicitly specify the Key and IV values to use by setting the EncryptionKey and EncryptionIV configuration settings. This may be necessary if, e.g., the data needs to be encrypted/decrypted by another utility which generates Key and IV values differently.

This property is not available at design time.

Data Type

String

FirewallAutoDetect Property (OneDrive Component)

This property tells the component whether or not to automatically detect and use firewall system settings, if available.

Syntax

__property bool FirewallAutoDetect = { read=FFirewallAutoDetect, write=FSetFirewallAutoDetect };

Default Value

False

Remarks

This property tells the component whether or not to automatically detect and use firewall system settings, if available.

Data Type

Boolean

FirewallType Property (OneDrive Component)

This property determines the type of firewall to connect through.

Syntax

__property TcsOneDriveFirewallTypes FirewallType = { read=FFirewallType, write=FSetFirewallType };

enum TcsOneDriveFirewallTypes {
  fwNone=0,
  fwTunnel=1,
  fwSOCKS4=2,
  fwSOCKS5=3,
  fwSOCKS4A=10
};

Default Value

fwNone

Remarks

This property determines the type of firewall to connect through. The applicable values are as follows:

Data Type

Integer

FirewallHost Property (OneDrive Component)

This property contains the name or IP address of firewall (optional).

Syntax

__property String FirewallHost = { read=FFirewallHost, write=FSetFirewallHost };

Default Value

""

Remarks

This property contains the name or IP address of firewall (optional). If a FirewallHost is given, the requested connections will be authenticated through the specified firewall when connecting.

If this property is set to a Domain Name, a DNS request is initiated. Upon successful termination of the request, this property is set to the corresponding address. If the search is not successful, the component raises an exception.

Data Type

String

FirewallPassword Property (OneDrive Component)

This property contains a password if authentication is to be used when connecting through the firewall.

Syntax

__property String FirewallPassword = { read=FFirewallPassword, write=FSetFirewallPassword };

Default Value

""

Remarks

This property contains a password if authentication is to be used when connecting through the firewall. If FirewallHost is specified, the FirewallUser and FirewallPassword properties are used to connect and authenticate to the given firewall. If the authentication fails, the component raises an exception.

Data Type

String

FirewallPort Property (OneDrive Component)

This property contains the transmission control protocol (TCP) port for the firewall Host .

Syntax

__property int FirewallPort = { read=FFirewallPort, write=FSetFirewallPort };

Default Value

0

Remarks

This property contains the transmission control protocol (TCP) port for the firewall FirewallHost. See the description of the FirewallHost property for details.

Note: This property is set automatically when FirewallType is set to a valid value. See the description of the FirewallType property for details.

Data Type

Integer

FirewallUser Property (OneDrive Component)

This property contains a user name if authentication is to be used connecting through a firewall.

Syntax

__property String FirewallUser = { read=FFirewallUser, write=FSetFirewallUser };

Default Value

""

Remarks

This property contains a user name if authentication is to be used connecting through a firewall. If the FirewallHost is specified, this property and FirewallPassword properties are used to connect and authenticate to the given Firewall. If the authentication fails, the component raises an exception.

Data Type

String

Idle Property (OneDrive Component)

The current status of the component.

Syntax

__property bool Idle = { read=FIdle };

Default Value

True

Remarks

Idle will be False if the component is currently busy (communicating and/or waiting for an answer), and True at all other times.

This property is read-only.

Data Type

Boolean

LocalFile Property (OneDrive Component)

The location of the local file.

Syntax

__property String LocalFile = { read=FLocalFile, write=FSetLocalFile };

Default Value

""

Remarks

This property specifies the location of a file on disk. This is used as the source file when calling UploadFile or UpdateResource, and as the destination file when calling DownloadFile.

Data Type

String

LocalHost Property (OneDrive Component)

The name of the local host or user-assigned IP interface through which connections are initiated or accepted.

Syntax

__property String LocalHost = { read=FLocalHost, write=FSetLocalHost };

Default Value

""

Remarks

The LocalHost property contains the name of the local host as obtained by the gethostname() system call, or if the user has assigned an IP address, the value of that address.

In multi-homed hosts (machines with more than one IP interface) setting LocalHost to the value of an interface will make the component initiate connections (or accept in the case of server components) only through that interface.

If the component is connected, the LocalHost property shows the IP address of the interface through which the connection is made in internet dotted format (aaa.bbb.ccc.ddd). In most cases, this is the address of the local host, except for multi-homed hosts (machines with more than one IP interface).

NOTE: LocalHost is not persistent. You must always set it in code, and never in the property window.

Data Type

String

NextChangeMarker Property (OneDrive Component)

A marker indicating what page of changes to return in the future.

Syntax

__property String NextChangeMarker = { read=FNextChangeMarker, write=FSetNextChangeMarker };

Default Value

""

Remarks

This property will be populated when ListChanges is called if there are no more changes to list.

This property will be populated with the most current change marker if GetCurrentChangeMarker is called.

Setting NextChangeMarker will cause ChangeMarker to be set to empty string.

Refer to ListChanges for more information.

This property is not available at design time.

Data Type

String

OAuthAccessToken Property (OneDrive Component)

The access token returned by the authorization server.

Syntax

__property String OAuthAccessToken = { read=FOAuthAccessToken, write=FSetOAuthAccessToken };

Default Value

""

Remarks

The access token returned by the authorization server. This is set when the component makes a request to the token server.

This property is not available at design time.

Data Type

String

OAuthAuthorizationCode Property (OneDrive Component)

The authorization code that is exchanged for an access token.

Syntax

__property String OAuthAuthorizationCode = { read=FOAuthAuthorizationCode, write=FSetOAuthAuthorizationCode };

Default Value

""

Remarks

The authorization code that is exchanged for an access token. This is required to be set when the OAuthClientProfile property is set to the Web profile. Otherwise, this field is for information purposes only.

This property is not available at design time.

Data Type

String

OAuthAuthorizationScope Property (OneDrive Component)

The scope request or response parameter used during authorization.

Syntax

__property String OAuthAuthorizationScope = { read=FOAuthAuthorizationScope, write=FSetOAuthAuthorizationScope };

Default Value

""

Remarks

The scope request or response parameter used during authorization.

This property is not available at design time.

Data Type

String

OAuthClientId Property (OneDrive Component)

The id of the client assigned when registering the application.

Syntax

__property String OAuthClientId = { read=FOAuthClientId, write=FSetOAuthClientId };

Default Value

""

Remarks

The id of the client assigned when registering the application.

This property is not available at design time.

Data Type

String

OAuthClientProfile Property (OneDrive Component)

The type of client that is requesting authorization.

Syntax

__property TcsOneDriveOAuthClientProfiles OAuthClientProfile = { read=FOAuthClientProfile, write=FSetOAuthClientProfile };

enum TcsOneDriveOAuthClientProfiles {
  cocpApplication=0,
  cocpWeb=1
};

Default Value

cocpApplication

Remarks

The type of client that is requesting authorization. See the introduction section for more information. Possible values are:

This property is not available at design time.

Data Type

Integer

OAuthClientSecret Property (OneDrive Component)

The secret value for the client assigned when registering the application.

Syntax

__property String OAuthClientSecret = { read=FOAuthClientSecret, write=FSetOAuthClientSecret };

Default Value

""

Remarks

The secret value for the client assigned when registering the application.

This property is not available at design time.

Data Type

String

OAuthGrantType Property (OneDrive Component)

The OAuth grant type used to acquire an OAuth access token.

Syntax

__property TcsOneDriveOAuthGrantTypes OAuthGrantType = { read=FOAuthGrantType, write=FSetOAuthGrantType };

enum TcsOneDriveOAuthGrantTypes {
  cogtAuthorizationCode=0,
  cogtImplicit=1,
  cogtPassword=2,
  cogtClientCredentials=3
};

Default Value

cogtAuthorizationCode

Remarks

The OAuth grant type used to acquire an OAuth access token. See the introduction section for more information. Possible values are:

This property is not available at design time.

Data Type

Integer

OAuthRefreshToken Property (OneDrive Component)

Specifies the refresh token received from or sent to the authorization server.

Syntax

__property String OAuthRefreshToken = { read=FOAuthRefreshToken, write=FSetOAuthRefreshToken };

Default Value

""

Remarks

Specifies the refresh token received from or sent to the authorization server. This property is set automatically if a refresh token is retrieved from the token server. If the OAuthAutomaticRefresh configuration setting is set to true, and the OAuthGrantType property is set to a grant that can use refresh tokens.

This property is not available at design time.

Data Type

String

OAuthReturnURL Property (OneDrive Component)

The URL where the user (browser) returns after authenticating.

Syntax

__property String OAuthReturnURL = { read=FOAuthReturnURL, write=FSetOAuthReturnURL };

Default Value

""

Remarks

The URL where the user (browser) returns after authenticating. This property is mapped to the redirect_uri parameter when making a request to the authorization server. Typically, this is automatically set by the component when using the embedded web server. If the OAuthWebServerPort or OAuthWebServerHost configuration settings is set, then this property should be set to match. If using the Web client profile, this should be set to the place where the authorization code will be parsed out of the response after the user finishes authorizing.

This property is not available at design time.

Data Type

String

OAuthServerAuthURL Property (OneDrive Component)

The URL of the authorization server.

Syntax

__property String OAuthServerAuthURL = { read=FOAuthServerAuthURL, write=FSetOAuthServerAuthURL };

Default Value

""

Remarks

The URL of the authorization server.

This property is not available at design time.

Data Type

String

OAuthServerTokenURL Property (OneDrive Component)

The URL of the token server used to obtain the access token.

Syntax

__property String OAuthServerTokenURL = { read=FOAuthServerTokenURL, write=FSetOAuthServerTokenURL };

Default Value

""

Remarks

The URL of the token server used to obtain the access token.

This property is not available at design time.

Data Type

String

OAuthWebAuthURL Property (OneDrive Component)

The URL to which the user should be re-directed for authorization.

Syntax

__property String OAuthWebAuthURL = { read=FOAuthWebAuthURL };

Default Value

""

Remarks

The URL to which the user should be re-directed for authorization. This field is used to get the URL that the user should be redirected to when using the Web client profile. See introduction section for more information.

This property is read-only and not available at design time.

Data Type

String

OtherHeaders Property (OneDrive Component)

This property includes other headers as determined by the user (optional).

Syntax

__property String OtherHeaders = { read=FOtherHeaders, write=FSetOtherHeaders };

Default Value

""

Remarks

This property can be set to a string of headers to be appended to the HTTP request headers created from other properties like ContentType and From.

The headers must follow the format Header: Value as described in the HTTP specifications. Header lines should be separated by CRLF ("\r\n") .

Use this property with caution. If this property contains invalid headers, HTTP requests may fail.

This property is useful for extending the functionality of the component beyond what is provided.

This property is not available at design time.

Data Type

String

Overwrite Property (OneDrive Component)

Whether to overwrite the local or remote file.

Syntax

__property bool Overwrite = { read=FOverwrite, write=FSetOverwrite };

Default Value

false

Remarks

When calling DownloadFile, this property determines if LocalFile should be overwritten if it already exists.

When calling UploadFile, this property determines if the remote file should be overwritten if it already exists. If the RenameIfExists configuration setting is enabled, this property is ignored and the server will renamed the newly-uploaded file instead (if necessary).

Data Type

Boolean

ParsedHeaderCount Property (OneDrive Component)

The number of records in the ParsedHeader arrays.

Syntax

__property int ParsedHeaderCount = { read=FParsedHeaderCount };

Default Value

0

Remarks

This property controls the size of the following arrays:

• ParsedHeaderField
• ParsedHeaderValue

The array indices start at 0 and end at ParsedHeaderCount - 1.

This property is read-only and not available at design time.

Data Type

Integer

ParsedHeaderField Property (OneDrive Component)

This property contains the name of the HTTP header (this is the same case as it is delivered).

Syntax

__property String ParsedHeaderField[int ParsedHeaderIndex] = { read=FParsedHeaderField };

Default Value

""

Remarks

This property contains the name of the HTTP Header (this is the same case as it is delivered).

The ParsedHeaderIndex parameter specifies the index of the item in the array. The size of the array is controlled by the ParsedHeaderCount property.

This property is read-only and not available at design time.

Data Type

String

ParsedHeaderValue Property (OneDrive Component)

This property contains the header contents.

Syntax

__property String ParsedHeaderValue[int ParsedHeaderIndex] = { read=FParsedHeaderValue };

Default Value

""

Remarks

This property contains the Header contents.

The ParsedHeaderIndex parameter specifies the index of the item in the array. The size of the array is controlled by the ParsedHeaderCount property.

This property is read-only and not available at design time.

Data Type

String

ProxyAuthScheme Property (OneDrive Component)

This property is used to tell the component which type of authorization to perform when connecting to the proxy.

Syntax

__property TcsOneDriveProxyAuthSchemes ProxyAuthScheme = { read=FProxyAuthScheme, write=FSetProxyAuthScheme };

enum TcsOneDriveProxyAuthSchemes {
  authBasic=0,
  authDigest=1,
  authProprietary=2,
  authNone=3,
  authNtlm=4,
  authNegotiate=5
};

Default Value

authBasic

Remarks

This property is used to tell the component which type of authorization to perform when connecting to the proxy. This is used only when the ProxyUser and ProxyPassword properties are set.

ProxyAuthScheme should be set to authNone (3) when no authentication is expected.

By default, ProxyAuthScheme is authBasic (0), and if the ProxyUser and ProxyPassword properties are set, the component will attempt basic authentication.

If ProxyAuthScheme is set to authDigest (1), digest authentication will be attempted instead.

If ProxyAuthScheme is set to authProprietary (2), then the authorization token will not be generated by the component. Look at the configuration file for the component being used to find more information about manually setting this token.

If ProxyAuthScheme is set to authNtlm (4), NTLM authentication will be used.

For security reasons, setting this property will clear the values of ProxyUser and ProxyPassword.

Data Type

Integer

ProxyAutoDetect Property (OneDrive Component)

This property tells the component whether or not to automatically detect and use proxy system settings, if available.

Syntax

__property bool ProxyAutoDetect = { read=FProxyAutoDetect, write=FSetProxyAutoDetect };

Default Value

False

Remarks

This property tells the component whether or not to automatically detect and use proxy system settings, if available. The default value is false.

Data Type

Boolean

ProxyPassword Property (OneDrive Component)

This property contains a password if authentication is to be used for the proxy.

Syntax

__property String ProxyPassword = { read=FProxyPassword, write=FSetProxyPassword };

Default Value

""

Remarks

This property contains a password if authentication is to be used for the proxy.

If ProxyAuthScheme is set to Basic Authentication, the ProxyUser and ProxyPassword are Base64 encoded and the proxy authentication token will be generated in the form Basic [encoded-user-password].

If ProxyAuthScheme is set to Digest Authentication, the ProxyUser and ProxyPassword properties are used to respond to the Digest Authentication challenge from the server.

If ProxyAuthScheme is set to NTLM Authentication, the ProxyUser and ProxyPassword properties are used to authenticate through NTLM negotiation.

Data Type

String

ProxyPort Property (OneDrive Component)

This property contains the Transmission Control Protocol (TCP) port for the proxy Server (default 80).

Syntax

__property int ProxyPort = { read=FProxyPort, write=FSetProxyPort };

Default Value

80

Remarks

This property contains the Transmission Control Protocol (TCP) port for the proxy ProxyServer (default 80). See the description of the ProxyServer property for details.

Data Type

Integer

ProxyServer Property (OneDrive Component)

If a proxy Server is given, then the HTTP request is sent to the proxy instead of the server otherwise specified.

Syntax

__property String ProxyServer = { read=FProxyServer, write=FSetProxyServer };

Default Value

""

Remarks

If a proxy ProxyServer is given, then the HTTP request is sent to the proxy instead of the server otherwise specified.

If the ProxyServer property is set to a domain name, a DNS request is initiated. Upon successful termination of the request, the ProxyServer property is set to the corresponding address. If the search is not successful, an error is returned.

Data Type

String

ProxySSL Property (OneDrive Component)

This property determines when to use a Secure Sockets Layer (SSL) for the connection to the proxy.

Syntax

__property TcsOneDriveProxySSLs ProxySSL = { read=FProxySSL, write=FSetProxySSL };

enum TcsOneDriveProxySSLs {
  psAutomatic=0,
  psAlways=1,
  psNever=2,
  psTunnel=3
};

Default Value

psAutomatic

Remarks

This property determines when to use a Secure Sockets Layer (SSL) for the connection to the proxy. The applicable values are as follows:

Data Type

Integer

ProxyUser Property (OneDrive Component)

This property contains a username if authentication is to be used for the proxy.

Syntax

__property String ProxyUser = { read=FProxyUser, write=FSetProxyUser };

Default Value

""

Remarks

This property contains a username if authentication is to be used for the proxy.

If ProxyAuthScheme is set to Basic Authentication, the ProxyUser and ProxyPassword properties are Base64 encoded and the proxy authentication token will be generated in the form Basic [encoded-user-password].

If ProxyAuthScheme is set to Digest Authentication, the ProxyUser and ProxyPassword properties are used to respond to the Digest Authentication challenge from the server.

If ProxyAuthScheme is set to NTLM Authentication, the ProxyUser and ProxyPassword properties are used to authenticate through NTLM negotiation.

Data Type

String

QueryParamCount Property (OneDrive Component)

The number of records in the QueryParam arrays.

Syntax

__property int QueryParamCount = { read=FQueryParamCount, write=FSetQueryParamCount };

Default Value

0

Remarks

This property controls the size of the following arrays:

• QueryParamName
• QueryParamValue

The array indices start at 0 and end at QueryParamCount - 1.

This property is not available at design time.

Data Type

Integer

QueryParamName Property (OneDrive Component)

The name of the query parameter.

Syntax

__property String QueryParamName[int QueryParamIndex] = { read=FQueryParamName, write=FSetQueryParamName };

Default Value

""

Remarks

The name of the query parameter.

This property specifies the name of the query parameter.

The QueryParamIndex parameter specifies the index of the item in the array. The size of the array is controlled by the QueryParamCount property.

This property is not available at design time.

Data Type

String

QueryParamValue Property (OneDrive Component)

The value of the query parameter.

Syntax

__property String QueryParamValue[int QueryParamIndex] = { read=FQueryParamValue, write=FSetQueryParamValue };

Default Value

""

Remarks

The value of the query parameter.

This property specifies the value of the query parameter. The component will automatically URL-encode this value when sending the request.

The QueryParamIndex parameter specifies the index of the item in the array. The size of the array is controlled by the QueryParamCount property.

This property is not available at design time.

Data Type

String

Range Property (OneDrive Component)

The range of bytes to request.

Syntax

__property String Range = { read=FRange, write=FSetRange };

Default Value

""

Remarks

This property specifies the range of bytes to request from the server. If this property is non-empty when a DownloadFile request is being constructed, a header like Range: bytes=Range will be added to the request, with Range substituted with the specified value.

There are two valid formats for this property's value:

• StartByte-
• StartByte-EndByte

Note: If the StartByte property is greater than zero when DownloadFile is called (i.e., when a download is being resumed), and this property is non-empty, the component will automatically advance the StartByte value in the specified range by StartByte bytes when sending the Range header to the server. This ensures that the previously-downloaded data at the start of the specified range is not downloaded again when the download is resumed.

This property is not available at design time.

Data Type

String

RemoteId Property (OneDrive Component)

Selects a remote resource by Id.

Syntax

__property String RemoteId = { read=FRemoteId, write=FSetRemoteId };

Default Value

""

Remarks

This property selects a remote file or folder resource to operate against using its resource Id.

Remote Id and Path Notes

Keep the following things in mind when setting the RemoteId and/or RemotePath properties:

• If both RemoteId and RemotePath are set, RemoteId is used.
• The Id or path provided must always be for a resource that resides in the drive currently selected by Drive.
• Some methods operate against only file or only folder resources; while others can operate against either one. Calling a method while RemoteId/RemotePath is set to the Id/path of a resource whose type is unsupported will cause the server to return an error; use the table below to determine which resource types each method supports.

  Method Name	Files	Folders
  CopyResource	X	X
  CreateFolder	-	X
  CreateLink	X	X
  DeleteResource	X	X
  DownloadFile	X	-
  GetResourceInfo	X	X
  ListResources	-	X
  MoveResource	X	X
  Search	-	X
  UpdateResource	X	X
  UploadFile	-	X

  Key: X = Supported; - = Not supported.

• Methods that support only folder resources can also operate against the root of the currently selected drive, just clear both RemoteId and RemotePath.
• Some methods may have other restrictions, refer to each one for more information.

Note: The rules regarding acceptable resource types still apply if using the RelativePath configuration setting in tandem with this property. That is, ensure that the resource that the relative path resolves to is of an acceptable type.

This property is not available at design time.

Data Type

String

RemotePath Property (OneDrive Component)

Selects a remote resource by path.

Syntax

__property String RemotePath = { read=FRemotePath, write=FSetRemotePath };

Default Value

""

Remarks

This property selects a remote file or folder resource to operate against using its path. The path provided must be absolute (that is, relative to the root of the currently selected drive).

Remote Id and Path Notes

Keep the following things in mind when setting the RemoteId and/or RemotePath properties:

• If both RemoteId and RemotePath are set, RemoteId is used.
• The Id or path provided must always be for a resource that resides in the drive currently selected by Drive.
• Some methods operate against only file or only folder resources; while others can operate against either one. Calling a method while RemoteId/RemotePath is set to the Id/path of a resource whose type is unsupported will cause the server to return an error; use the table below to determine which resource types each method supports.

  Method Name	Files	Folders
  CopyResource	X	X
  CreateFolder	-	X
  CreateLink	X	X
  DeleteResource	X	X
  DownloadFile	X	-
  GetResourceInfo	X	X
  ListResources	-	X
  MoveResource	X	X
  Search	-	X
  UpdateResource	X	X
  UploadFile	-	X

  Key: X = Supported; - = Not supported.

• Methods that support only folder resources can also operate against the root of the currently selected drive, just clear both RemoteId and RemotePath.
• Some methods may have other restrictions, refer to each one for more information.

This property is not available at design time.

Data Type

String

ResourceData Property (OneDrive Component)

The data that was downloaded, or that should be uploaded.

Syntax

__property String ResourceData = { read=FResourceData, write=FSetResourceData };
__property DynamicArray<Byte> ResourceDataB = { read=FResourceDataB, write=FSetResourceDataB };

Default Value

""

Remarks

This property is populated with file data after calling DownloadFile if LocalFile is not set.

This property can also be set before calling UploadFile; its data will be uploaded if LocalFile is not set.

This property is not available at design time.

Data Type

Byte Array

ResourceMarker Property (OneDrive Component)

A marker indicating what page of resources to return next.

Syntax

__property String ResourceMarker = { read=FResourceMarker, write=FSetResourceMarker };

Default Value

""

Remarks

This property will be populated when ListResources is called if the results are paged and there are more pages. To list all resources, continue to call ListResources until this property returns empty string.

Refer to ListResources for more information.

This property is not available at design time.

Data Type

String

ResourceCount Property (OneDrive Component)

The number of records in the Resource arrays.

Syntax

__property int ResourceCount = { read=FResourceCount, write=FSetResourceCount };

Default Value

0

Remarks

This property controls the size of the following arrays:

• ResourceChildCount
• ResourceCreatedTime
• ResourceDeleted
• ResourceDescription
• ResourceDriveId
• ResourceETag
• ResourceHash
• ResourceHashAlgorithm
• ResourceId
• ResourceMIMEType
• ResourceModifiedTime
• ResourceName
• ResourceParentId
• ResourceParentPath
• ResourcePath
• ResourceSize
• ResourceType
• ResourceWebURL

The array indices start at 0 and end at ResourceCount - 1.

This property is not available at design time.

Data Type

Integer

ResourceChildCount Property (OneDrive Component)

How many children the resource has.

Syntax

__property int ResourceChildCount[int ResourceIndex] = { read=FResourceChildCount };

Default Value

0

Remarks

How many children the resource has.

This property reflects how many child resources the resource has. For file resources, this property will always be 0.

The ResourceIndex parameter specifies the index of the item in the array. The size of the array is controlled by the ResourceCount property.

This property is read-only and not available at design time.

Data Type

Integer

ResourceCreatedTime Property (OneDrive Component)

The creation timestamp of the resource.

Syntax

__property String ResourceCreatedTime[int ResourceIndex] = { read=FResourceCreatedTime };

Default Value

""

Remarks

The creation timestamp of the resource.

This property holds the creation timestamp of the resource. Timestamps are formatted according to ISO 8601 and are always in UTC time.

The ResourceIndex parameter specifies the index of the item in the array. The size of the array is controlled by the ResourceCount property.

This property is read-only and not available at design time.

Data Type

String

ResourceDeleted Property (OneDrive Component)

Whether this resource has been deleted.

Syntax

__property bool ResourceDeleted[int ResourceIndex] = { read=FResourceDeleted };

Default Value

false

Remarks

Whether this resource has been deleted.

This property reflects whether the resource has been deleted.

Note that this property is only applicable when populated by a call to ListChanges; otherwise, it is always false.

The ResourceIndex parameter specifies the index of the item in the array. The size of the array is controlled by the ResourceCount property.

This property is read-only and not available at design time.

Data Type

Boolean

ResourceDescription Property (OneDrive Component)

A description of the resource.

Syntax

__property String ResourceDescription[int ResourceIndex] = { read=FResourceDescription, write=FSetResourceDescription };

Default Value

""

Remarks

A description of the resource.

This property specifies a description of the resource. Only applicable to resources in OneDrive Personal drives.

The ResourceIndex parameter specifies the index of the item in the array. The size of the array is controlled by the ResourceCount property.

This property is not available at design time.

Data Type

String

ResourceDriveId Property (OneDrive Component)

The Id of the drive that contains the resource.

Syntax

__property String ResourceDriveId[int ResourceIndex] = { read=FResourceDriveId };

Default Value

""

Remarks

The Id of the drive that contains the resource.

This property holds the Id of the drive that contains the resource.

The ResourceIndex parameter specifies the index of the item in the array. The size of the array is controlled by the ResourceCount property.

This property is read-only and not available at design time.

Data Type

String

ResourceETag Property (OneDrive Component)

The ETag of the resource.

Syntax

__property String ResourceETag[int ResourceIndex] = { read=FResourceETag };

Default Value

""

Remarks

The ETag of the resource.

This property holds the ETag of the resource.

The ResourceIndex parameter specifies the index of the item in the array. The size of the array is controlled by the ResourceCount property.

This property is read-only and not available at design time.

Data Type

String

ResourceHash Property (OneDrive Component)

A hash of the resource's content.

Syntax

__property String ResourceHash[int ResourceIndex] = { read=FResourceHash };

Default Value

""

Remarks

A hash of the resource's content.

The property holds a hash of the resource's content. Only applicable for file resources.

The ResourceHashAlgorithm property determines which hash this property is populated with; this property will be empty if the server didn't return a hash for the currently selected ResourceHashAlgorithm.

The ResourceIndex parameter specifies the index of the item in the array. The size of the array is controlled by the ResourceCount property.

This property is read-only and not available at design time.

Data Type

String

ResourceHashAlgorithm Property (OneDrive Component)

The hash's algorithm.

Syntax

__property int ResourceHashAlgorithm[int ResourceIndex] = { read=FResourceHashAlgorithm, write=FSetResourceHashAlgorithm };

Default Value

0

Remarks

The hash's algorithm.

This property specifies which hash the ResourceHash property is populated with. Changing the value of this property will re-populate the ResourceHash property accordingly. Possible values are:

• 0 - QuickXOR hash (only applicable for OneDrive for Business and SharePoint Online)
• 1 - CRC32 hash (only applicable for OneDrive Personal)
• 2 - SHA1 hash (only applicable for OneDrive Personal)

Note: Hashes are generated by the server, not the component; and it makes no guarantees as to when hashes are generated (it may not do so immediately).

The ResourceIndex parameter specifies the index of the item in the array. The size of the array is controlled by the ResourceCount property.

This property is not available at design time.

Data Type

Integer

ResourceId Property (OneDrive Component)

The Id of the resource.

Syntax

__property String ResourceId[int ResourceIndex] = { read=FResourceId, write=FSetResourceId };

Default Value

""

Remarks

The Id of the resource.

This property holds the Id of the resource.

Either this property or ResourcePath must be set before calling UpdateResource.

The ResourceIndex parameter specifies the index of the item in the array. The size of the array is controlled by the ResourceCount property.

This property is not available at design time.

Data Type

String

ResourceMIMEType Property (OneDrive Component)

The MIME type of the resource.

Syntax

__property String ResourceMIMEType[int ResourceIndex] = { read=FResourceMIMEType };

Default Value

""

Remarks

The MIME type of the resource.

This property holds the MIME type of the resource.

The ResourceIndex parameter specifies the index of the item in the array. The size of the array is controlled by the ResourceCount property.

This property is read-only and not available at design time.

Data Type

String

ResourceModifiedTime Property (OneDrive Component)

The last modified timestamp of the resource.

Syntax

__property String ResourceModifiedTime[int ResourceIndex] = { read=FResourceModifiedTime };

Default Value

""

Remarks

The last modified timestamp of the resource.

This property holds the last modified timestamp of the resource. Timestamps are formatted according to ISO 8601 and are always in UTC time.

The ResourceIndex parameter specifies the index of the item in the array. The size of the array is controlled by the ResourceCount property.

This property is read-only and not available at design time.

Data Type

String

ResourceName Property (OneDrive Component)

The name of the resource.

Syntax

__property String ResourceName[int ResourceIndex] = { read=FResourceName, write=FSetResourceName };

Default Value

""

Remarks

The name of the resource.

This property specifies the name of the resource.

The ResourceIndex parameter specifies the index of the item in the array. The size of the array is controlled by the ResourceCount property.

This property is not available at design time.

Data Type

String

ResourceParentId Property (OneDrive Component)

The Id of the resource's parent.

Syntax

__property String ResourceParentId[int ResourceIndex] = { read=FResourceParentId, write=FSetResourceParentId };

Default Value

""

Remarks

The Id of the resource's parent.

This property holds the Id of the resource's parent.

The ResourceIndex parameter specifies the index of the item in the array. The size of the array is controlled by the ResourceCount property.

This property is not available at design time.

Data Type

String

ResourceParentPath Property (OneDrive Component)

The path of the resource's parent.

Syntax

__property String ResourceParentPath[int ResourceIndex] = { read=FResourceParentPath, write=FSetResourceParentPath };

Default Value

""

Remarks

The path of the resource's parent.

This property holds the path of the resource's parent.

The ResourceIndex parameter specifies the index of the item in the array. The size of the array is controlled by the ResourceCount property.

This property is not available at design time.

Data Type

String

ResourcePath Property (OneDrive Component)

The path of the resource.

Syntax

__property String ResourcePath[int ResourceIndex] = { read=FResourcePath, write=FSetResourcePath };

Default Value

""

Remarks

The path of the resource.

This property holds the path of the resource.

Either this property or ResourceId must be set before calling UpdateResource.

The ResourceIndex parameter specifies the index of the item in the array. The size of the array is controlled by the ResourceCount property.

This property is not available at design time.

Data Type

String

ResourceSize Property (OneDrive Component)

The size of the resource in bytes.

Syntax

__property __int64 ResourceSize[int ResourceIndex] = { read=FResourceSize };

Default Value

0

Remarks

The size of the resource in bytes.

For file resources, this property holds the size of the file in bytes.

For folder resources, this property holds the total size (in bytes) of all of its children (recursively).

The ResourceIndex parameter specifies the index of the item in the array. The size of the array is controlled by the ResourceCount property.

This property is read-only and not available at design time.

Data Type

Long64

ResourceType Property (OneDrive Component)

The resource's type.

Syntax

__property TcsOneDriveResourceTypes ResourceType[int ResourceIndex] = { read=FResourceType };

enum TcsOneDriveResourceTypes {
  odrtFile=0,
  odrtFolder=1
};

Default Value

odrtFile

Remarks

The resource's type.

This property indicates whether the resource is a folder or a file. Possible values are:

The ResourceIndex parameter specifies the index of the item in the array. The size of the array is controlled by the ResourceCount property.

This property is read-only and not available at design time.

Data Type

Integer

ResourceWebURL Property (OneDrive Component)

The resource's web URL.

Syntax

__property String ResourceWebURL[int ResourceIndex] = { read=FResourceWebURL };

Default Value

""

Remarks

The resource's web URL.

This property holds the resource's web URL, which can be used to view the resource online.

The ResourceIndex parameter specifies the index of the item in the array. The size of the array is controlled by the ResourceCount property.

This property is read-only and not available at design time.

Data Type

String

ResumeURL Property (OneDrive Component)

The resumable upload URL.

Syntax

__property String ResumeURL = { read=FResumeURL, write=FSetResumeURL };

Default Value

""

Remarks

This property holds the URL of the resumable upload session. This is populated by the component automatically when UseResumableUpload is set to true and UploadFile is called to initiate a new upload.

This must be set in order to resume an interrupted upload. See UploadFile for details.

This property is not available at design time.

Data Type

String

SearchMarker Property (OneDrive Component)

A marker indicating what page of search results to return next.

Syntax

__property String SearchMarker = { read=FSearchMarker, write=FSetSearchMarker };

Default Value

""

Remarks

This property will be populated when Search is called if the results are paged and there are more pages. To list all search results, continue to call Search until this property returns empty string.

Refer to Search for more information.

This property is not available at design time.

Data Type

String

SSLAcceptServerCertEncoded Property (OneDrive Component)

This is the certificate (PEM/Base64 encoded).

Syntax

__property String SSLAcceptServerCertEncoded = { read=FSSLAcceptServerCertEncoded, write=FSetSSLAcceptServerCertEncoded };
__property DynamicArray<Byte> SSLAcceptServerCertEncodedB = { read=FSSLAcceptServerCertEncodedB, write=FSetSSLAcceptServerCertEncodedB };

Default Value

""

Remarks

This is the certificate (PEM/Base64 encoded). This property is used to assign a specific certificate. The SSLAcceptServerCertStore and SSLAcceptServerCertSubject properties also may be used to specify a certificate.

When SSLAcceptServerCertEncoded is set, a search is initiated in the current SSLAcceptServerCertStore for the private key of the certificate. If the key is found, SSLAcceptServerCertSubject is updated to reflect the full subject of the selected certificate; otherwise, SSLAcceptServerCertSubject is set to an empty string.

This property is not available at design time.

Data Type

Byte Array

SSLCertEncoded Property (OneDrive Component)

This is the certificate (PEM/Base64 encoded).

Syntax

__property String SSLCertEncoded = { read=FSSLCertEncoded, write=FSetSSLCertEncoded };
__property DynamicArray<Byte> SSLCertEncodedB = { read=FSSLCertEncodedB, write=FSetSSLCertEncodedB };

Default Value

""

Remarks

This is the certificate (PEM/Base64 encoded). This property is used to assign a specific certificate. The SSLCertStore and SSLCertSubject properties also may be used to specify a certificate.

When SSLCertEncoded is set, a search is initiated in the current SSLCertStore for the private key of the certificate. If the key is found, SSLCertSubject is updated to reflect the full subject of the selected certificate; otherwise, SSLCertSubject is set to an empty string.

This property is not available at design time.

Data Type

Byte Array

SSLCertStore Property (OneDrive Component)

This is the name of the certificate store for the client certificate.

Syntax

__property String SSLCertStore = { read=FSSLCertStore, write=FSetSSLCertStore };
__property DynamicArray<Byte> SSLCertStoreB = { read=FSSLCertStoreB, write=FSetSSLCertStoreB };

Default Value

"MY"

Remarks

This is the name of the certificate store for the client certificate.

The SSLCertStoreType property denotes the type of the certificate store specified by SSLCertStore. If the store is password protected, specify the password in SSLCertStorePassword.

SSLCertStore is used in conjunction with the SSLCertSubject property to specify client certificates. If SSLCertStore has a value, and SSLCertSubject or SSLCertEncoded is set, a search for a certificate is initiated. Please see the SSLCertSubject property for details.

Designations of certificate stores are platform dependent.

The following designations are the most common User and Machine certificate stores in Windows:

When the certificate store type is PFXFile, this property must be set to the name of the file. When the type is PFXBlob, the property must be set to the binary contents of a PFX file (i.e., PKCS#12 certificate store).

Data Type

Byte Array

SSLCertStorePassword Property (OneDrive Component)

If the type of certificate store requires a password, this property is used to specify the password needed to open the certificate store.

Syntax

__property String SSLCertStorePassword = { read=FSSLCertStorePassword, write=FSetSSLCertStorePassword };

Default Value

""

Remarks

If the type of certificate store requires a password, this property is used to specify the password needed to open the certificate store.

Data Type

String

SSLCertStoreType Property (OneDrive Component)

This is the type of certificate store for this certificate.

Syntax

__property TcsOneDriveSSLCertStoreTypes SSLCertStoreType = { read=FSSLCertStoreType, write=FSetSSLCertStoreType };

enum TcsOneDriveSSLCertStoreTypes {
  cstUser=0,
  cstMachine=1,
  cstPFXFile=2,
  cstPFXBlob=3,
  cstJKSFile=4,
  cstJKSBlob=5,
  cstPEMKeyFile=6,
  cstPEMKeyBlob=7,
  cstPublicKeyFile=8,
  cstPublicKeyBlob=9,
  cstSSHPublicKeyBlob=10,
  cstP7BFile=11,
  cstP7BBlob=12,
  cstSSHPublicKeyFile=13,
  cstPPKFile=14,
  cstPPKBlob=15,
  cstXMLFile=16,
  cstXMLBlob=17,
  cstJWKFile=18,
  cstJWKBlob=19,
  cstSecurityKey=20,
  cstBCFKSFile=21,
  cstBCFKSBlob=22,
  cstPKCS11=23,
  cstAuto=99
};

Default Value

cstUser

Remarks

This is the type of certificate store for this certificate.

The component supports both public and private keys in a variety of formats. When the cstAuto value is used, the component will automatically determine the type. This property can take one of the following values:

Data Type

Integer

SSLCertSubject Property (OneDrive Component)

This is the subject of the certificate used for client authentication.

Syntax

__property String SSLCertSubject = { read=FSSLCertSubject, write=FSetSSLCertSubject };

Default Value

""

Remarks

This is the subject of the certificate used for client authentication.

This property must be set after all other certificate properties are set. When this property is set, a search is performed in the current certificate store to locate a certificate with a matching subject.

If a matching certificate is found, the property is set to the full subject of the matching certificate.

If an exact match is not found, the store is searched for subjects containing the value of the property.

If a match is still not found, the property is set to an empty string, and no certificate is selected.

The special value "*" picks a random certificate in the certificate store.

The certificate subject is a comma-separated list of distinguished name fields and values. For instance, "CN=www.server.com, OU=test, C=US, E=support@nsoftware.com". Common fields and their meanings are as follows:

If a field value contains a comma, it must be quoted.

Data Type

String

SSLProvider Property (OneDrive Component)

This specifies the SSL/TLS implementation to use.

Syntax

__property TcsOneDriveSSLProviders SSLProvider = { read=FSSLProvider, write=FSetSSLProvider };

enum TcsOneDriveSSLProviders {
  sslpAutomatic=0,
  sslpPlatform=1,
  sslpInternal=2
};

Default Value

sslpAutomatic

Remarks

This property specifies the SSL/TLS implementation to use. In most cases the default value of 0 (Automatic) is recommended and should not be changed. When set to 0 (Automatic) the component will select whether to use the platform implementation or the internal implementation depending on the operating system as well as the TLS version being used.

Possible values are:

In most cases using the default value (Automatic) is recommended. The component will select a provider depending on the current platform.

When Automatic is selected the platform implementation is used by default. When TLS 1.3 is enabled via SSLEnabledProtocols the internal implementation is used.

Data Type

Integer

SSLServerCertEncoded Property (OneDrive Component)

This is the certificate (PEM/Base64 encoded).

Syntax

__property String SSLServerCertEncoded = { read=FSSLServerCertEncoded };
__property DynamicArray<Byte> SSLServerCertEncodedB = { read=FSSLServerCertEncodedB };

Default Value

""

Remarks

This is the certificate (PEM/Base64 encoded). This property is used to assign a specific certificate. The SSLServerCertStore and SSLServerCertSubject properties also may be used to specify a certificate.

When SSLServerCertEncoded is set, a search is initiated in the current SSLServerCertStore for the private key of the certificate. If the key is found, SSLServerCertSubject is updated to reflect the full subject of the selected certificate; otherwise, SSLServerCertSubject is set to an empty string.

This property is read-only and not available at design time.

Data Type

Byte Array

StartByte Property (OneDrive Component)

The byte offset from which to start the upload or download.

Syntax

__property __int64 StartByte = { read=FStartByte, write=FSetStartByte };

Default Value

0

Remarks

This property may be set to resume an upload or download; it specifies the offset in the file from which to resume. See UploadFile and DownloadFile for details about resuming uploads and downloads.

This property is not available at design time.

Data Type

Long64

Timeout Property (OneDrive Component)

A timeout for the component.

Syntax

__property int Timeout = { read=FTimeout, write=FSetTimeout };

Default Value

60

Remarks

If the Timeout property is set to 0, all operations will run uninterrupted until successful completion or an error condition is encountered.

If Timeout is set to a positive value, the component will wait for the operation to complete before returning control.

The component will use DoEvents to enter an efficient wait loop during any potential waiting period, making sure that all system events are processed immediately as they arrive. This ensures that the host application does not "freeze" and remains responsive.

If Timeout expires, and the operation is not yet complete, the component raises an exception.

Please note that by default, all timeouts are inactivity timeouts, i.e. the timeout period is extended by Timeout seconds when any amount of data is successfully sent or received.

The default value for the Timeout property is 60 seconds.

Data Type

Integer

UseResumableUpload Property (OneDrive Component)

Whether to use resumable uploads.

Syntax

__property bool UseResumableUpload = { read=FUseResumableUpload, write=FSetUseResumableUpload };

Default Value

false

Remarks

This property controls whether simple or resumable uploads are used when UploadFile is called. The default value is false (simple uploads are used).

Refer to UploadFile for more information.

This property is not available at design time.

Data Type

Boolean

AbortUpload Method (OneDrive Component)

Aborts the current resumable upload session.

Syntax

void __fastcall AbortUpload();

Remarks

This method aborts the current resumable upload session specified by ResumeURL. It may be called if the current resumable upload has been interrupted and will not be resumed.

AddQueryParam Method (OneDrive Component)

Adds a query parameter to the QueryParams properties.

Syntax

void __fastcall AddQueryParam(String Name, String Value);

Remarks

This method is used to add a query parameter to the QueryaParam* properties. Name specifies the name of the parameter, and Value specifies the value of the parameter.

All specified Values will be URL encoded by the component automatically. Consult the service documentation for details on the available parameters.

Authorize Method (OneDrive Component)

Get the authorization string required to access the protected resource.

Syntax

void __fastcall Authorize();

Remarks

This method is used to get an access token that is required to access the protected resource. The method will act differently based on what is set in the OAuthClientProfile property and the OAuthGrantType property. This method is not to be used in conjunction with the Authorization property. It should instead be used when setting the OAuth* properties.

For more information, see the introduction section.

CalcAuthorization Method (OneDrive Component)

Calculates the Authorization header based on provided credentials.

Syntax

void __fastcall CalcAuthorization();

Remarks

This method calculates the Authorization value using the values provided in AuthScheme, User and Password.

In most cases this method does not need to be called. The component will automatically calculate any required authorization values when a method is called such as Get or Post.

This method may be useful in cases where the Authorization value needs to be calculated prior to sending a request.

Config Method (OneDrive Component)

Sets or retrieves a configuration setting.

Syntax

String __fastcall Config(String ConfigurationString);

Remarks

Config is a generic method available in every component. It is used to set and retrieve configuration settings for the component.

These settings are similar in functionality to properties, but they are rarely used. In order to avoid "polluting" the property namespace of the component, access to these internal properties is provided through the Config method.

To set a configuration setting named PROPERTY, you must call Config("PROPERTY=VALUE"), where VALUE is the value of the setting expressed as a string. For boolean values, use the strings "True", "False", "0", "1", "Yes", or "No" (case does not matter).

To read (query) the value of a configuration setting, you must call Config("PROPERTY"). The value will be returned as a string.

CopyResource Method (OneDrive Component)

Copies the currently selected resource.

Syntax

void __fastcall CopyResource(String ParentId, String NewName);

Remarks

This method copies the resource currently selected by RemoteId or RemotePath. The following outcomes are possible depending on which of NewName and ParentId are provided:

ParentId, if provided, must either be the Id of a folder resource that already exists in the drive currently selected by Drive, or root (an alias for the root of the drive).

Monitoring Copy Operations

All copy operations are asynchronous. After calling CopyResource, the CopyStatusURL configuration setting will be populated with a copy operation monitor URL.

The PollCopyStatus method can be used to retrieve the latest status of the copy operation specified by the CopyStatusURL configuration setting. Calling PollCopyStatus will populate the CopyPercentDone, CopyStatus, and (if applicable) CopiedResourceId properties.

CreateFolder Method (OneDrive Component)

Creates a new folder resource.

Syntax

String __fastcall CreateFolder(String FolderName);

Remarks

This method creates a new folder resource, with the given FolderName, within the folder resource currently selected by RemoteId or RemotePath. The Id of the newly-created folder resource is returned.

If the ClientCreatedTime and/or ClientModifiedTime configuration settings are non-empty when this method is called, the corresponding timestamps will be submitted with the folder creation request.

Name Conflict Resolution

If the RenameIfExists configuration setting is enabled when this method is called, and the desired FolderName is already in use, the server will modify the name of the new folder resource to be unique. Refer to the RenameIfExists configuration setting for more information.

CreateLink Method (OneDrive Component)

Creates a resource sharing link.

Syntax

String __fastcall CreateLink(bool ReadOnly);

Remarks

This method creates and returns a sharing link for the resource currently selected by RemoteId or RemotePath. The ReadOnly parameter controls whether the link provides view-only or editing access to the resource in question.

For OneDrive for Business and SharePoint Online resources, the CreateLinkScope configuration setting can also be used to control the access scope used to create the link. // Create a read-only shared link for the given file. onedrive.RemotePath = "/work_stuff/serious_business/best_cat_pictures.zip"; string sharingUrl = onedrive.CreateLink(true);

DeleteResource Method (OneDrive Component)

Deletes the currently selected resource.

Syntax

void __fastcall DeleteResource();

Remarks

This method deletes the resource currently selected by RemoteId or RemotePath. When deleting a folder resource, all of its contents are also deleted.

Important: Resources are deleted permanently!

DownloadFile Method (OneDrive Component)

Downloads the currently selected file resource.

Syntax

void __fastcall DownloadFile();

Remarks

This method downloads the file resource currently selected by RemoteId or RemotePath.

If LocalFile is set, the file will be saved to the specified location; otherwise, the file data will be held by ResourceData.

To download and decrypt an encrypted file, set EncryptionAlgorithm and EncryptionPassword before calling this method.

Download Notes

In the simplest use-case, downloading a file looks like this: onedrive.LocalFile = "../MyFile.zip"; onedrive.RemoteId = onedrive.Resources[0].Id; onedrive.DownloadFile();

Resuming Downloads

The component also supports resuming failed downloads by using the StartByte property. If a download is interrupted, set StartByte to the appropriate offset before calling this method to resume the download. string downloadFile = "../MyFile.zip"; onedrive.LocalFile = downloadFile; onedrive.RemoteId = onedrive.Resources[0].Id; onedrive.DownloadFile(); //The transfer is interrupted and DownloadFile() above fails. Later, resume the download: //Get the size of the partially downloaded file onedrive.StartByte = new FileInfo(downloadFile).Length; onedrive.DownloadFile();

Resuming Encrypted File Downloads

Resuming encrypted file downloads is only supported when LocalFile was set in the initial download attempt.

If LocalFile is set when beginning an encrypted download, the component creates a temporary file in TempPath to hold the encrypted data until the download is complete. If the download is interrupted, DownloadTempFile will be populated with the path of the temporary file that holds the partial data.

To resume, DownloadTempFile must be populated, along with StartByte, to allow the remainder of the encrypted data to be downloaded. Once the encrypted data is downloaded it will be decrypted and written to LocalFile. onedrive.LocalFile = "../MyFile.zip"; onedrive.EncryptionPassword = "password"; onedrive.RemoteId = onedrive.Resources[0].Id; onedrive.DownloadFile(); //The transfer is interrupted and DownloadFile() above fails. Later, resume the download: //Get the size of the partially download temp file onedrive.StartByte = new FileInfo(onedrive.Config("DownloadTempFile")).Length; onedrive.DownloadFile();

GetCurrentChangeMarker Method (OneDrive Component)

Gets the most current change marker.

Syntax

void __fastcall GetCurrentChangeMarker();

Remarks

This method populates NextChangeMarker with the most current change marker available.

Refer to ListChanges for more information.

GetDriveInfo Method (OneDrive Component)

Gets information about the currently selected drive.

Syntax

void __fastcall GetDriveInfo();

Remarks

This method retrieves information about the drive currently selected by Drive.

Calling this method will fire the DriveList event, and will populate the Drive* properties with a single item (clearing any previously-held items in the process).

GetResourceInfo Method (OneDrive Component)

Gets information about the currently selected resource.

Syntax

void __fastcall GetResourceInfo();

Remarks

This method retrieves information about the resource currently selected by RemoteId or RemotePath.

Calling this method will fire the ResourceList event, and will populate the Resource* properties with a single item (clearing any previously-held items in the process).

Interrupt Method (OneDrive Component)

Interrupt the current method.

Syntax

void __fastcall Interrupt();

Remarks

If there is no method in progress, Interrupt simply returns, doing nothing.

ListChanges Method (OneDrive Component)

Lists changes to resources in the currently selected drive.

Syntax

void __fastcall ListChanges();

Remarks

This method lists changes to resources in the drive currently selected by Drive.

Starting from a Baseline State

For most use-cases, it is necessary to obtain a baseline of the full drive hierarchy in order to have a context onto which later changes can be applied.

To obtain a full drive hierarchy baseline, ensure that both ChangeMarker and NextChangeMarker are empty, and then call ListChanges. Then follow the process described in the "General Usage" section (below) until ChangeMarker is empty, keeping in mind that the results being returned are not necessarily* changes, but rather the current state of all resources in the drive.

*If any resources in the drive are changed before all result pages of the baseline have been returned, OneDrive may append those change items to the end of the baseline's results. Refer to the "Usage Considerations" section (below) for more information.

Starting from the Latest State

For use-cases that don't require a baseline (e.g., perhaps an application just displays a "ticker" with change information), call GetCurrentChangeMarker. This will populate NextChangeMarker immediately.

General Usage

When this method is called, it will use the change marker stored in either ChangeMarker or NextChangeMarker (only one can be populated at a time) to request the next page of changes. This method causes the ResourceList event to fire once for each change, and will also populate the Resource* properties.

If there are still more changes available to list when this method returns, the ChangeMarker property will be populated. Continue to call this method until ChangeMarker is empty to accumulate all pages of results in the Resource* properties. (Once there aren't any more changes available to list, the NextChangeMarker property will be populated instead.)

When NextChangeMarker is populated, it is always populated with a value that (at the time of population) points to the most current state. (Since "the most current state" implies that there are no further changes to list, calling ListChanges immediately after NextChangeMarker is populated will not return any further changes.)

Example of Getting a Baseline and then Listing Changes // Get a full drive hierarchy baseline first. Onedrive onedrive = new Onedrive(); onedrive.ListChanges(); do { // Continue to call ListChanges() until ChangeMarker is the empty string (indicating there // are no more changes to list). onedrive.ListChanges(); } while (onedrive.ChangeMarker.Length > 0); for (int i = 0; i < onedrive.Resources.Count; i++) { // Apply the baseline drive state. } // Now NextChangeMarker will be populated. If we were to call ListChanges() again right now, // nothing would be listed and NextChangeMarker would still be populated. // Wait 2 minutes and then try to list changes again. Assume something changes while we wait. Thread.Sleep(120000); onedrive.ListChanges(); do { onedrive.ListChanges(); } while (onedrive.ChangeMarker.Length > 0); for (int i = 0; i < onedrive.Resources.Count; i++) { // Apply the changes. }

Usage Considerations

• When listing changes, certain resource properties are not included. For example, resource paths are not returned; always use resource Ids when tracking changes.
• It is possible for a resource, uniquely identified by its Id, to appear more than once in a change set. (This can happen if changes are being listed, and then a change occurs before all result pages in the change set are returned; OneDrive will then typically append the new change to the end of the current change set.) Since a OneDrive change always reflects the latest state of a resource, just use the latest one.
• OneDrive will report a change when a resource is created, renamed, modified, or deleted; but it only explicitly specifies deletions. However, it is easy to differentiate between the other change events by keeping track of resource Ids, names, and last modified times; and then comparing old and new values when changes arrive.

ListDrives Method (OneDrive Component)

Lists the drives accessible by the user.

Syntax

void __fastcall ListDrives();

Remarks

This method lists the drives accessible to the current user.

Calling this method will fire the DriveList event once for each drive, and will also populate the Drive* properties.

If there are still more drives available to list when this method returns, the DriveMarker property will be populated. Continue to call this method until DriveMarker is empty to accumulate all pages of results in the Drive* properties.

The ListDrivesScope configuration setting can be used to control which drives are listed; by default only drives the user directly owns are returned. Refer to ListDrivesScope for more information.

Note: For use-cases that only make use of the current user's default drive (e.g., when authenticated with a personal Microsoft account), there is no need to ever call ListDrives, set the Drive property, or use any of the component's other drive-related API members. By default, the Drive property and the GroupId and SiteId configuration settings are all empty, which causes the component to use the current user's default drive. // DriveList event handler. onedrive.OnDriveList += (s, e) => { Console.WriteLine(e.Name); }; do { onedrive.ListDrives(); for (int i = 0; i < onedrive.Drives.Count; i++) { // Process drives here. } } while (!string.IsNullOrEmpty(onedrive.DriveMarker));

ListResources Method (OneDrive Component)

Lists resources in the currently selected folder.

Syntax

void __fastcall ListResources();

Remarks

This method lists resources in the folder resource currently selected by RemoteId or RemotePath.

Calling this method will fire the ResourceList event once for each resource, and will also populate the Resource* properties.

If there are still more resources available to list when this method returns, the ResourceMarker property will be populated. Continue to call this method until ResourceMarker is empty to accumulate all pages of results in the Resource* properties.

For more complex queries, use the Search method. // ResourceList event handler. onedrive.OnResourceList += (s, e) => { Console.WriteLine(e.Name); }; // (Assume that the RemoteId property isn't set; it takes precedence if it is.) onedrive.RemotePath = "/work_files/serious_business/cats"; do { onedrive.ListResources(); for (int i = 0; i < onedrive.Resources.Count; i++) { // Process resources here. } } while (!string.IsNullOrEmpty(onedrive.ResourceMarker));

MoveResource Method (OneDrive Component)

Moves the currently selected resource.

Syntax

void __fastcall MoveResource(String ParentId);

Remarks

This method moves the resource currently selected by RemoteId or RemotePath to the folder specified by ParentId.

ParentId must either be the Id of a folder resource that already exists in the drive currently selected by Drive, or root (an alias for the root of the drive).

PollCopyStatus Method (OneDrive Component)

Gets the status of a copy operation.

Syntax

void __fastcall PollCopyStatus();

Remarks

This method retrieves the latest status information for the copy operation specified by the CopyStatusURL configuration setting.

After calling this method, the CopyPercentDone, CopyStatus, and (if applicable) CopiedResourceId properties will be populated.

Refer to CopyResource, as well as the properties mentioned above, for more information.

PollUploadStatus Method (OneDrive Component)

Gets the status of the current resumable upload session.

Syntax

void __fastcall PollUploadStatus();

Remarks

This method retrieves the status of the resumable upload session specified by ResumeURL.

After calling this method, the StartByte property and UploadExpDate configuration setting will be populated.

Reset Method (OneDrive Component)

Resets the component to its initial state.

Syntax

void __fastcall Reset();

Remarks

This method resets the component to its initial state.

Search Method (OneDrive Component)

Searches for resources that match the specified query.

Syntax

void __fastcall Search(String Query);

Remarks

This method searches for resources that match the given Query within the folder resource currently selected by RemoteId or RemotePath. The value provided for Query will automatically be URL-encoded.

Calling this method will fire the ResourceList event once for each search result, and will also populate the Resource* properties.

If there are still more search results available to list when this method returns, the SearchMarker property will be populated. Continue to call this method until SearchMarker is empty to accumulate all pages of results in the Resource* properties.

SendCustomRequest Method (OneDrive Component)

Sends a custom request to the Microsoft Graph API.

Syntax

void __fastcall SendCustomRequest(String HttpMethod, String RequestPath, String RequestBody);

Remarks

This method can be used to send arbitrary requests to the Microsoft Graph API.

Valid values for HttpMethod are:

• GET (default if empty)
• HEAD
• POST
• PUT
• PATCH
• DELETE

The value passed for RequestPath must already be URL-encoded in a manner acceptable to the Microsoft Graph API. The RequestBody parameter may be empty if not needed.

Usage

When this method is called, the component does the following:

1. Builds a request URL, including query parameters, as follows:
   • The specified RequestPath is appended to the Microsoft Graph API's "stable" endpoint, https://graph.microsoft.com/v1.0 (however, see note below).
   • All query parameters in the QueryParam* properties are added to the request URL.
2. Sends the request using the specified HttpMethod, the request URL build in step 1, the header information held by Authorization and OtherHeaders, and the given RequestBody (if non-empty).
3. Stores the response headers in the ParsedHeader* properties, and the response body in the specified LocalFile, or ResourceData (using the same logic as DownloadFile).

If the response body is JSON data, the XPath, XText, and other X* configuration settings can then be used to navigate and extract information from it.

Note: Some responses returned by the Graph API include fully-qualified Graph API URLs for clients to use to obtain additional information (the next page of results in a listing, details about a long-running operation, etc.). As a convenience, any fully-qualified URL that begins with https://graph.microsoft.com/ can be passed for RequestPath to have the component make a request against it.

UpdateResource Method (OneDrive Component)

Updates the currently selected resource.

Syntax

void __fastcall UpdateResource();

Remarks

This method updates the metadata for the file or folder resource currently selected by RemoteId or RemotePath. For file resources, the file data can optionally be updated as well.

Usage

1. If necessary, call GetResourceInfo or ListResources to ensure an item with the resource's latest information is present in the Resource* properties.
2. Modify the item's Resource* properties as desired; the following properties are supported:
   • ResourceDescription (only updated if not empty; only applicable for OneDrive Personal)
   • ResourceName
   • ResourceParentId (only updated if not empty)
   • ResourceParentPath (only updated if not empty and ResourceParentId is empty)
   If the ClientCreatedTime and/or ClientModifiedTime configuration settings is non-empty, the corresponding timestamps will be sent as well.
3. For file resources, you may set LocalFile or ResourceData if you wish to update the file data on the server. (Refer to UploadFile for more information about simple vs. resumable uploads and encrypting the file data before uploading.)
4. Finally, call this method to update the resource.

Name Conflict Resolution

1. If the RenameIfExists configuration setting is enabled, the server will modify the new name of the resource to be unique, if necessary. Refer to the RenameIfExists configuration setting for more information.
2. Otherwise, if the Overwrite property is enabled, the server will replace the existing (other) resource with the one being updated.
3. Otherwise, the server will return an error.

UploadFile Method (OneDrive Component)

Uploads a new file resource.

Syntax

String __fastcall UploadFile(String FileName);

Remarks

This method uploads a new file resource, with the given FileName (which should include a file extension), to the folder resource currently selected by RemoteId or RemotePath. The Id of the newly-created file resource is returned.

If the ClientCreatedTime and/or ClientModifiedTime configuration settings are non-empty when this method is called, the corresponding timestamps will be submitted with the file upload request.

If LocalFile is set the file will be uploaded from the specified path. If LocalFile is not set the data in ResourceData will be used.

To encrypt the file before uploading it, set EncryptionAlgorithm and EncryptionPassword.

Upload Notes

OneDrive offers two ways to upload a file. For smaller files a simple upload option is provided to upload data in one request. This is the default option. For larger files, uploads can be fragmented into multiple pieces, allowing resuming of uploads that may be interrupted.

Simple

By default the component uses the simple upload mechanism. onedrive.LocalFile = "../MyFile.zip"; onedrive.UploadFile("MyFile.zip");

Resumable

To enable resumable uploads set UseResumableUpload to true. This is recommended for large files. The component will automatically fragment the specified file into smaller pieces and upload each individually. FragmentSize may be set to specify the size of the fragment if desired. The default fragment size is 10 MB.

When UseResumableUpload is set to true and UploadFile is called, a resumable upload session is started by the component. ResumeURL is populated with a URL identifying the session (this value may be needed for additional operations if the upload does not complete normally).

During a resumable upload, the FragmentComplete event fires after each fragment is uploaded to indicate overall progress. The component also updates StartByte as necessary to indicate the current offset in the file.

If the upload is interrupted for any reason, resuming it is easy. First, verify that ResumeURL and StartByte are populated (if the same instance of the component is used, they should already be populated, and no special action should be needed). Then call UploadFile again to resume the upload at the specified StartByte offset.

Note that if the upload is not resumed after some time the upload session will expire. PollUploadStatus may be used to check the status of a resumable upload, including when it will expire (which is stored in the UploadExpDate configuration setting). An interrupted upload can be aborted explicitly using the AbortUpload method. onedrive.LocalFile = "../MyFile.zip"; onedrive.UploadFile("MyFile.zip"); //The transfer is interrupted and UploadFile() above fails. Later, resume the download. //Using the same instance StartByte and ResumeURL are already populated from the previous //upload attempt. onedrive.UploadFile("MyFile.zip");

Name Conflict Resolution

1. If the RenameIfExists configuration setting is enabled, the server will modify the name of the new file resource to be unique. Refer to the RenameIfExists configuration setting for more information.
2. Otherwise, if the Overwrite property is enabled, the server will replace the existing file resource with the newly-uploaded one.
3. Otherwise, the server will return an error.

DriveList Event (OneDrive Component)

Fires once for each drive returned when listing drives.

Syntax

typedef struct {
  String Id;
  String Name;
  String Description;
  int DriveType;
  String OwnerId;
  String OwnerName;
} TcsOneDriveDriveListEventParams;
typedef void __fastcall (__closure *TcsOneDriveDriveListEvent)(System::TObject* Sender, TcsOneDriveDriveListEventParams *e);
__property TcsOneDriveDriveListEvent OnDriveList = { read=FOnDriveList, write=FOnDriveList };

Remarks

This event fires once for each drives returned when ListDrives or GetDriveInfo is called.

Id is the Id of the drive.

Name is the name of the drive.

Description holds the description of the drive.

DriveType reflects the drive's type. Possible values are:

OwnerId is the Id of the drive's owner.

OwnerName is the name of the drive's owner.

EndTransfer Event (OneDrive Component)

This event fires when a document finishes transferring.

Syntax

typedef struct {
  int Direction;
} TcsOneDriveEndTransferEventParams;
typedef void __fastcall (__closure *TcsOneDriveEndTransferEvent)(System::TObject* Sender, TcsOneDriveEndTransferEventParams *e);
__property TcsOneDriveEndTransferEvent OnEndTransfer = { read=FOnEndTransfer, write=FOnEndTransfer };

Remarks

The EndTransfer event is fired when the document text finishes transferring from the server to the local host.

The Direction parameter shows whether the client (0) or the server (1) is sending the data.

Error Event (OneDrive Component)

Fired when information is available about errors during data delivery.

Syntax

typedef struct {
  int ErrorCode;
  String Description;
} TcsOneDriveErrorEventParams;
typedef void __fastcall (__closure *TcsOneDriveErrorEvent)(System::TObject* Sender, TcsOneDriveErrorEventParams *e);
__property TcsOneDriveErrorEvent OnError = { read=FOnError, write=FOnError };

Remarks

The Error event is fired in case of exceptional conditions during message processing. Normally the component raises an exception.

The ErrorCode parameter contains an error code, and the Description parameter contains a textual description of the error. For a list of valid error codes and their descriptions, please refer to the Error Codes section.

FragmentComplete Event (OneDrive Component)

Fires after each fragment of a resumable upload is completed.

Syntax

typedef struct {
  int FragmentNumber;
  int FragmentCount;
  bool Interrupt;
} TcsOneDriveFragmentCompleteEventParams;
typedef void __fastcall (__closure *TcsOneDriveFragmentCompleteEvent)(System::TObject* Sender, TcsOneDriveFragmentCompleteEventParams *e);
__property TcsOneDriveFragmentCompleteEvent OnFragmentComplete = { read=FOnFragmentComplete, write=FOnFragmentComplete };

Remarks

When UseResumableUpload is true and UploadFile is called, this event will fire after each fragment is uploaded, providing an indication of overall upload progress.

FragmentNumber is the number of the current fragment that has completed. This value starts at 1.

FragmentCount is the total number of fragments that will be uploaded.

Interrupt can be set to true to interrupt the upload. The upload may be resumed later.

Header Event (OneDrive Component)

This event is fired every time a header line comes in.

Syntax

typedef struct {
  String Field;
  String Value;
} TcsOneDriveHeaderEventParams;
typedef void __fastcall (__closure *TcsOneDriveHeaderEvent)(System::TObject* Sender, TcsOneDriveHeaderEventParams *e);
__property TcsOneDriveHeaderEvent OnHeader = { read=FOnHeader, write=FOnHeader };

Remarks

The Field parameter contains the name of the HTTP header (which is the same as it is delivered). The Value parameter contains the header contents.

If the header line being retrieved is a continuation header line, then the Field parameter contains "" (empty string).

Log Event (OneDrive Component)

This event fires once for each log message.

Syntax

typedef struct {
  int LogLevel;
  String Message;
  String LogType;
} TcsOneDriveLogEventParams;
typedef void __fastcall (__closure *TcsOneDriveLogEvent)(System::TObject* Sender, TcsOneDriveLogEventParams *e);
__property TcsOneDriveLogEvent OnLog = { read=FOnLog, write=FOnLog };

Remarks

This event fires once for each log message generated by the component. The verbosity is controlled by the LogLevel setting.

LogLevel indicates the level of message. Possible values are as follows:

The value 1 (Info) logs basic information, including the URL, HTTP version, and status details.

The value 2 (Verbose) logs additional information about the request and response.

The value 3 (Debug) logs the headers and body for both the request and response, as well as additional debug information (if any).

Message is the log entry.

LogType identifies the type of log entry. Possible values are as follows:

• "Info"
• "RequestHeaders"
• "ResponseHeaders"
• "RequestBody"
• "ResponseBody"
• "ProxyRequest"
• "ProxyResponse"
• "FirewallRequest"
• "FirewallResponse"

Progress Event (OneDrive Component)

Fires during an upload or download to indicate transfer progress.

Syntax

typedef struct {
  int Direction;
  __int64 BytesTransferred;
  __int64 TotalBytes;
  int PercentDone;
} TcsOneDriveProgressEventParams;
typedef void __fastcall (__closure *TcsOneDriveProgressEvent)(System::TObject* Sender, TcsOneDriveProgressEventParams *e);
__property TcsOneDriveProgressEvent OnProgress = { read=FOnProgress, write=FOnProgress };

Remarks

This event fires during an upload or download to indicate the progress of the transfer of the entire request. By default, this event will fire each time PercentDone increases by one percent; the ProgressStep configuration setting can be used to alter this behavior.

Direction indicates whether the transfer is an upload (0) or a download (1).

BytesTransferred reflects the number of bytes that have been transferred so far, or 0 if the transfer is starting (however, see note below).

TotalBytes reflects the total number of bytes that are to be transferred, or -1 if the total is unknown. This amount includes the size of everything in the request like HTTP headers.

PercentDone reflects the overall progress of the transfer, or -1 if the progress cannot be calculated.

Note: By default, the component tracks transfer progress absolutely. If a transfer is interrupted and later resumed, the values reported by this event upon and after resumption will account for the data that was transferred before the interruption.

For example, if 10MB of data was successfully transferred before the interruption, then this event will fire with a BytesTransferred value of 10485760 (10MB) when the transfer is first resumed, and then continue to fire with successively greater values as usual.

This behavior can be changed by disabling the ProgressAbsolute configuration setting, in which case the component will treat resumed transfers as "new" transfers. In this case, the BytesTransferred parameter will always be 0 the first time this event fires, regardless of whether the transfer is new or being resumed.

ResourceList Event (OneDrive Component)

Fires once for each resource returned when listing resources or changes.

Syntax

typedef struct {
  String Id;
  String Name;
  String Path;
  String Description;
  int ResourceType;
  String CreatedTime;
  String ModifiedTime;
  __int64 Size;
  String ETag;
  bool Deleted;
} TcsOneDriveResourceListEventParams;
typedef void __fastcall (__closure *TcsOneDriveResourceListEvent)(System::TObject* Sender, TcsOneDriveResourceListEventParams *e);
__property TcsOneDriveResourceListEvent OnResourceList = { read=FOnResourceList, write=FOnResourceList };

Remarks

This event fires once for each resource returned when ListResources, GetResourceInfo, Search, or ListChanges is called.

Id is the Id of the resource.

Name is the name of the resource.

Path is the path to the resource on the server. This parameter will always be empty for ListChanges.

Description holds the description of the resource. This parameter is only applicable for OneDrive Personal.

ResourceType reflects the resource's type. Possible values are:

CreatedTime and ModifiedTime reflect the resource's creation and last modified timestamps. Timestamps are formatted according to ISO 8601 and are always in UTC time.

Size is the size of the resource (for folders, their contents' total size), in bytes. This parameter will always be -1 for ListChanges.

ETag is the ETag of the resource.

Deleted indicates whether the resource has been deleted. This parameter is only applicable for ListChanges, it will always be false otherwise.

SSLServerAuthentication Event (OneDrive Component)

Fired after the server presents its certificate to the client.

Syntax

typedef struct {
  String CertEncoded;
  DynamicArray<Byte> CertEncodedB;
  String CertSubject;
  String CertIssuer;
  String Status;
  bool Accept;
} TcsOneDriveSSLServerAuthenticationEventParams;
typedef void __fastcall (__closure *TcsOneDriveSSLServerAuthenticationEvent)(System::TObject* Sender, TcsOneDriveSSLServerAuthenticationEventParams *e);
__property TcsOneDriveSSLServerAuthenticationEvent OnSSLServerAuthentication = { read=FOnSSLServerAuthentication, write=FOnSSLServerAuthentication };

Remarks

During this event, the client can decide whether or not to continue with the connection process. The Accept parameter is a recommendation on whether to continue or close the connection. This is just a suggestion: application software must use its own logic to determine whether or not to continue.

When Accept is False, Status shows why the verification failed (otherwise, Status contains the string OK). If it is decided to continue, you can override and accept the certificate by setting the Accept parameter to True.

SSLStatus Event (OneDrive Component)

Fired when secure connection progress messages are available.

Syntax

typedef struct {
  String Message;
} TcsOneDriveSSLStatusEventParams;
typedef void __fastcall (__closure *TcsOneDriveSSLStatusEvent)(System::TObject* Sender, TcsOneDriveSSLStatusEventParams *e);
__property TcsOneDriveSSLStatusEvent OnSSLStatus = { read=FOnSSLStatus, write=FOnSSLStatus };

Remarks

The event is fired for informational and logging purposes only. This event tracks the progress of the connection.

StartTransfer Event (OneDrive Component)

This event fires when a document starts transferring (after the headers).

Syntax

typedef struct {
  int Direction;
} TcsOneDriveStartTransferEventParams;
typedef void __fastcall (__closure *TcsOneDriveStartTransferEvent)(System::TObject* Sender, TcsOneDriveStartTransferEventParams *e);
__property TcsOneDriveStartTransferEvent OnStartTransfer = { read=FOnStartTransfer, write=FOnStartTransfer };

Remarks

The StartTransfer event is fired when the document text starts transferring from the server to the local host.

The Direction parameter shows whether the client (0) or the server (1) is sending the data.

Transfer Event (OneDrive Component)

This event is fired while a document transfers (delivers document).

Syntax

typedef struct {
  int Direction;
  __int64 BytesTransferred;
  int PercentDone;
  String Text;
  DynamicArray<Byte> TextB;
} TcsOneDriveTransferEventParams;
typedef void __fastcall (__closure *TcsOneDriveTransferEvent)(System::TObject* Sender, TcsOneDriveTransferEventParams *e);
__property TcsOneDriveTransferEvent OnTransfer = { read=FOnTransfer, write=FOnTransfer };

Remarks

The Text parameter contains the portion of the document text being received. It is empty if data are being posted to the server.

The BytesTransferred parameter contains the number of bytes transferred in this Direction since the beginning of the document text (excluding HTTP response headers).

The Direction parameter shows whether the client (0) or the server (1) is sending the data.

The PercentDone parameter shows the progress of the transfer in the corresponding direction. If PercentDone can not be calculated the value will be -1.

Note: Events are not re-entrant. Performing time-consuming operations within this event will prevent it from firing again in a timely manner and may affect overall performance.

Config Settings (OneDrive Component)

OneDrive Config Settings

<firstlevel>
  <one>value</one>
  <two>
    <item>first</item>
    <item>second</item>
  </two>
  <three>value three</three>
</firstlevel>

{
  "firstlevel": {
    "one": "value",
    "two": ["first", "second"],
    "three": "value three"
  }
}

HTTP Config Settings

TCPClient Config Settings

SSL Config Settings

-----BEGIN CERTIFICATE-----
MIIEKzCCAxOgAwIBAgIRANTET4LIkxdH6P+CFIiHvTowDQYJKoZIhvcNAQELBQAw
...
eWHV5OW1K53o/atv59sOiW5K3crjFhsBOd5Q+cJJnU+SWinPKtANXMht+EDvYY2w
F0I1XhM+pKj7FjDr+XNj
-----END CERTIFICATE-----
\r \n
-----BEGIN CERTIFICATE-----
MIIEFjCCAv6gAwIBAgIQetu1SMxpnENAnnOz1P+PtTANBgkqhkiG9w0BAQUFADBp
..
d8q23djXZbVYiIfE9ebr4g3152BlVCHZ2GyPdjhIuLeH21VbT/dyEHHA
-----END CERTIFICATE-----

-----BEGIN CERTIFICATE-----
MIIEKzCCAxOgAwIBAgIRANTET4LIkxdH6P+CFIiHvTowDQYJKoZIhvcNAQELBQAw
...
eWHV5OW1K53o/atv59sOiW5K3crjFhsBOd5Q+cJJnU+SWinPKtANXMht+EDvYY2w
F0I1XhM+pKj7FjDr+XNj
-----END CERTIFICATE-----
\r \n
-----BEGIN CERTIFICATE-----
MIIEFjCCAv6gAwIBAgIQetu1SMxpnENAnnOz1P+PtTANBgkqhkiG9w0BAQUFADBp
..
d8q23djXZbVYiIfE9ebr4g3152BlVCHZ2GyPdjhIuLeH21VbT/dyEHHA
-----END CERTIFICATE-----

Socket Config Settings

Base Config Settings

Trappable Errors (OneDrive Component)

Common Errors

The component may also return one of the following error codes, which are inherited from other components.

HTTP Errors

The component may also return one of the following error codes, which are inherited from other components.

TCPClient Errors

SSL Errors

TCP/IP Errors