IPWorks Cloud 2020 ActiveX Edition

Questions / Feedback?

OneDrive Control

Properties   Methods   Events   Configuration Settings   Errors  

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

Syntax

OneDrive

Remarks

The OneDrive control 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 control supports authentication via OAuth 2.0. First, perform OAuth authentication using the OAuth control or a separate process. Once complete you should have an authorization string which looks like:

Bearer ya29.AHES6ZSZEJzATdZYjeihDn5W-VrXSsxEZu5p0pclxGdKKQ
Assign this value to the Authorization property before attempting any operations. 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 control 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 control 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 control uses the simple upload mechanism.

onedrive.LocalFile = "../MyFile.zip";
onedrive.UploadFile("MyFile.zip");

Resumable

To enable resumable uploads set UseResumableUpload to . This is recommended for large files. The control 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 and UploadFile is called, a resumable upload session is started by the control. 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 control 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 control 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 control offers advanced functionality beyond simple uploads and downloads. For instance:

Property List


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

AuthorizationOAuth 2.0 Authorization Token.
ChangeMarkerA marker indicating what page of changes to return next.
CopiedResourceIdThe Id of a newly-copied resource.
CopyPercentDoneProgress percentage of a copy operation.
CopyStatusStatus of a copy operation.
DriveSelects a drive.
DriveMarkerA marker indicating what page of drives to return next.
DriveCountThe number of records in the Drive arrays.
DriveDeletedSpaceThe amount of drive space consumed by deleted resources.
DriveDescriptionA description of the drive.
DriveIdThe Id of the drive.
DriveNameThe name of the drive.
DriveOwnerIdThe Id of the drive's owner.
DriveOwnerNameThe name of the drive's owner.
DriveRemainingSpaceThe amount of drive space currently available.
DriveStateThe drive's storage quota state.
DriveTotalSpaceThe total capacity of the drive.
DriveTypeThe drive's type.
DriveUsedSpaceThe amount of drive space that has been consumed.
EncryptionAlgorithmThe encryption algorithm.
EncryptionPasswordThe encryption password.
FirewallAutoDetectThis property tells the control whether or not to automatically detect and use firewall system settings, if available.
FirewallTypeThis property determines the type of firewall to connect through.
FirewallHostThis property contains the name or IP address of firewall (optional).
FirewallPasswordThis property contains a password if authentication is to be used when connecting through the firewall.
FirewallPortThis property contains the TCP port for the firewall Host .
FirewallUserThis property contains a user name if authentication is to be used connecting through a firewall.
IdleThe current status of the control.
LocalFileThe location of the local file.
LocalHostThe name of the local host or user-assigned IP interface through which connections are initiated or accepted.
NextChangeMarkerA marker indicating what page of changes to return in the future.
OtherHeadersOther headers as determined by the user (optional).
OverwriteWhether to overwrite the local or remote file.
ParsedHeaderCountThe number of records in the ParsedHeader arrays.
ParsedHeaderFieldThis property contains the name of the HTTP header (same case as it is delivered).
ParsedHeaderValueThis property contains the header contents.
ProxyAuthSchemeThis property is used to tell the control which type of authorization to perform when connecting to the proxy.
ProxyAutoDetectThis property tells the control whether or not to automatically detect and use proxy system settings, if available.
ProxyPasswordThis property contains a password if authentication is to be used for the proxy.
ProxyPortThis property contains the TCP port for the proxy Server (default 80).
ProxyServerIf a proxy Server is given, then the HTTP request is sent to the proxy instead of the server otherwise specified.
ProxySSLThis property determines when to use SSL for the connection to the proxy.
ProxyUserThis property contains a user name, if authentication is to be used for the proxy.
QueryParamCountThe number of records in the QueryParam arrays.
QueryParamNameThe name of the query parameter.
QueryParamValueThe value of the query parameter.
RemoteIdSelects a remote resource by Id.
RemotePathSelects a remote resource by path.
ResourceDataThe data that was downloaded, or that should be uploaded.
ResourceMarkerA marker indicating what page of resources to return next.
ResourceCountThe number of records in the Resource arrays.
ResourceChildCountHow many children the resource has.
ResourceCreatedTimeThe creation timestamp of the resource.
ResourceDeletedWhether this resource has been deleted.
ResourceDescriptionA description of the resource.
ResourceDriveIdThe Id of the drive that contains the resource.
ResourceETagThe ETag of the resource.
ResourceHashA hash of the resource's content.
ResourceHashAlgorithmThe hash's algorithm.
ResourceIdThe Id of the resource.
ResourceMIMETypeThe MIME type of the resource.
ResourceModifiedTimeThe last modified timestamp of the resource.
ResourceNameThe name of the resource.
ResourceParentIdThe Id of the resource's parent.
ResourceParentPathThe path of the resource's parent.
ResourcePathThe path of the resource.
ResourceSizeThe size of the resource in bytes.
ResourceTypeThe resource's type.
ResourceWebURLThe resource's web URL.
ResumeURLThe resumable upload URL.
SearchMarkerA marker indicating what page of search results to return next.
SSLAcceptServerCertEncodedThe certificate (PEM/base64 encoded).
SSLCertEncodedThe certificate (PEM/base64 encoded).
SSLCertStoreThe name of the certificate store for the client certificate.
SSLCertStorePasswordIf the certificate store is of a type that requires a password, this property is used to specify that password in order to open the certificate store.
SSLCertStoreTypeThe type of certificate store for this certificate.
SSLCertSubjectThe subject of the certificate used for client authentication.
SSLServerCertEncodedThe certificate (PEM/base64 encoded).
StartByteThe byte offset from which to start the upload or download.
TimeoutA timeout for the control.
UseResumableUploadWhether to use resumable uploads.

Method List


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

AbortUploadAborts the current resumable upload session.
AddQueryParamAdds a query parameter to the QueryParams properties.
ConfigSets or retrieves a configuration setting.
CopyResourceCopies the currently selected resource.
CreateFolderCreates a new folder resource.
CreateLinkCreates a resource sharing link.
DeleteResourceDeletes the currently selected resource.
DownloadFileDownloads the currently selected file resource.
GetCurrentChangeMarkerGets the most current change marker.
GetDriveInfoGets information about the currently selected drive.
GetResourceInfoGets information about the currently selected resource.
InterruptInterrupt the current method.
ListChangesLists changes to resources in the currently selected drive.
ListDrivesLists the drives accessible by the user.
ListResourcesLists resources in the currently selected folder.
MoveResourceMoves the currently selected resource.
PollCopyStatusGets the status of a copy operation.
PollUploadStatusGets the status of the current resumable upload session.
ResetResets the control to its initial state.
SearchSearches for resources that match the specified query.
SendCustomRequestSends a custom request to the Microsoft Graph API.
UpdateResourceUpdates the currently selected resource.
UploadFileUploads a new file resource.

Event List


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

DriveListFires once for each drive returned when listing drives.
EndTransferFired when a document finishes transferring.
ErrorInformation about errors during data delivery.
FragmentCompleteFires after each fragment of a resumable upload is completed.
HeaderFired every time a header line comes in.
LogFires once for each log message.
ProgressFires during an upload or download to indicate transfer progress.
ResourceListFires once for each resource returned when listing resources or changes.
SSLServerAuthenticationFired after the server presents its certificate to the client.
SSLStatusShows the progress of the secure connection.
StartTransferFired when a document starts transferring (after the headers).
TransferFired while a document transfers (delivers document).

Configuration Settings


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

AccumulatePagesWhether the control should accumulate subsequent pages of results when listing them.
ClientCreatedTimeThe client-side creation time.
ClientModifiedTimeThe client-side last modified time.
CopyStatusURLThe URL from which copy status information is obtained.
CopyToDriveThe Id of the drive to copy resources to.
CreateLinkScopeThe access scope that should be used to create links.
DownloadTempFileThe temporary file used when downloading encrypted data.
EncryptionIVThe initialization vector to be used for encryption/decryption.
EncryptionKeyThe key to use during encryption/decryption.
EndpointThe Microsoft Graph endpoint that the control should use.
FragmentSizeThe fragment size.
GroupIdA group Id, used to modify certain requests.
ListDrivesScopeControls the set of drives that should be listed.
ListSharedResourcesWhether to list the resources that has been shared with the drive account.
MaxResultsThe maximum number of results to return.
ProgressAbsoluteWhether the control should track transfer progress absolutely.
ProgressStepHow often the progress event should be fired, in terms of percentage.
RawRequestReturns the data that was sent to the server.
RawResponseReturns the data that was received from the server.
RelativePathA resource path, relative to the currently selected folder Id, to use.
RenameIfExistsWhether to rename newly-created resources in the event of a name conflict.
ResourceClientCreatedTime[i]The client-side creation timestamp of the specified resource.
ResourceClientModifiedTime[i]The client-side last modified timestamp of the specified resource.
SiteIdA SharePoint site Id, used to modify certain requests.
SubSitesConvenience setting that can be queried to obtain a list of SharePoint subsite Ids.
TempPathThe path to the directory where temporary files are created.
UploadExpDateThe expiration of the resumable upload session.
UserIdSets the Id of the user to connect with.
UsersGroupsConvenience setting that can be queried to obtain a list of the user's groups' Ids.
XChildCountThe number of child elements of the current element.
XChildName[i]The name of the child element.
XChildXText[i]The inner text of the child element.
XElementThe name of the current element.
XParentThe parent of the current element.
XPathProvides a way to point to a specific element in the returned XML or JSON response.
XSubTreeA snapshot of the current element in the document.
XTextThe text of the current element.
AcceptEncodingUsed to tell the server which types of content encodings the client supports.
AllowHTTPCompressionThis property enables HTTP compression for receiving data.
AllowHTTPFallbackWhether HTTP/2 connections are permitted to fallback to HTTP/1.1.
AppendWhether to append data to LocalFile.
AuthorizationThe Authorization string to be sent to the server.
BytesTransferredContains the number of bytes transferred in the response data.
ChunkSizeSpecifies the chunk size in bytes when using chunked encoding.
CompressHTTPRequestSet to true to compress the body of a PUT or POST request.
EncodeURLIf set to true the URL will be encoded by the control.
FollowRedirectsDetermines what happens when the server issues a redirect.
GetOn302RedirectIf set to true the control will perform a GET on the new location.
HTTP2HeadersWithoutIndexingHTTP2 headers that should not update the dynamic header table with incremental indexing.
HTTPVersionThe version of HTTP used by the control.
IfModifiedSinceA date determining the maximum age of the desired document.
KeepAliveDetermines whether the HTTP connection is closed after completion of the request.
KerberosSPNThe Service Principal Name for the Kerberos Domain Controller.
LogLevelThe level of detail that is logged.
MaxRedirectAttemptsLimits the number of redirects that are followed in a request.
NegotiatedHTTPVersionThe negotiated HTTP version.
OtherHeadersOther headers as determined by the user (optional).
ProxyAuthorizationThe authorization string to be sent to the proxy server.
ProxyAuthSchemeThe authorization scheme to be used for the proxy.
ProxyPasswordA password if authentication is to be used for the proxy.
ProxyPortPort for the proxy server (default 80).
ProxyServerName or IP address of a proxy server (optional).
ProxyUserA user name if authentication is to be used for the proxy.
SentHeadersThe full set of headers as sent by the client.
StatusLineThe first line of the last response from the server.
TransferredDataThe contents of the last response from the server.
TransferredDataLimitThe maximum number of incoming bytes to be stored by the control.
TransferredHeadersThe full set of headers as received from the server.
TransferredRequestThe full request as sent by the client.
UseChunkedEncodingEnables or Disables HTTP chunked encoding for transfers.
UseIDNsWhether to encode hostnames to internationalized domain names.
UserAgentInformation about the user agent (browser).
ConnectionTimeoutSets a separate timeout value for establishing a connection.
FirewallAutoDetectTells the control whether or not to automatically detect and use firewall system settings, if available.
FirewallHostName or IP address of firewall (optional).
FirewallPasswordPassword to be used if authentication is to be used when connecting through the firewall.
FirewallPortThe TCP port for the FirewallHost;.
FirewallTypeDetermines the type of firewall to connect through.
FirewallUserA user name if authentication is to be used connecting through a firewall.
KeepAliveIntervalThe retry interval, in milliseconds, to be used when a TCP keep-alive packet is sent and no response is received.
KeepAliveTimeThe inactivity time in milliseconds before a TCP keep-alive packet is sent.
LingerWhen set to True, connections are terminated gracefully.
LingerTimeTime in seconds to have the connection linger.
LocalHostThe name of the local host through which connections are initiated or accepted.
LocalPortThe port in the local host where the control binds.
MaxLineLengthThe maximum amount of data to accumulate when no EOL is found.
MaxTransferRateThe transfer rate limit in bytes per second.
ProxyExceptionsListA semicolon separated list of hosts and IPs to bypass when using a proxy.
TCPKeepAliveDetermines whether or not the keep alive socket option is enabled.
TcpNoDelayWhether or not to delay when sending packets.
UseIPv6Whether to use IPv6.
LogSSLPacketsControls whether SSL packets are logged when using the internal security API.
OpenSSLCADirThe path to a directory containing CA certificates.
OpenSSLCAFileName of the file containing the list of CA's trusted by your application.
OpenSSLCipherListA string that controls the ciphers to be used by SSL.
OpenSSLPrngSeedDataThe data to seed the pseudo random number generator (PRNG).
ReuseSSLSessionDetermines if the SSL session is reused.
SSLCACertsA newline separated list of CA certificate to use during SSL client authentication.
SSLCheckCRLWhether to check the Certificate Revocation List for the server certificate.
SSLCipherStrengthThe minimum cipher strength used for bulk encryption.
SSLEnabledCipherSuitesThe cipher suite to be used in an SSL negotiation.
SSLEnabledProtocolsUsed to enable/disable the supported security protocols.
SSLEnableRenegotiationWhether the renegotiation_info SSL extension is supported.
SSLIncludeCertChainWhether the entire certificate chain is included in the SSLServerAuthentication event.
SSLNegotiatedCipherReturns the negotiated ciphersuite.
SSLNegotiatedCipherStrengthReturns the negotiated ciphersuite strength.
SSLNegotiatedCipherSuiteReturns the negotiated ciphersuite.
SSLNegotiatedKeyExchangeReturns the negotiated key exchange algorithm.
SSLNegotiatedKeyExchangeStrengthReturns the negotiated key exchange algorithm strength.
SSLNegotiatedVersionReturns the negotiated protocol version.
SSLProviderThe name of the security provider to use.
SSLSecurityFlagsFlags that control certificate verification.
SSLServerCACertsA newline separated list of CA certificate to use during SSL server certificate validation.
TLS12SignatureAlgorithmsDefines the allowed TLS 1.2 signature algorithms when UseInternalSecurityAPI is True.
TLS12SupportedGroupsThe supported groups for ECC.
TLS13KeyShareGroupsThe groups for which to pregenerate key shares.
TLS13SignatureAlgorithmsThe allowed certificate signature algorithms.
TLS13SupportedGroupsThe supported groups for (EC)DHE key exchange.
AbsoluteTimeoutDetermines whether timeouts are inactivity timeouts or absolute timeouts.
FirewallDataUsed to send extra data to the firewall.
InBufferSizeThe size in bytes of the incoming queue of the socket.
OutBufferSizeThe size in bytes of the outgoing queue of the socket.
CodePageThe system code page used for Unicode to Multibyte translations.
UseInternalSecurityAPITells the control whether or not to use the system security libraries or an internal implementation.

Copyright (c) 2022 /n software inc. - All rights reserved.
IPWorks Cloud 2020 ActiveX Edition - Version 20.0 [Build 8265]