IPWorks Cloud 2020 C++ Builder Edition

Questions / Feedback?

GoogleDrive Component

Properties   Methods   Events   Configuration Settings   Errors  

The GoogleDrive component makes it easy to upload, download, and manage files and folders within Google Drive.

Syntax

TicsGoogleDrive

Remarks

The GoogleDrive component provides an easy-to-use interface for Google Drive. Capabilities include uploading and downloading files, file and folder manipulation and organization, Google Shared Drive support, strong client-side file encryption functionality, and more.

To begin, first create an account and register your application with Google. Consult the Google Drive documentation for more information on this process.

Authentication

This component supports authentication via OAuth 2.0. First, perform OAuth authentication using the OAuth component 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.

Listing Resources

The ListResources method is used to list resources within the scope specified by the ListResourcesScope property.

The ListChildren, ListParents, and GetResourceInfo methods are also available for finer-grained control.

// ResourceList event handler.
googledrive.OnResourceList += (s, e) => {
  Console.WriteLine(e.Name);
};

// List all of the current user's resources.
googledrive.ListResourcesScope = GoogledriveListResourcesScopes.lrsUser;
do {
  googledrive.ListResources();

  for (int i = 0; i < googledrive.Resources.Count; i++) {
    // Process resources here.
  }
} while (!string.IsNullOrEmpty(googledrive.ResourceMarker));

// List all of the resources in the specified shared drive.
googledrive.SharedDrive = "wfsr789vusijfv";
googledrive.ListResourcesScope = GoogledriveListResourcesScopes.lrsSharedDrive;
do {
  googledrive.ListResources();

  for (int i = 0; i < googledrive.Resources.Count; i++) {
    // Process resources here.
  }
} while (!string.IsNullOrEmpty(googledrive.ResourceMarker));

Downloading Files

The DownloadFile method is used to download files.

Download Notes

Downloading an Encrypted File

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

googledrive.LocalFile = "../MyFile.zip";
googledrive.DownloadFile(googledrive.Resources[0].Id, "");

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";
googledrive.LocalFile = downloadFile;
googledrive.DownloadFile(googledrive.Resources[0].Id, "");

//The transfer is interrupted and DownloadFile() above fails. Later, resume the download:

//Get the size of the partially downloaded file
googledrive.StartByte = new FileInfo(downloadFile).Length;
googledrive.DownloadFile(googledrive.Resources[0].Id, "");

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.

googledrive.LocalFile = "../MyFile.zip";
googledrive.EncryptionPassword = "password";
googledrive.DownloadFile(googledrive.Resource[0].Id, "");

//The transfer is interrupted and DownloadFile() above fails. Later, resume the download:

//Get the size of the partially download temp file
googledrive.StartByte = new FileInfo(googledrive.Config("DownloadTempFile")).Length;
googledrive.DownloadFile(googledrive.Resource[0].Id, "");

Uploading Files

The UploadFile method is used to upload files.

Upload Notes

Google Drive 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.

googledrive.LocalFile = "../MyFile.zip";
googledrive.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. GetUploadStatus may be used to check the status of a resumable upload.

googledrive.LocalFile = "../MyFile.zip";
googledrive.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.
googledrive.UploadFile("MyFile.zip", "");

Shared Drive Support

The GoogleDrive component has full support for Google Shared Drives. For the most common use-cases (such as those described above), there is very little difference when using a shared drive versus a personal Google Drive ("My Drive").

For more information about how to use the component with Google Shared Drives, refer to both the shared-drive-specific documentation sections for commonly-used methods like ListResources, MoveResource, UpdatePermissions, etc.; and browse through the documentation for shared-drive-specific methods and properties such as the AddSharedDriveMember and ListSharedDrives methods, the SharedDrive property, etc.

Additional Functionality

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

Property List


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

AccountCanCreateSharedDrivesWhether the account has permission to create shared drives.
AccountDriveUsageAmount of storage used in Google Drive.
AccountEmailThe email address of the account.
AccountNameThe name of the account's user.
AccountPermissionIdThe permission Id associated with the account.
AccountStorageQuotaThe account's storage quota.
AccountStorageUsageAmount of storage used across all Google services.
AccountTrashUsageAmount of storage used by trashed items in Google Drive.
AuthorizationOAuth 2.0 Authorization Token.
ChangeMarkerA marker indicating what page of changes to return next.
ChangeCountThe number of records in the Change arrays.
ChangeRemovedWhether the file or shared drive has been removed.
ChangeResourceIdThe Id of the file to which the change applies.
ChangeSharedDriveIdThe Id of the shared drive.
ChangeTimeThe time of the change.
ChangeTypeWhether the change is for a file or a shared drive.
ChildMarkerA marker when child resources are paged.
ChildCountThe number of records in the Child arrays.
ChildContentAccessibleWhether the resource's content is accessible to less-privileged users.
ChildCreatedTimeThe creation date of the resource.
ChildDescriptionA short description of the resource.
ChildExtensionThe file extension of the resource.
ChildIdThe Id of the resource.
ChildMD5ChecksumThe MD5 checksum of the file resource.
ChildMIMETypeThe MIME type of the resource.
ChildModifiedTimeThe last modified date of the resource.
ChildNameThe name of the resource.
ChildOriginalNameThe original name of the file resource.
ChildOwnerThe name of the resource's owner.
ChildOwnerEmailThe email address of the resource's owner.
ChildParentIdsThe Ids of the resource's parent folders.
ChildSharedDriveIdThe Id of the shared drive the resource is in.
ChildSizeThe size of the file resource in bytes.
ChildStarredWhether the resource is starred.
ChildTrashedWhether the resource is in the trash.
ChildTypeThe resource's type.
ChildViewedWhether the resource has been viewed.
ChildViewLinkA link for opening the resource in a relevant Google editor or viewer in a browser.
EncryptionAlgorithmThe encryption algorithm.
EncryptionPasswordThe encryption password.
FirewallAutoDetectThis property tells the component 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 component.
ListResourcesScopeControls the scope of the results when listing resources.
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).
OverwriteDetermines if local files are overwritten.
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.
PermissionMarkerA marker when permissions are paged.
PermissionCountThe number of records in the Permission arrays.
PermissionAllowFileDiscoveryWhether the permission allows the file or folder to be discovered through search.
PermissionDomainThe domain to which the permission applies.
PermissionEmailThe user or group to which the permission applies.
PermissionIdThe Id of the permission.
PermissionModOpThe operation to perform on the permission.
PermissionRoleThe role specified by the permission.
PermissionTypeThe set of users to which the permission applies.
ProxyAuthSchemeThis property is used to tell the component which type of authorization to perform when connecting to the proxy.
ProxyAutoDetectThis property tells the component 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.
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.
ResourceContentAccessibleWhether the resource's content is accessible to less-privileged users.
ResourceCreatedTimeThe creation date of the resource.
ResourceDescriptionA short description of the resource.
ResourceExtensionThe file extension of the resource.
ResourceIdThe Id of the resource.
ResourceMD5ChecksumThe MD5 checksum of the file resource.
ResourceMIMETypeThe MIME type of the resource.
ResourceModifiedTimeThe last modified date of the resource.
ResourceNameThe name of the resource.
ResourceOriginalNameThe original name of the file resource.
ResourceOwnerThe name of the resource's owner.
ResourceOwnerEmailThe email address of the resource's owner.
ResourceParentIdsThe Ids of the resource's parent folders.
ResourceSharedDriveIdThe Id of the shared drive the resource is in.
ResourceSizeThe size of the file resource in bytes.
ResourceStarredWhether the resource is starred.
ResourceTrashedWhether the resource is in the trash.
ResourceTypeThe resource's type.
ResourceViewedWhether the resource has been viewed.
ResourceViewLinkA link for opening the resource in a relevant Google editor or viewer in a browser.
ResumeURLThe resumable upload URL.
SharedDriveThe shared drive to list file and folder resources for.
SharedDriveMarkerA marker when shared drives are paged.
SharedDriveCountThe number of records in the SharedDrive arrays.
SharedDriveCapabilitiesThe capabilities that the current user has for the shared drive.
SharedDriveCreatedTimeThe creation date of the shared drive.
SharedDriveHiddenWhether the shared drive is hidden from default view.
SharedDriveIdThe Id of the shared drive.
SharedDriveNameThe name of the shared drive.
SharedDriveRestrictionsThe restrictions that apply to the shared drive.
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 component.
UseResumableUploadWhether to use resumable uploads.

Method List


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

AddParentsAdds folders to the list of parents for a file or folder.
AddQueryParamAdds a query parameter to the QueryParams properties.
AddSharedDriveMemberCreates a new shared drive member.
ConfigSets or retrieves a configuration setting.
CopyResourceCopies a file.
CreateFolderCreates a new folder.
CreateSharedDriveCreates a new shared drive.
DeleteResourceDeletes the specified file or folder permanently.
DeleteSharedDriveDeletes a shared drive.
DownloadFileDownloads, and optionally converts, a file.
EmptyTrashPermanently deletes all of the current user's trashed files.
GetAccountInfoGets information about the current user's account and space usage.
GetCurrentChangeMarkerGets the most current change marker.
GetPermissionInfoGets information about a specific permission.
GetResourceInfoGets information about specific files and folders.
GetSharedDriveInfoGets information about a specific shared drive.
GetUploadStatusGets the status of a resumable upload session.
InterruptInterrupt the current method.
ListChangesLists changes to resources and shared drives.
ListChildrenLists the child resources of one or more folders.
ListParentsLists the parent folders of a file or folder.
ListPermissionsLists the permissions for a file, folder, or shared drive.
ListResourcesLists files and folders.
ListSharedDrivesLists shared drives that the current user is a member of.
MoveResourceMoves a file or folder.
RemoveParentsRemoves folders from the list of parents for a file or folder.
RemoveSharedDriveMemberRemoves an existing shared drive member.
ResetResets the component to its initial state.
RestoreResourceRestores a file or folder from the trash.
SendCustomRequestSends a custom request to the Google Drive API.
ToggleSharedDriveHiddenHides or unhides a shared drive.
TrashResourceMoves the specified file or folder to the trash.
UpdatePermissionsCreate, update, and delete permissions on a file, folder, or shared drive.
UpdateResourceUpdates a file or folder.
UpdateSharedDriveUpdates a shared drive.
UpdateSharedDriveMemberUpdates an existing shared drive member's role.
UploadFileUploads, and optionally converts, a new file.

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.

ChangeListFires once for each change when ListChanges is called.
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.
PermissionListThis event fires once for each permission returned when listing permissions.
ProgressFires during an upload or download to indicate transfer progress.
ResourceListFires once for each resource returned when listing resources.
SharedDriveListFires once for each shared drive returned when listing shared drives.
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 component with short descriptions. Click on the links for further details.

AccumulatePagesWhether the component should accumulate subsequent pages of results when listing them.
DocsExportFormatThe file format to export Google Docs files as when downloading.
DownloadTempFileThe temporary file used when downloading encrypted data.
DrawingsExportFormatThe file format to export Google Drawings files as when downloading.
EncryptionIVThe initialization vector to be used for encryption/decryption.
EncryptionKeyThe key to use during encryption/decryption.
FragmentSizeThe fragment size.
IconLink[i]A static, unauthenticated link to the file icon for the specified resource.
IncludeAllFieldsWhether to request all fields when listing resources.
IncludeFolderPropertiesWhether resource properties apply when calling CreateFolder.
ListResourcesModeWhat items to include when listing resources.
MaxPermissionResultsLimits the number of permissions results.
MaxResultsLimits the number of resource and change results.
MaxSharedDriveResultsLimits the number of shared drive results.
NormalizedFileName[i]File name constructed using the specified resource's information.
ProgressAbsoluteWhether the component 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.
ResourceKey[i]The resource key used to access a file.
SearchIncompleteIndicates whether the server declined to search all possible locations when listing resources.
SheetsExportFormatThe file format to export Google Sheets files as when downloading.
SlidesExportFormatThe file format to export Google Slides files as when downloading.
TempPathThe path to the directory where temporary files are created.
TransferOwnershipMust be set to True before modifying permissions in a manner that causes the owner of a resource to change.
UseDomainAdminAccessWhether to make requests using domain administrator permissions.
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 component.
FollowRedirectsDetermines what happens when the server issues a redirect.
GetOn302RedirectIf set to true the component 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 component.
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 component.
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 component 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 component 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.
BuildInfoInformation about the product's build.
CodePageThe system code page used for Unicode to Multibyte translations.
LicenseInfoInformation about the current license.
UseInternalSecurityAPITells the component 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 C++ Builder Edition - Version 20.0 [Build 8265]