OneDrive Class

Properties Methods Events Configuration Settings Errors

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

Syntax

class ipworkscloud.OneDrive

Remarks

The OneDrive class 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 class supports authentication via OAuth 2.0. First, perform OAuth authentication using the OAuth class 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

list_resources lists resources within the folder resource currently selected by remote_id or remote_path. Calling this method will fire the on_resource_list 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 resource_marker property will be populated. Continue to call this method until resource_marker 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 download_file method downloads the file resource currently selected by remote_id or remote_path.

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

To download and decrypt an encrypted file, set encryption_algorithm and encryption_password 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 class also supports resuming failed downloads by using the start_byte property. If a download is interrupted, set start_byte 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 local_file was set in the initial download attempt.

If local_file is set when beginning an encrypted download, the class 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 start_byte, to allow the remainder of the encrypted data to be downloaded. Once the encrypted data is downloaded it will be decrypted and written to local_file.

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 upload_file method uploads new file resources to the folder resource currently selected by remote_id or remote_path.

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

To encrypt the file before uploading it, set encryption_algorithm and encryption_password.

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 class uses the simple upload mechanism.

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

Resumable

To enable resumable uploads set use_resumable_upload to True. This is recommended for large files. The class 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 use_resumable_upload is set to True and upload_file is called, a resumable upload session is started by the class. resume_url 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 on_fragment_complete event fires after each fragment is uploaded to indicate overall progress. The class also updates start_byte 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 resume_url and start_byte are populated (if the same instance of the class is used, they should already be populated, and no special action should be needed). Then call upload_file again to resume the upload at the specified start_byte offset.

Note that if the upload is not resumed after some time the upload session will expire. poll_upload_status 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 abort_upload 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 class offers advanced functionality beyond simple uploads and downloads. For instance:

Encrypt and decrypt files using the encryption_algorithm and encryption_password properties.
Basic file and folder manipulation and organization using methods such as copy_resource, create_folder, delete_resource, move_resource, and update_resource.
Creation of resource sharing links using create_link.
Change tracking with list_changes.
Advanced resource listing using the search method.
Support for OneDrive for Business and SharePoint Online functionality, including drive selection using list_drives, drive, and other API members.
And more!

Property List

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


authorization	OAuth 2.0 Authorization Token.
change_marker	A marker indicating what page of changes to return next.
copied_resource_id	The Id of a newly-copied resource.
copy_percent_done	Progress percentage of a copy operation.
copy_status	Status of a copy operation.
drive	Selects a drive.
drive_marker	A marker indicating what page of drives to return next.
drive_count	The number of records in the Drive arrays.
drive_deleted_space	The amount of drive space consumed by deleted resources.
drive_description	A description of the drive.
drive_id	The Id of the drive.
drive_name	The name of the drive.
drive_owner_id	The Id of the drive's owner.
drive_owner_name	The name of the drive's owner.
drive_remaining_space	The amount of drive space currently available.
drive_state	The drive's storage quota state.
drive_total_space	The total capacity of the drive.
drive_type	The drive's type.
drive_used_space	The amount of drive space that has been consumed.
encryption_algorithm	The encryption algorithm.
encryption_password	The encryption password.
firewall_auto_detect	This property tells the class whether or not to automatically detect and use firewall system settings, if available.
firewall_type	This property determines the type of firewall to connect through.
firewall_host	This property contains the name or IP address of firewall (optional).
firewall_password	This property contains a password if authentication is to be used when connecting through the firewall.
firewall_port	This property contains the TCP port for the firewall Host .
firewall_user	This property contains a user name if authentication is to be used connecting through a firewall.
idle	The current status of the class.
local_file	The location of the local file.
local_host	The name of the local host or user-assigned IP interface through which connections are initiated or accepted.
next_change_marker	A marker indicating what page of changes to return in the future.
other_headers	Other headers as determined by the user (optional).
overwrite	Whether to overwrite the local or remote file.
parsed_header_count	The number of records in the ParsedHeader arrays.
parsed_header_field	This property contains the name of the HTTP header (same case as it is delivered).
parsed_header_value	This property contains the header contents.
proxy_auth_scheme	This property is used to tell the class which type of authorization to perform when connecting to the proxy.
proxy_auto_detect	This property tells the class whether or not to automatically detect and use proxy system settings, if available.
proxy_password	This property contains a password if authentication is to be used for the proxy.
proxy_port	This property contains the TCP port for the proxy Server (default 80).
proxy_server	If a proxy Server is given, then the HTTP request is sent to the proxy instead of the server otherwise specified.
proxy_ssl	This property determines when to use SSL for the connection to the proxy.
proxy_user	This property contains a user name, if authentication is to be used for the proxy.
query_param_count	The number of records in the QueryParam arrays.
query_param_name	The name of the query parameter.
query_param_value	The value of the query parameter.
remote_id	Selects a remote resource by Id.
remote_path	Selects a remote resource by path.
resource_data	The data that was downloaded, or that should be uploaded.
resource_marker	A marker indicating what page of resources to return next.
resource_count	The number of records in the Resource arrays.
resource_child_count	How many children the resource has.
resource_created_time	The creation timestamp of the resource.
resource_deleted	Whether this resource has been deleted.
resource_description	A description of the resource.
resource_drive_id	The Id of the drive that contains the resource.
resource_e_tag	The ETag of the resource.
resource_hash	A hash of the resource's content.
resource_hash_algorithm	The hash's algorithm.
resource_id	The Id of the resource.
resource_mime_type	The MIME type of the resource.
resource_modified_time	The last modified timestamp of the resource.
resource_name	The name of the resource.
resource_parent_id	The Id of the resource's parent.
resource_parent_path	The path of the resource's parent.
resource_path	The path of the resource.
resource_size	The size of the resource in bytes.
resource_type	The resource's type.
resource_web_url	The resource's web URL.
resume_url	The resumable upload URL.
search_marker	A marker indicating what page of search results to return next.
ssl_accept_server_cert_encoded	The certificate (PEM/base64 encoded).
ssl_cert_encoded	The certificate (PEM/base64 encoded).
ssl_cert_store	The name of the certificate store for the client certificate.
ssl_cert_store_password	If 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.
ssl_cert_store_type	The type of certificate store for this certificate.
ssl_cert_subject	The subject of the certificate used for client authentication.
ssl_server_cert_encoded	The certificate (PEM/base64 encoded).
start_byte	The byte offset from which to start the upload or download.
timeout	A timeout for the class.
use_resumable_upload	Whether to use resumable uploads.

Method List

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


abort_upload	Aborts the current resumable upload session.
add_query_param	Adds a query parameter to the QueryParams properties.
config	Sets or retrieves a configuration setting.
copy_resource	Copies the currently selected resource.
create_folder	Creates a new folder resource.
create_link	Creates a resource sharing link.
delete_resource	Deletes the currently selected resource.
download_file	Downloads the currently selected file resource.
get_current_change_marker	Gets the most current change marker.
get_drive_info	Gets information about the currently selected drive.
get_resource_info	Gets information about the currently selected resource.
interrupt	Interrupt the current method.
list_changes	Lists changes to resources in the currently selected drive.
list_drives	Lists the drives accessible by the user.
list_resources	Lists resources in the currently selected folder.
move_resource	Moves the currently selected resource.
poll_copy_status	Gets the status of a copy operation.
poll_upload_status	Gets the status of the current resumable upload session.
reset	Resets the class to its initial state.
search	Searches for resources that match the specified query.
send_custom_request	Sends a custom request to the Microsoft Graph API.
update_resource	Updates the currently selected resource.
upload_file	Uploads a new file resource.

Event List

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


on_drive_list	Fires once for each drive returned when listing drives.
on_end_transfer	Fired when a document finishes transferring.
on_error	Information about errors during data delivery.
on_fragment_complete	Fires after each fragment of a resumable upload is completed.
on_header	Fired every time a header line comes in.
on_log	Fires once for each log message.
on_progress	Fires during an upload or download to indicate transfer progress.
on_resource_list	Fires once for each resource returned when listing resources or changes.
on_ssl_server_authentication	Fired after the server presents its certificate to the client.
on_ssl_status	Shows the progress of the secure connection.
on_start_transfer	Fired when a document starts transferring (after the headers).
on_transfer	Fired while a document transfers (delivers document).

Configuration Settings

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


AccumulatePages	Whether the class should accumulate subsequent pages of results when listing them.
ClientCreatedTime	The client-side creation time.
ClientModifiedTime	The client-side last modified time.
CopyStatusURL	The URL from which copy status information is obtained.
CopyToDrive	The Id of the drive to copy resources to.
CreateLinkScope	The access scope that should be used to create links.
DownloadTempFile	The temporary file used when downloading encrypted data.
EncryptionIV	The initialization vector to be used for encryption/decryption.
EncryptionKey	The key to use during encryption/decryption.
Endpoint	The Microsoft Graph endpoint that the class should use.
FragmentSize	The fragment size.
GroupId	A group Id, used to modify certain requests.
ListDrivesScope	Controls the set of drives that should be listed.
ListSharedResources	Whether to list the resources that has been shared with the drive account.
MaxResults	The maximum number of results to return.
ProgressAbsolute	Whether the class should track transfer progress absolutely.
ProgressStep	How often the progress event should be fired, in terms of percentage.
RawRequest	Returns the data that was sent to the server.
RawResponse	Returns the data that was received from the server.
RelativePath	A resource path, relative to the currently selected folder Id, to use.
RenameIfExists	Whether 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.
SiteId	A SharePoint site Id, used to modify certain requests.
SubSites	Convenience setting that can be queried to obtain a list of SharePoint subsite Ids.
TempPath	The path to the directory where temporary files are created.
UploadExpDate	The expiration of the resumable upload session.
UserId	Sets the Id of the user to connect with.
UsersGroups	Convenience setting that can be queried to obtain a list of the user's groups' Ids.
XChildCount	The 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.
XElement	The name of the current element.
XParent	The parent of the current element.
XPath	Provides a way to point to a specific element in the returned XML or JSON response.
XSubTree	A snapshot of the current element in the document.
XText	The text of the current element.
AcceptEncoding	Used to tell the server which types of content encodings the client supports.
AllowHTTPCompression	This property enables HTTP compression for receiving data.
AllowHTTPFallback	Whether HTTP/2 connections are permitted to fallback to HTTP/1.1.
Append	Whether to append data to LocalFile.
Authorization	The Authorization string to be sent to the server.
BytesTransferred	Contains the number of bytes transferred in the response data.
ChunkSize	Specifies the chunk size in bytes when using chunked encoding.
CompressHTTPRequest	Set to true to compress the body of a PUT or POST request.
EncodeURL	If set to true the URL will be encoded by the class.
FollowRedirects	Determines what happens when the server issues a redirect.
GetOn302Redirect	If set to true the class will perform a GET on the new location.
HTTP2HeadersWithoutIndexing	HTTP2 headers that should not update the dynamic header table with incremental indexing.
HTTPVersion	The version of HTTP used by the class.
IfModifiedSince	A date determining the maximum age of the desired document.
KeepAlive	Determines whether the HTTP connection is closed after completion of the request.
KerberosSPN	The Service Principal Name for the Kerberos Domain Controller.
LogLevel	The level of detail that is logged.
MaxRedirectAttempts	Limits the number of redirects that are followed in a request.
NegotiatedHTTPVersion	The negotiated HTTP version.
OtherHeaders	Other headers as determined by the user (optional).
ProxyAuthorization	The authorization string to be sent to the proxy server.
ProxyAuthScheme	The authorization scheme to be used for the proxy.
ProxyPassword	A password if authentication is to be used for the proxy.
ProxyPort	Port for the proxy server (default 80).
ProxyServer	Name or IP address of a proxy server (optional).
ProxyUser	A user name if authentication is to be used for the proxy.
SentHeaders	The full set of headers as sent by the client.
StatusLine	The first line of the last response from the server.
TransferredData	The contents of the last response from the server.
TransferredDataLimit	The maximum number of incoming bytes to be stored by the class.
TransferredHeaders	The full set of headers as received from the server.
TransferredRequest	The full request as sent by the client.
UseChunkedEncoding	Enables or Disables HTTP chunked encoding for transfers.
UseIDNs	Whether to encode hostnames to internationalized domain names.
UsePlatformHTTPClient	Whether or not to use the platform HTTP client.
UserAgent	Information about the user agent (browser).
ConnectionTimeout	Sets a separate timeout value for establishing a connection.
FirewallAutoDetect	Tells the class whether or not to automatically detect and use firewall system settings, if available.
FirewallHost	Name or IP address of firewall (optional).
FirewallPassword	Password to be used if authentication is to be used when connecting through the firewall.
FirewallPort	The TCP port for the FirewallHost;.
FirewallType	Determines the type of firewall to connect through.
FirewallUser	A user name if authentication is to be used connecting through a firewall.
KeepAliveInterval	The retry interval, in milliseconds, to be used when a TCP keep-alive packet is sent and no response is received.
KeepAliveTime	The inactivity time in milliseconds before a TCP keep-alive packet is sent.
Linger	When set to True, connections are terminated gracefully.
LingerTime	Time in seconds to have the connection linger.
LocalHost	The name of the local host through which connections are initiated or accepted.
LocalPort	The port in the local host where the class binds.
MaxLineLength	The maximum amount of data to accumulate when no EOL is found.
MaxTransferRate	The transfer rate limit in bytes per second.
ProxyExceptionsList	A semicolon separated list of hosts and IPs to bypass when using a proxy.
TCPKeepAlive	Determines whether or not the keep alive socket option is enabled.
TcpNoDelay	Whether or not to delay when sending packets.
UseIPv6	Whether to use IPv6.
LogSSLPackets	Controls whether SSL packets are logged when using the internal security API.
OpenSSLCADir	The path to a directory containing CA certificates.
OpenSSLCAFile	Name of the file containing the list of CA's trusted by your application.
OpenSSLCipherList	A string that controls the ciphers to be used by SSL.
OpenSSLPrngSeedData	The data to seed the pseudo random number generator (PRNG).
ReuseSSLSession	Determines if the SSL session is reused.
SSLCACertFilePaths	The paths to CA certificate files on Unix/Linux.
SSLCACerts	A newline separated list of CA certificate to use during SSL client authentication.
SSLCheckCRL	Whether to check the Certificate Revocation List for the server certificate.
SSLCipherStrength	The minimum cipher strength used for bulk encryption.
SSLEnabledCipherSuites	The cipher suite to be used in an SSL negotiation.
SSLEnabledProtocols	Used to enable/disable the supported security protocols.
SSLEnableRenegotiation	Whether the renegotiation_info SSL extension is supported.
SSLIncludeCertChain	Whether the entire certificate chain is included in the SSLServerAuthentication event.
SSLNegotiatedCipher	Returns the negotiated ciphersuite.
SSLNegotiatedCipherStrength	Returns the negotiated ciphersuite strength.
SSLNegotiatedCipherSuite	Returns the negotiated ciphersuite.
SSLNegotiatedKeyExchange	Returns the negotiated key exchange algorithm.
SSLNegotiatedKeyExchangeStrength	Returns the negotiated key exchange algorithm strength.
SSLNegotiatedVersion	Returns the negotiated protocol version.
SSLProvider	The name of the security provider to use.
SSLSecurityFlags	Flags that control certificate verification.
SSLServerCACerts	A newline separated list of CA certificate to use during SSL server certificate validation.
TLS12SignatureAlgorithms	Defines the allowed TLS 1.2 signature algorithms when UseInternalSecurityAPI is True.
TLS12SupportedGroups	The supported groups for ECC.
TLS13KeyShareGroups	The groups for which to pregenerate key shares.
TLS13SignatureAlgorithms	The allowed certificate signature algorithms.
TLS13SupportedGroups	The supported groups for (EC)DHE key exchange.
AbsoluteTimeout	Determines whether timeouts are inactivity timeouts or absolute timeouts.
FirewallData	Used to send extra data to the firewall.
InBufferSize	The size in bytes of the incoming queue of the socket.
OutBufferSize	The size in bytes of the outgoing queue of the socket.
BuildInfo	Information about the product's build.
CodePage	The system code page used for Unicode to Multibyte translations.
LicenseInfo	Information about the current license.
ProcessIdleEvents	Whether the class uses its internal event loop to process events when the main thread is idle.
SelectWaitMillis	The length of time in milliseconds the class will wait when DoEvents is called if there are no events to process.
UseInternalSecurityAPI	Tells the class whether or not to use the system security libraries or an internal implementation.

IPWorks Cloud 2020 Python Edition