GoogleDrive Control

Properties   Methods   Events   Config Settings   Errors  

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

Syntax

GoogleDrive

Remarks

The GoogleDrive control 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.

Authentication

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

The control has the following defaults:

Below is a brief description of the different OAuthClientProfile and OAuthGrantType values that are supported by this control. 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 control. 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 control 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 control 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 control 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 control will use an authorization code to get an access token. For this OAuthGrantType the control 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 control will parse the authorization code, setting the OAuthAuthorizationCode property, from the redirect. Immediately, the control 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 control will not launch the browser and use the refresh token in its request to the token server instead of an authorization code.

Example: GoogleDrive googledrive = new GoogleDrive(); googledrive.OAuth.ClientProfile = CloudOAuthClientProfiles.cocpApplication; googledrive.OAuth.GrantType = OAuthSettingsGrantTypes.cogtAuthorizationCode; googledrive.OAuth.ClientId = CLIENT_ID; googledrive.OAuth.ClientSecret = CLIENT_SECRET; googledrive.Authorize();

Implicit

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

When using the Implicit grant type, the control will request the authorization server to get an access token. For this OAuthGrantType the control 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 control 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 control will not be able to automatically get a fresh token once it expires.

Web Profile

This profile is similar to setting the control to the Application profile and Authorization Code grant type except the control will not launch the browser. It is typically used in situations where there is a back-end that is supporting some front end. This profile expects that OAuthClientId, OAuthClientSecret, OAuthServerAuthURL, OAuthServerTokenURL, and the OAuthReturnURL properties to be set. Before calling the Authorize method, the OAuthWebAuthURL property should be queried to get a URL. This URL should be used to redirect the user to the authorization page for the service provider. The redirect_uri parameter of this URL is mapped to the OAuthReturnURL property. The OAuthReturnURL property should be set to some web server that will parse the authorization code out of the query parameter from the redirect. Once the authorization code is parsed, it should be passed back to the server where it is then set to the OAuthAuthorizationCode property. Once that is set, the Authorize method can be called to exchange the authorization code for an access token and refresh token if provided. The control will then cache these values like normal and use them to make requests. If the OAuthRefreshToken field is set, or a refresh token is cached, then the Authorize method can immediately be called to make a request to the token server to get a new access token.

External OAuth Support

For complex profiles or grant types, or for more control of the flow, it is possible to perform OAuth authentication using the OAuth control or a separate process. Once complete you should have an authorization string which looks like:

Bearer ACCESS_TOKEN_VALUE

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

For Example: Oauth oauth = new Oauth(); oauth.ClientId = "CLIENT_ID"; oauth.ClientSecret = "CLIENT_SECRET"; oauth.AuthorizationScope = "https://www.googleapis.com/auth/gmail.readonly"; oauth.ServerAuthURL = "https://accounts.google.com/o/oauth2/auth"; oauth.ServerTokenURL = "https://www.googleapis.com/auth/drive"; oauth.GrantType = OauthGrantTypes.ogtAuthorizationCode; googledrive.Authorization = oauth.GetAuthorization(); 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 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"; 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 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. 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 control uses the simple upload mechanism. googledrive.LocalFile = "../MyFile.zip"; googledrive.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. 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 control 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 control 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 control 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.
• Enumeration and manipulation of parent-child relationships using the AddParents, ListChildren, ListParents, and RemoveParents methods.
• Resourcing trashing and deletion: DeleteResource, TrashResource, RestoreResource.
• Control over permissions using ListPermissions and UpdatePermissions.
• Change tracking with ListChanges.
• And more!

Property List

---

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

Method List

---

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

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.

Config Settings

---

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

AccountCanCreateSharedDrives Property (GoogleDrive Control)

Whether the account has permission to create shared drives.

Syntax

googledrivecontrol.AccountCanCreateSharedDrives

Default Value

False

Remarks

Whether the account has permission to create shared drives.

This property reflects whether the account has the permissions necessary to create shared drives.

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

Data Type

Boolean

AccountDriveUsage Property (GoogleDrive Control)

Amount of storage used in Google Drive.

Syntax

googledrivecontrol.AccountDriveUsage

Default Value

-1

Remarks

Amount of storage used in Google Drive.

This property reflects the storage usage, in bytes, for all items in the account's Google Drive (including trashed items).

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

Data Type

Long64

AccountEmail Property (GoogleDrive Control)

The email address of the account.

Syntax

googledrivecontrol.AccountEmail

Default Value

""

Remarks

The email address of the account.

This property reflects the email address associated with the account.

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

Data Type

String

AccountName Property (GoogleDrive Control)

The name of the account's user.

Syntax

googledrivecontrol.AccountName

Default Value

""

Remarks

The name of the account's user.

This property reflects the name of the account's user.

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

Data Type

String

AccountPermissionId Property (GoogleDrive Control)

The permission Id associated with the account.

Syntax

googledrivecontrol.AccountPermissionId

Default Value

""

Remarks

The permission Id associated with the account.

This property reflects the permission Id associated with the account. Any permissions (including shared drive memberships) created for this account will include this Id.

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

Data Type

String

AccountStorageQuota Property (GoogleDrive Control)

The account's storage quota.

Syntax

googledrivecontrol.AccountStorageQuota

Default Value

-1

Remarks

The account's storage quota.

This property reflects the account's storage quota, in bytes, across all Google services (Google Drive, Gmail, etc.).

A value of -1 indicates that the account does not have a storage quota (i.e., it has unlimited storage).

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

Data Type

Long64

AccountStorageUsage Property (GoogleDrive Control)

Amount of storage used across all Google services.

Syntax

googledrivecontrol.AccountStorageUsage

Default Value

-1

Remarks

Amount of storage used across all Google services.

This property reflects the account's total storage usage, in bytes, across all Google services (Google Drive, Gmail, etc.).

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

Data Type

Long64

AccountTrashUsage Property (GoogleDrive Control)

Amount of storage used by trashed items in Google Drive.

Syntax

googledrivecontrol.AccountTrashUsage

Default Value

-1

Remarks

Amount of storage used by trashed items in Google Drive.

This property reflects the storage usage, in bytes, for all trashed items in the account's Google Drive.

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

Data Type

Long64

Authorization Property (GoogleDrive Control)

OAuth 2.0 Authorization Token.

Syntax

googledrivecontrol.Authorization[=string]

Default Value

""

Remarks

This control supports authentication via OAuth 2.0. First, perform OAuth authentication using the OAuth property, using the OAuth control or a separate process. If using the OAuth property, then the Authorization property will not be used.

Bearer ACCESS_TOKEN

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.

Data Type

String

ChangeMarker Property (GoogleDrive Control)

A marker indicating what page of changes to return next.

Syntax

googledrivecontrol.ChangeMarker[=string]

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

ChangeCount Property (GoogleDrive Control)

The number of records in the Change arrays.

Syntax

googledrivecontrol.ChangeCount

Default Value

0

Remarks

This property controls the size of the following arrays:

• ChangeRemoved
• ChangeResourceId
• ChangeSharedDriveId
• ChangeTime
• ChangeType

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

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

Data Type

Integer

ChangeRemoved Property (GoogleDrive Control)

Whether the file or shared drive has been removed.

Syntax

googledrivecontrol.ChangeRemoved(ChangeIndex)

Default Value

False

Remarks

Whether the file or shared drive has been removed.

This property indicates whether the file or shared drive to which the change applies has been removed.

The ChangeIndex parameter specifies the index of the item in the array. The size of the array is controlled by the ChangeCount property.

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

Data Type

Boolean

ChangeResourceId Property (GoogleDrive Control)

The Id of the file to which the change applies.

Syntax

googledrivecontrol.ChangeResourceId(ChangeIndex)

Default Value

""

Remarks

The Id of the file to which the change applies.

This property holds the Id of the file to which the change applies.

The ChangeIndex parameter specifies the index of the item in the array. The size of the array is controlled by the ChangeCount property.

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

Data Type

String

ChangeSharedDriveId Property (GoogleDrive Control)

The Id of the shared drive.

Syntax

googledrivecontrol.ChangeSharedDriveId(ChangeIndex)

Default Value

""

Remarks

The Id of the shared drive.

This property holds the Id of the shared drive to which the change applies (if ChangeType is ctSharedDrive (1)), or which owns the file to which the change applies (if ChangeType is ctFile (0)).

The ChangeIndex parameter specifies the index of the item in the array. The size of the array is controlled by the ChangeCount property.

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

Data Type

String

ChangeTime Property (GoogleDrive Control)

The time of the change.

Syntax

googledrivecontrol.ChangeTime(ChangeIndex)

Default Value

""

Remarks

The time of the change.

This property holds the time of the change. This is a combined date-time value (formatted according to RFC 3339).

The ChangeIndex parameter specifies the index of the item in the array. The size of the array is controlled by the ChangeCount property.

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

Data Type

String

ChangeType Property (GoogleDrive Control)

Whether the change is for a file or a shared drive.

Syntax

googledrivecontrol.ChangeType(ChangeIndex)

Possible Values

ctFile(0), 
ctSharedDrive(1)

Default Value

0

Remarks

Whether the change is for a file or a shared drive.

This property indicates whether the change applies to a file or a shared drive. Possible values are:

• ctFile (0)
• ctSharedDrive (1)

The ChangeIndex parameter specifies the index of the item in the array. The size of the array is controlled by the ChangeCount property.

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

Data Type

Integer

ChildMarker Property (GoogleDrive Control)

A marker when child resources are paged.

Syntax

googledrivecontrol.ChildMarker[=string]

Default Value

""

Remarks

This property returns a marker used to iterate over pages of child resources; it's populated when ListChildren is called if the results are paged.

Continue to call ListChildren until this property returns empty string in order to list all resources.

This property is not available at design time.

Data Type

String

ChildCount Property (GoogleDrive Control)

The number of records in the Child arrays.

Syntax

googledrivecontrol.ChildCount

Default Value

0

Remarks

This property controls the size of the following arrays:

• ChildContentAccessible
• ChildCreatedTime
• ChildDescription
• ChildExtension
• ChildId
• ChildMD5Checksum
• ChildMIMEType
• ChildModifiedTime
• ChildName
• ChildOriginalName
• ChildOwner
• ChildOwnerEmail
• ChildParentIds
• ChildSharedDriveId
• ChildSize
• ChildStarred
• ChildTrashed
• ChildType
• ChildViewed
• ChildViewLink

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

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

Data Type

Integer

ChildContentAccessible Property (GoogleDrive Control)

Whether the resource's content is accessible to less-privileged users.

Syntax

googledrivecontrol.ChildContentAccessible(ChildIndex)

Default Value

False

Remarks

Whether the resource's content is accessible to less-privileged users.

This property indicates whether the resource's content is accessible. If the resource is not accessible, it cannot be copied, downloaded, or printed by a users unless they have at least "writer" permissions.

The ChildIndex parameter specifies the index of the item in the array. The size of the array is controlled by the ChildCount property.

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

Data Type

Boolean

ChildCreatedTime Property (GoogleDrive Control)

The creation date of the resource.

Syntax

googledrivecontrol.ChildCreatedTime(ChildIndex)

Default Value

""

Remarks

The creation date of the resource.

This property holds a DateTime string representing the creation date of the resource. This is a combined date-time value (formatted according to RFC 3339).

Note that while this property is writable, the control only uses it as input when UploadFile is called; it is ignored when calling UpdateResource.

The ChildIndex parameter specifies the index of the item in the array. The size of the array is controlled by the ChildCount property.

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

Data Type

String

ChildDescription Property (GoogleDrive Control)

A short description of the resource.

Syntax

googledrivecontrol.ChildDescription(ChildIndex)

Default Value

""

Remarks

A short description of the resource.

This property specifies a short description of the resource.

The ChildIndex parameter specifies the index of the item in the array. The size of the array is controlled by the ChildCount property.

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

Data Type

String

ChildExtension Property (GoogleDrive Control)

The file extension of the resource.

Syntax

googledrivecontrol.ChildExtension(ChildIndex)

Default Value

""

Remarks

The file extension of the resource.

This property indicates the file extension of the resource. It cannot be set, and is empty for folder resources. To specify the extension when creating a new file resource include it when calling UploadFile.

The ChildIndex parameter specifies the index of the item in the array. The size of the array is controlled by the ChildCount property.

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

Data Type

String

ChildId Property (GoogleDrive Control)

The Id of the resource.

Syntax

googledrivecontrol.ChildId(ChildIndex)

Default Value

""

Remarks

The Id of the resource.

This property holds the Id of the resource.

This property must be set before calling UpdateResource.

The ChildIndex parameter specifies the index of the item in the array. The size of the array is controlled by the ChildCount property.

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

Data Type

String

ChildMD5Checksum Property (GoogleDrive Control)

The MD5 checksum of the file resource.

Syntax

googledrivecontrol.ChildMD5Checksum(ChildIndex)

Default Value

""

Remarks

The MD5 checksum of the file resource.

This property holds the MD5 checksum of the resource, if it is a file resource.

The ChildIndex parameter specifies the index of the item in the array. The size of the array is controlled by the ChildCount property.

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

Data Type

String

ChildMIMEType Property (GoogleDrive Control)

The MIME type of the resource.

Syntax

googledrivecontrol.ChildMIMEType(ChildIndex)

Default Value

""

Remarks

The MIME type of the resource.

This property specifies the MIME type of the resource.

When calling UploadFile, this property is ignored in favor of the MimeType parameter of UploadFile.

When calling UpdateResource, this property is only submitted if new file data is being uploaded.

Some Google Drive MIME types:

The ChildIndex parameter specifies the index of the item in the array. The size of the array is controlled by the ChildCount property.

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

Data Type

String

ChildModifiedTime Property (GoogleDrive Control)

The last modified date of the resource.

Syntax

googledrivecontrol.ChildModifiedTime(ChildIndex)

Default Value

""

Remarks

The last modified date of the resource.

This property holds a DateTime string representing the last modified date of the resource. This is a combined date-time value (formatted according to RFC 3339).

The ChildIndex parameter specifies the index of the item in the array. The size of the array is controlled by the ChildCount property.

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

Data Type

String

ChildName Property (GoogleDrive Control)

The name of the resource.

Syntax

googledrivecontrol.ChildName(ChildIndex)

Default Value

""

Remarks

The name of the resource.

This property specifies the name of the resource.

The ChildIndex parameter specifies the index of the item in the array. The size of the array is controlled by the ChildCount property.

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

Data Type

String

ChildOriginalName Property (GoogleDrive Control)

The original name of the file resource.

Syntax

googledrivecontrol.ChildOriginalName(ChildIndex)

Default Value

""

Remarks

The original name of the file resource.

This property specifies the original name of a file resource if the file was uploaded manually, or if the name was set programmatically through the API.

Updating ChildName will not change this value.

The ChildIndex parameter specifies the index of the item in the array. The size of the array is controlled by the ChildCount property.

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

Data Type

String

ChildOwner Property (GoogleDrive Control)

The name of the resource's owner.

Syntax

googledrivecontrol.ChildOwner(ChildIndex)

Default Value

""

Remarks

The name of the resource's owner.

This property holds the name of resource's owner.

The ChildIndex parameter specifies the index of the item in the array. The size of the array is controlled by the ChildCount property.

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

Data Type

String

ChildOwnerEmail Property (GoogleDrive Control)

The email address of the resource's owner.

Syntax

googledrivecontrol.ChildOwnerEmail(ChildIndex)

Default Value

""

Remarks

The email address of the resource's owner.

This property holds the email address of the resource's owner.

The ChildIndex parameter specifies the index of the item in the array. The size of the array is controlled by the ChildCount property.

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

Data Type

String

ChildParentIds Property (GoogleDrive Control)

The Ids of the resource's parent folders.

Syntax

googledrivecontrol.ChildParentIds(ChildIndex)

Default Value

""

Remarks

The Ids of the resource's parent folders.

This property holds a comma-separated list of Ids for the resource's parent folders.

Note that while this property is writable, the control only uses it as input when UploadFile is called. To modify a resource's parents in any other case, use the AddParents, RemoveParents, and MoveResource methods.

The ChildIndex parameter specifies the index of the item in the array. The size of the array is controlled by the ChildCount property.

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

Data Type

String

ChildSharedDriveId Property (GoogleDrive Control)

The Id of the shared drive the resource is in.

Syntax

googledrivecontrol.ChildSharedDriveId(ChildIndex)

Default Value

""

Remarks

The Id of the shared drive the resource is in.

This property holds the Id of the shared drive that the resource is in, if applicable.

The ChildIndex parameter specifies the index of the item in the array. The size of the array is controlled by the ChildCount property.

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

Data Type

String

ChildSize Property (GoogleDrive Control)

The size of the file resource in bytes.

Syntax

googledrivecontrol.ChildSize(ChildIndex)

Default Value

0

Remarks

The size of the file resource in bytes.

This property holds the size of a file resource in bytes. This is only applicable to files.

The ChildIndex parameter specifies the index of the item in the array. The size of the array is controlled by the ChildCount property.

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

Data Type

Long64

ChildStarred Property (GoogleDrive Control)

Whether the resource is starred.

Syntax

googledrivecontrol.ChildStarred(ChildIndex)

Default Value

False

Remarks

Whether the resource is starred.

This property indicates whether the resource is starred by the current user.

The ChildIndex parameter specifies the index of the item in the array. The size of the array is controlled by the ChildCount property.

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

Data Type

Boolean

ChildTrashed Property (GoogleDrive Control)

Whether the resource is in the trash.

Syntax

googledrivecontrol.ChildTrashed(ChildIndex)

Default Value

False

Remarks

Whether the resource is in the trash.

This property indicates whether the resource has been moved to trash.

Note that while this property is writable, the control only uses it as input when UpdateResource is called; it is ignored when calling UploadFile.

The ChildIndex parameter specifies the index of the item in the array. The size of the array is controlled by the ChildCount property.

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

Data Type

Boolean

ChildType Property (GoogleDrive Control)

The resource's type.

Syntax

googledrivecontrol.ChildType(ChildIndex)

Possible Values

gdrtFile(0), 
gdrtFolder(1)

Default Value

0

Remarks

The resource's type.

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

Google treats files and folders in the same way, and folders are included when listing resources. The ResourceType property can be used to determine if a resource is a folder, a file, or a revision of a file.

To list, delete, and update folders use the ListResources, DeleteResource, and UpdateResource methods.

The ChildIndex parameter specifies the index of the item in the array. The size of the array is controlled by the ChildCount property.

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

Data Type

Integer

ChildViewed Property (GoogleDrive Control)

Whether the resource has been viewed.

Syntax

googledrivecontrol.ChildViewed(ChildIndex)

Default Value

False

Remarks

Whether the resource has been viewed.

This property indicates whether the resource has been viewed by the current user.

The ChildIndex parameter specifies the index of the item in the array. The size of the array is controlled by the ChildCount property.

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

Data Type

Boolean

ChildViewLink Property (GoogleDrive Control)

A link for opening the resource in a relevant Google editor or viewer in a browser.

Syntax

googledrivecontrol.ChildViewLink(ChildIndex)

Default Value

""

Remarks

A link for opening the resource in a relevant Google editor or viewer in a browser.

This property holds the link to the resource. The link may be used to view the resource in a browser or relevant editor.

The ChildIndex parameter specifies the index of the item in the array. The size of the array is controlled by the ChildCount property.

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

Data Type

String

EncryptionAlgorithm Property (GoogleDrive Control)

The encryption algorithm.

Syntax

googledrivecontrol.EncryptionAlgorithm[=integer]

Possible Values

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

0

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 (GoogleDrive Control)

The encryption password.

Syntax

googledrivecontrol.EncryptionPassword[=string]

Default Value

""

Remarks

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

The control 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 (GoogleDrive Control)

Whether to automatically detect and use firewall system settings, if available.

Syntax

googledrivecontrol.FirewallAutoDetect[=boolean]

Default Value

False

Remarks

Whether to automatically detect and use firewall system settings, if available.

Data Type

Boolean

FirewallType Property (GoogleDrive Control)

The type of firewall to connect through.

Syntax

googledrivecontrol.FirewallType[=integer]

Possible Values

fwNone(0), 
fwTunnel(1), 
fwSOCKS4(2), 
fwSOCKS5(3), 
fwSOCKS4A(10)

Default Value

0

Remarks

The type of firewall to connect through. The applicable values are as follows:

Data Type

Integer

FirewallHost Property (GoogleDrive Control)

The name or IP address of the firewall (optional).

Syntax

googledrivecontrol.FirewallHost[=string]

Default Value

""

Remarks

The name or IP address of the 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 control fails with an error.

Data Type

String

FirewallPassword Property (GoogleDrive Control)

A password if authentication is to be used when connecting through the firewall.

Syntax

googledrivecontrol.FirewallPassword[=string]

Default Value

""

Remarks

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 control fails with an error.

Data Type

String

FirewallPort Property (GoogleDrive Control)

The Transmission Control Protocol (TCP) port for the firewall Host .

Syntax

googledrivecontrol.FirewallPort[=integer]

Default Value

0

Remarks

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 (GoogleDrive Control)

A username if authentication is to be used when connecting through a firewall.

Syntax

googledrivecontrol.FirewallUser[=string]

Default Value

""

Remarks

A username if authentication is to be used when connecting through a firewall. If FirewallHost is specified, this property and the FirewallPassword property are used to connect and authenticate to the given Firewall. If the authentication fails, the control fails with an error.

Data Type

String

Idle Property (GoogleDrive Control)

The current status of the control.

Syntax

googledrivecontrol.Idle

Default Value

True

Remarks

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

This property is read-only.

Data Type

Boolean

ListResourcesScope Property (GoogleDrive Control)

Controls the scope of the results when listing resources.

Syntax

googledrivecontrol.ListResourcesScope[=integer]

Possible Values

lrsUser(0), 
lrsDomain(1), 
lrsSharedDrive(2), 
lrsAllDrives(3)

Default Value

0

Remarks

This property controls the scope of the results when listing resources with ListResources or ListChildren. Valid values are:

Refer to ListResources for more information.

This property is not available at design time.

Data Type

Integer

LocalFile Property (GoogleDrive Control)

The location of the local file.

Syntax

googledrivecontrol.LocalFile[=string]

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 (GoogleDrive Control)

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

Syntax

googledrivecontrol.LocalHost[=string]

Default Value

""

Remarks

This 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 multihomed hosts (machines with more than one IP interface) setting LocalHost to the IP address of an interface will make the control initiate connections (or accept in the case of server controls) only through that interface. It is recommended to provide an IP address rather than a hostname when setting this property to ensure the desired interface is used.

If the control 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 multihomed 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 (GoogleDrive Control)

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

Syntax

googledrivecontrol.NextChangeMarker[=string]

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 (GoogleDrive Control)

The access token returned by the authorization server.

Syntax

googledrivecontrol.OAuthAccessToken[=string]

Default Value

""

Remarks

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

This property is not available at design time.

Data Type

String

OAuthAuthorizationCode Property (GoogleDrive Control)

The authorization code that is exchanged for an access token.

Syntax

googledrivecontrol.OAuthAuthorizationCode[=string]

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 (GoogleDrive Control)

The scope request or response parameter used during authorization.

Syntax

googledrivecontrol.OAuthAuthorizationScope[=string]

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 (GoogleDrive Control)

The id of the client assigned when registering the application.

Syntax

googledrivecontrol.OAuthClientId[=string]

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 (GoogleDrive Control)

The type of client that is requesting authorization.

Syntax

googledrivecontrol.OAuthClientProfile[=integer]

Possible Values

cocpApplication(0), 
cocpWeb(1)

Default Value

0

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 (GoogleDrive Control)

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

Syntax

googledrivecontrol.OAuthClientSecret[=string]

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 (GoogleDrive Control)

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

Syntax

googledrivecontrol.OAuthGrantType[=integer]

Possible Values

cogtAuthorizationCode(0), 
cogtImplicit(1), 
cogtPassword(2), 
cogtClientCredentials(3)

Default Value

0

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 (GoogleDrive Control)

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

Syntax

googledrivecontrol.OAuthRefreshToken[=string]

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

OAuthRequestRefreshToken Property (GoogleDrive Control)

Specifies whether the control will request a refresh token during authorization.

Syntax

googledrivecontrol.OAuthRequestRefreshToken[=boolean]

Default Value

True

Remarks

Specifies whether the control will request a refresh token during authorization. By default, this value is True.

When True, the control will automatically add the necessary scopes or parameters to obtain a refresh token. When False, this property will have no effect. If the necessary scopes or parameters are specified manually, a refresh token can still be obtained.

Note: This property is only applicable when the OAuthGrantType property is set to cogtAuthorizationCode.

This property is not available at design time.

Data Type

Boolean

OAuthReturnURL Property (GoogleDrive Control)

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

Syntax

googledrivecontrol.OAuthReturnURL[=string]

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 control 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 (GoogleDrive Control)

The URL of the authorization server.

Syntax

googledrivecontrol.OAuthServerAuthURL[=string]

Default Value

""

Remarks

The URL of the authorization server.

This property is not available at design time.

Data Type

String

OAuthServerTokenURL Property (GoogleDrive Control)

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

Syntax

googledrivecontrol.OAuthServerTokenURL[=string]

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 (GoogleDrive Control)

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

Syntax

googledrivecontrol.OAuthWebAuthURL

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 (GoogleDrive Control)

Other headers as determined by the user (optional).

Syntax

googledrivecontrol.OtherHeaders[=string]

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 (Chr$(13) & Chr$(10)) .

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 control beyond what is provided.

This property is not available at design time.

Data Type

String

Overwrite Property (GoogleDrive Control)

Determines if local files are overwritten.

Syntax

googledrivecontrol.Overwrite[=boolean]

Default Value

False

Remarks

This property controls whether local files are overwritten when calling DownloadFile. It is only applicable to local files. The default value is .

Data Type

Boolean

ParsedHeaderCount Property (GoogleDrive Control)

The number of records in the ParsedHeader arrays.

Syntax

googledrivecontrol.ParsedHeaderCount

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 (GoogleDrive Control)

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

Syntax

googledrivecontrol.ParsedHeaderField(ParsedHeaderIndex)

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 (GoogleDrive Control)

This property contains the header contents.

Syntax

googledrivecontrol.ParsedHeaderValue(ParsedHeaderIndex)

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

PermissionMarker Property (GoogleDrive Control)

A marker when permissions are paged.

Syntax

googledrivecontrol.PermissionMarker[=string]

Default Value

""

Remarks

This property returns a marker used to iterate over pages of permissions; it's populated when ListPermissions is called if the results are paged.

Continue to call ListPermissions until this property returns empty string in order to list all permissions.

This property is not available at design time.

Data Type

String

PermissionCount Property (GoogleDrive Control)

The number of records in the Permission arrays.

Syntax

googledrivecontrol.PermissionCount[=integer]

Default Value

0

Remarks

This property controls the size of the following arrays:

• PermissionAllowFileDiscovery
• PermissionDomain
• PermissionEmail
• PermissionId
• PermissionModOp
• PermissionRole
• PermissionType

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

This property is not available at design time.

Data Type

Integer

PermissionAllowFileDiscovery Property (GoogleDrive Control)

Whether the permission allows the file or folder to be discovered through search.

Syntax

googledrivecontrol.PermissionAllowFileDiscovery(PermissionIndex)[=boolean]

Default Value

False

Remarks

Whether the permission allows the file or folder to be discovered through search.

This property indicates whether the permission allows the file or folder to which it applies to be discovered through search.

This property is only applicable if the permission's PermissionType is set to 2 (ptDomain) or 3 (ptAnyone).

The PermissionIndex parameter specifies the index of the item in the array. The size of the array is controlled by the PermissionCount property.

This property is not available at design time.

Data Type

Boolean

PermissionDomain Property (GoogleDrive Control)

The domain to which the permission applies.

Syntax

googledrivecontrol.PermissionDomain(PermissionIndex)[=string]

Default Value

""

Remarks

The domain to which the permission applies.

This property is used to define the domain to which the permission applies when PermissionType is set to 2 (ptDomain).

The PermissionIndex parameter specifies the index of the item in the array. The size of the array is controlled by the PermissionCount property.

This property is not available at design time.

Data Type

String

PermissionEmail Property (GoogleDrive Control)

The user or group to which the permission applies.

Syntax

googledrivecontrol.PermissionEmail(PermissionIndex)[=string]

Default Value

""

Remarks

The user or group to which the permission applies.

This property is used to define the user or group to which the permission applies when PermissionType is set to 0 (ptUser) or 1 (ptGroup).

The PermissionIndex parameter specifies the index of the item in the array. The size of the array is controlled by the PermissionCount property.

This property is not available at design time.

Data Type

String

PermissionId Property (GoogleDrive Control)

The Id of the permission.

Syntax

googledrivecontrol.PermissionId(PermissionIndex)[=string]

Default Value

""

Remarks

The Id of the permission.

This property holds the Id of the permission.

The PermissionIndex parameter specifies the index of the item in the array. The size of the array is controlled by the PermissionCount property.

This property is not available at design time.

Data Type

String

PermissionModOp Property (GoogleDrive Control)

The operation to perform on the permission.

Syntax

googledrivecontrol.PermissionModOp(PermissionIndex)[=integer]

Possible Values

moNone(0), 
moCreate(1), 
moUpdate(2), 
moDelete(3)

Default Value

0

Remarks

The operation to perform on the permission.

This property is used to specify the operation that the control should perform on the permission when UpdatePermissions is called. Valid values are:

Refer to UpdatePermissions for more information.

The PermissionIndex parameter specifies the index of the item in the array. The size of the array is controlled by the PermissionCount property.

This property is not available at design time.

Data Type

Integer

PermissionRole Property (GoogleDrive Control)

The role specified by the permission.

Syntax

googledrivecontrol.PermissionRole(PermissionIndex)[=integer]

Possible Values

prReader(0), 
prCommenter(1), 
prWriter(2), 
prOwner(3), 
prFileOrganizer(4), 
prOrganizer(5)

Default Value

0

Remarks

The role specified by the permission.

This property defines the role specified by the permission. Possible values are:

The PermissionIndex parameter specifies the index of the item in the array. The size of the array is controlled by the PermissionCount property.

This property is not available at design time.

Data Type

Integer

PermissionType Property (GoogleDrive Control)

The set of users to which the permission applies.

Syntax

googledrivecontrol.PermissionType(PermissionIndex)[=integer]

Possible Values

ptUser(0), 
ptGroup(1), 
ptDomain(2), 
ptAnyone(3)

Default Value

0

Remarks

The set of users to which the permission applies.

This property defines the set of users to which the permission role defined in PermissionRole applies.

The PermissionEmail and PermissionDomain properties are used to define the user, group, or domain to which the permission applies. The following table shows which property is associated with which permission type:

The PermissionIndex parameter specifies the index of the item in the array. The size of the array is controlled by the PermissionCount property.

This property is not available at design time.

Data Type

Integer

ProxyAuthScheme Property (GoogleDrive Control)

The type of authorization to perform when connecting to the proxy.

Syntax

googledrivecontrol.ProxyAuthScheme[=integer]

Possible Values

authBasic(0), 
authDigest(1), 
authProprietary(2), 
authNone(3), 
authNtlm(4), 
authNegotiate(5)

Default Value

0

Remarks

The 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 control 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 control. Look at the configuration file for the control 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 (GoogleDrive Control)

Whether to automatically detect and use proxy system settings, if available.

Syntax

googledrivecontrol.ProxyAutoDetect[=boolean]

Default Value

False

Remarks

Whether to automatically detect and use proxy system settings, if available. The default value is .

Data Type

Boolean

ProxyPassword Property (GoogleDrive Control)

A password if authentication is to be used for the proxy.

Syntax

googledrivecontrol.ProxyPassword[=string]

Default Value

""

Remarks

A password 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

ProxyPort Property (GoogleDrive Control)

The Transmission Control Protocol (TCP) port for the proxy Server (default 80).

Syntax

googledrivecontrol.ProxyPort[=integer]

Default Value

80

Remarks

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 (GoogleDrive Control)

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

Syntax

googledrivecontrol.ProxyServer[=string]

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 (GoogleDrive Control)

When to use a Secure Sockets Layer (SSL) for the connection to the proxy.

Syntax

googledrivecontrol.ProxySSL[=integer]

Possible Values

psAutomatic(0), 
psAlways(1), 
psNever(2), 
psTunnel(3)

Default Value

0

Remarks

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 (GoogleDrive Control)

A username if authentication is to be used for the proxy.

Syntax

googledrivecontrol.ProxyUser[=string]

Default Value

""

Remarks

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 (GoogleDrive Control)

The number of records in the QueryParam arrays.

Syntax

googledrivecontrol.QueryParamCount[=integer]

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 (GoogleDrive Control)

The name of the query parameter.

Syntax

googledrivecontrol.QueryParamName(QueryParamIndex)[=string]

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 (GoogleDrive Control)

The value of the query parameter.

Syntax

googledrivecontrol.QueryParamValue(QueryParamIndex)[=string]

Default Value

""

Remarks

The value of the query parameter.

This property specifies the value of the query parameter. The control 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

ResourceData Property (GoogleDrive Control)

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

Syntax

googledrivecontrol.ResourceData[=string]

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.

To read or write binary data to the property, a Variant (Byte Array) version is provided in .ResourceDataB.

This property is not available at design time.

Data Type

Binary String

ResourceMarker Property (GoogleDrive Control)

A marker indicating what page of resources to return next.

Syntax

googledrivecontrol.ResourceMarker[=string]

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.

Note that resources are never paged when calling ListParents or GetResourceInfo.

This property is not available at design time.

Data Type

String

ResourceCount Property (GoogleDrive Control)

The number of records in the Resource arrays.

Syntax

googledrivecontrol.ResourceCount[=integer]

Default Value

0

Remarks

This property controls the size of the following arrays:

• ResourceContentAccessible
• ResourceCreatedTime
• ResourceDescription
• ResourceExtension
• ResourceId
• ResourceMD5Checksum
• ResourceMIMEType
• ResourceModifiedTime
• ResourceName
• ResourceOriginalName
• ResourceOwner
• ResourceOwnerEmail
• ResourceParentIds
• ResourceSharedDriveId
• ResourceSize
• ResourceStarred
• ResourceTrashed
• ResourceType
• ResourceViewed
• ResourceViewLink

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

This property is not available at design time.

Data Type

Integer

ResourceContentAccessible Property (GoogleDrive Control)

Whether the resource's content is accessible to less-privileged users.

Syntax

googledrivecontrol.ResourceContentAccessible(ResourceIndex)[=boolean]

Default Value

False

Remarks

Whether the resource's content is accessible to less-privileged users.

This property indicates whether the resource's content is accessible. If the resource is not accessible, it cannot be copied, downloaded, or printed by a users unless they have at least "writer" permissions.

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

Boolean

ResourceCreatedTime Property (GoogleDrive Control)

The creation date of the resource.

Syntax

googledrivecontrol.ResourceCreatedTime(ResourceIndex)[=string]

Default Value

""

Remarks

The creation date of the resource.

This property holds a DateTime string representing the creation date of the resource. This is a combined date-time value (formatted according to RFC 3339).

Note that while this property is writable, the control only uses it as input when UploadFile is called; it is ignored when 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

ResourceDescription Property (GoogleDrive Control)

A short description of the resource.

Syntax

googledrivecontrol.ResourceDescription(ResourceIndex)[=string]

Default Value

""

Remarks

A short description of the resource.

This property specifies a short description 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

ResourceExtension Property (GoogleDrive Control)

The file extension of the resource.

Syntax

googledrivecontrol.ResourceExtension(ResourceIndex)

Default Value

""

Remarks

The file extension of the resource.

This property indicates the file extension of the resource. It cannot be set, and is empty for folder resources. To specify the extension when creating a new file resource include it when calling UploadFile.

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

ResourceId Property (GoogleDrive Control)

The Id of the resource.

Syntax

googledrivecontrol.ResourceId(ResourceIndex)[=string]

Default Value

""

Remarks

The Id of the resource.

This property holds the Id of the resource.

This property 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

ResourceMD5Checksum Property (GoogleDrive Control)

The MD5 checksum of the file resource.

Syntax

googledrivecontrol.ResourceMD5Checksum(ResourceIndex)

Default Value

""

Remarks

The MD5 checksum of the file resource.

This property holds the MD5 checksum of the resource, if it is a file 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

ResourceMIMEType Property (GoogleDrive Control)

The MIME type of the resource.

Syntax

googledrivecontrol.ResourceMIMEType(ResourceIndex)[=string]

Default Value

""

Remarks

The MIME type of the resource.

This property specifies the MIME type of the resource.

When calling UploadFile, this property is ignored in favor of the MimeType parameter of UploadFile.

When calling UpdateResource, this property is only submitted if new file data is being uploaded.

Some Google Drive MIME types:

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

ResourceModifiedTime Property (GoogleDrive Control)

The last modified date of the resource.

Syntax

googledrivecontrol.ResourceModifiedTime(ResourceIndex)[=string]

Default Value

""

Remarks

The last modified date of the resource.

This property holds a DateTime string representing the last modified date of the resource. This is a combined date-time value (formatted according to RFC 3339).

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

ResourceName Property (GoogleDrive Control)

The name of the resource.

Syntax

googledrivecontrol.ResourceName(ResourceIndex)[=string]

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

ResourceOriginalName Property (GoogleDrive Control)

The original name of the file resource.

Syntax

googledrivecontrol.ResourceOriginalName(ResourceIndex)

Default Value

""

Remarks

The original name of the file resource.

This property specifies the original name of a file resource if the file was uploaded manually, or if the name was set programmatically through the API.

Updating ResourceName will not change this value.

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

ResourceOwner Property (GoogleDrive Control)

The name of the resource's owner.

Syntax

googledrivecontrol.ResourceOwner(ResourceIndex)

Default Value

""

Remarks

The name of the resource's owner.

This property holds the name of resource's owner.

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

ResourceOwnerEmail Property (GoogleDrive Control)

The email address of the resource's owner.

Syntax

googledrivecontrol.ResourceOwnerEmail(ResourceIndex)

Default Value

""

Remarks

The email address of the resource's owner.

This property holds the email address of the resource's owner.

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

ResourceParentIds Property (GoogleDrive Control)

The Ids of the resource's parent folders.

Syntax

googledrivecontrol.ResourceParentIds(ResourceIndex)[=string]

Default Value

""

Remarks

The Ids of the resource's parent folders.

This property holds a comma-separated list of Ids for the resource's parent folders.

Note that while this property is writable, the control only uses it as input when UploadFile is called. To modify a resource's parents in any other case, use the AddParents, RemoveParents, and MoveResource methods.

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

ResourceSharedDriveId Property (GoogleDrive Control)

The Id of the shared drive the resource is in.

Syntax

googledrivecontrol.ResourceSharedDriveId(ResourceIndex)

Default Value

""

Remarks

The Id of the shared drive the resource is in.

This property holds the Id of the shared drive that the resource is in, if applicable.

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

ResourceSize Property (GoogleDrive Control)

The size of the file resource in bytes.

Syntax

googledrivecontrol.ResourceSize(ResourceIndex)

Default Value

0

Remarks

The size of the file resource in bytes.

This property holds the size of a file resource in bytes. This is only applicable to files.

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

ResourceStarred Property (GoogleDrive Control)

Whether the resource is starred.

Syntax

googledrivecontrol.ResourceStarred(ResourceIndex)[=boolean]

Default Value

False

Remarks

Whether the resource is starred.

This property indicates whether the resource is starred by the current user.

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

Boolean

ResourceTrashed Property (GoogleDrive Control)

Whether the resource is in the trash.

Syntax

googledrivecontrol.ResourceTrashed(ResourceIndex)[=boolean]

Default Value

False

Remarks

Whether the resource is in the trash.

This property indicates whether the resource has been moved to trash.

Note that while this property is writable, the control only uses it as input when UpdateResource is called; it is ignored when calling UploadFile.

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

Boolean

ResourceType Property (GoogleDrive Control)

The resource's type.

Syntax

googledrivecontrol.ResourceType(ResourceIndex)

Possible Values

gdrtFile(0), 
gdrtFolder(1)

Default Value

0

Remarks

The resource's type.

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

Google treats files and folders in the same way, and folders are included when listing resources. The ResourceType property can be used to determine if a resource is a folder, a file, or a revision of a file.

To list, delete, and update folders use the ListResources, DeleteResource, and UpdateResource methods.

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

ResourceViewed Property (GoogleDrive Control)

Whether the resource has been viewed.

Syntax

googledrivecontrol.ResourceViewed(ResourceIndex)

Default Value

False

Remarks

Whether the resource has been viewed.

This property indicates whether the resource has been viewed by the current user.

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

ResourceViewLink Property (GoogleDrive Control)

A link for opening the resource in a relevant Google editor or viewer in a browser.

Syntax

googledrivecontrol.ResourceViewLink(ResourceIndex)

Default Value

""

Remarks

A link for opening the resource in a relevant Google editor or viewer in a browser.

This property holds the link to the resource. The link may be used to view the resource in a browser or relevant editor.

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 (GoogleDrive Control)

The resumable upload URL.

Syntax

googledrivecontrol.ResumeURL[=string]

Default Value

""

Remarks

This property holds the URL of the resumable upload session. This is populated by the control automatically when UseResumableUpload is set to 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

SharedDrive Property (GoogleDrive Control)

The shared drive to list file and folder resources for.

Syntax

googledrivecontrol.SharedDrive[=string]

Default Value

""

Remarks

When ListResourcesScope is set to lrsSharedDrive (2), this property must be set to a shared drive resource Id before calling ListResources or ListChildren.

This property may also be set to a shared drive resource Id before calling GetCurrentChangeMarker or ListChanges in order to list changes to the specified shared drive and its contents.

Refer to ListResources or ListChanges for more information.

This property is not available at design time.

Data Type

String

SharedDriveMarker Property (GoogleDrive Control)

A marker when shared drives are paged.

Syntax

googledrivecontrol.SharedDriveMarker[=string]

Default Value

""

Remarks

This property returns a marker used to iterate over pages of shared drives; it's populated when ListSharedDrives is called if the results are paged.

Continue to call ListSharedDrives until this property returns empty string in order to list all shared drives.

This property is not available at design time.

Data Type

String

SharedDriveCount Property (GoogleDrive Control)

The number of records in the SharedDrive arrays.

Syntax

googledrivecontrol.SharedDriveCount

Default Value

0

Remarks

This property controls the size of the following arrays:

• SharedDriveCapabilities
• SharedDriveCreatedTime
• SharedDriveHidden
• SharedDriveId
• SharedDriveName
• SharedDriveRestrictions

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

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

Data Type

Integer

SharedDriveCapabilities Property (GoogleDrive Control)

The capabilities that the current user has for the shared drive.

Syntax

googledrivecontrol.SharedDriveCapabilities(SharedDriveIndex)

Default Value

0

Remarks

The capabilities that the current user has for the shared drive.

This property describes the effective capabilities that the current user has for the shared drive. The value is a bit field comprised of one or more of the following, OR'ed together:

The SharedDriveIndex parameter specifies the index of the item in the array. The size of the array is controlled by the SharedDriveCount property.

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

Data Type

Integer

SharedDriveCreatedTime Property (GoogleDrive Control)

The creation date of the shared drive.

Syntax

googledrivecontrol.SharedDriveCreatedTime(SharedDriveIndex)

Default Value

""

Remarks

The creation date of the shared drive.

This property holds a DateTime string representing the creation date of the shared drive. This is a combined date-time value (formatted according to RFC 3339).

The SharedDriveIndex parameter specifies the index of the item in the array. The size of the array is controlled by the SharedDriveCount property.

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

Data Type

String

SharedDriveHidden Property (GoogleDrive Control)

Whether the shared drive is hidden from default view.

Syntax

googledrivecontrol.SharedDriveHidden(SharedDriveIndex)

Default Value

False

Remarks

Whether the shared drive is hidden from default view.

This property specifies whether the shared drive is hidden from default view. To hide or unhide a shared drive, call the ToggleSharedDriveHidden method.

If a shared drive is hidden, it will not show up in the Google Drive UI by default (but is still otherwise accessible). Google Drive tracks this setting separately for each user; i.e., each member of a shared drive can choose whether the shared drive should be hidden or not.

The SharedDriveIndex parameter specifies the index of the item in the array. The size of the array is controlled by the SharedDriveCount property.

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

Data Type

Boolean

SharedDriveId Property (GoogleDrive Control)

The Id of the shared drive.

Syntax

googledrivecontrol.SharedDriveId(SharedDriveIndex)

Default Value

""

Remarks

The Id of the shared drive.

This property holds the Id of the shared drive.

The SharedDriveIndex parameter specifies the index of the item in the array. The size of the array is controlled by the SharedDriveCount property.

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

Data Type

String

SharedDriveName Property (GoogleDrive Control)

The name of the shared drive.

Syntax

googledrivecontrol.SharedDriveName(SharedDriveIndex)

Default Value

""

Remarks

The name of the shared drive.

This property reflects the name of the shared drive.

The UpdateSharedDrive method can be used to rename the shared drive if the current user is allowed to do so (i.e., if the SharedDriveCapabilities property has the 0x08000 flag set).

The SharedDriveIndex parameter specifies the index of the item in the array. The size of the array is controlled by the SharedDriveCount property.

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

Data Type

String

SharedDriveRestrictions Property (GoogleDrive Control)

The restrictions that apply to the shared drive.

Syntax

googledrivecontrol.SharedDriveRestrictions(SharedDriveIndex)

Default Value

0

Remarks

The restrictions that apply to the shared drive.

This property specifies the restrictions that apply to the shared drive. The value is a bitmask comprised of one or more of the following, OR'ed together:

The UpdateSharedDrive method can be used to change any of the shared drive's restrictions that the current user is allowed to alter (indicated by the presence of the 0x00002, 0x00004, and/or 0x00010 flags in the SharedDriveCapabilities property).

The SharedDriveIndex parameter specifies the index of the item in the array. The size of the array is controlled by the SharedDriveCount property.

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

Data Type

Integer

SSLAcceptServerCertEffectiveDate Property (GoogleDrive Control)

The date on which this certificate becomes valid.

Syntax

googledrivecontrol.SSLAcceptServerCertEffectiveDate

Default Value

""

Remarks

The date on which this certificate becomes valid. Before this date, it is not valid. The date is localized to the system's time zone. The following example illustrates the format of an encoded date:

23-Jan-2000 15:00:00.

This property is read-only.

Data Type

String

SSLAcceptServerCertExpirationDate Property (GoogleDrive Control)

The date on which the certificate expires.

Syntax

googledrivecontrol.SSLAcceptServerCertExpirationDate

Default Value

""

Remarks

The date on which the certificate expires. After this date, the certificate will no longer be valid. The date is localized to the system's time zone. The following example illustrates the format of an encoded date:

23-Jan-2001 15:00:00.

This property is read-only.

Data Type

String

SSLAcceptServerCertExtendedKeyUsage Property (GoogleDrive Control)

A comma-delimited list of extended key usage identifiers.

Syntax

googledrivecontrol.SSLAcceptServerCertExtendedKeyUsage

Default Value

""

Remarks

A comma-delimited list of extended key usage identifiers. These are the same as ASN.1 object identifiers (OIDs).

This property is read-only.

Data Type

String

SSLAcceptServerCertFingerprint Property (GoogleDrive Control)

The hex-encoded, 16-byte MD5 fingerprint of the certificate.

Syntax

googledrivecontrol.SSLAcceptServerCertFingerprint

Default Value

""

Remarks

The hex-encoded, 16-byte MD5 fingerprint of the certificate. This property is primarily used for keys which do not have a corresponding X.509 public certificate, such as PEM keys that only contain a private key. It is commonly used for SSH keys.

The following example illustrates the format: bc:2a:72:af:fe:58:17:43:7a:5f:ba:5a:7c:90:f7:02

This property is read-only.

Data Type

String

SSLAcceptServerCertFingerprintSHA1 Property (GoogleDrive Control)

The hex-encoded, 20-byte SHA-1 fingerprint of the certificate.

Syntax

googledrivecontrol.SSLAcceptServerCertFingerprintSHA1

Default Value

""

Remarks

The hex-encoded, 20-byte SHA-1 fingerprint of the certificate. This property is primarily used for keys which do not have a corresponding X.509 public certificate, such as PEM keys that only contain a private key. It is commonly used for SSH keys.

The following example illustrates the format: 30:7b:fa:38:65:83:ff:da:b4:4e:07:3f:17:b8:a4:ed:80:be:ff:84

This property is read-only.

Data Type

String

SSLAcceptServerCertFingerprintSHA256 Property (GoogleDrive Control)

The hex-encoded, 32-byte SHA-256 fingerprint of the certificate.

Syntax

googledrivecontrol.SSLAcceptServerCertFingerprintSHA256

Default Value

""

Remarks

The hex-encoded, 32-byte SHA-256 fingerprint of the certificate. This property is primarily used for keys which do not have a corresponding X.509 public certificate, such as PEM keys that only contain a private key. It is commonly used for SSH keys.

The following example illustrates the format: 6a:80:5c:33:a9:43:ea:b0:96:12:8a:64:96:30:ef:4a:8a:96:86:ce:f4:c7:be:10:24:8e:2b:60:9e:f3:59:53

This property is read-only.

Data Type

String

SSLAcceptServerCertIssuer Property (GoogleDrive Control)

The issuer of the certificate.

Syntax

googledrivecontrol.SSLAcceptServerCertIssuer

Default Value

""

Remarks

The issuer of the certificate. This property contains a string representation of the name of the issuing authority for the certificate.

This property is read-only.

Data Type

String

SSLAcceptServerCertPrivateKey Property (GoogleDrive Control)

The private key of the certificate (if available).

Syntax

googledrivecontrol.SSLAcceptServerCertPrivateKey

Default Value

""

Remarks

The private key of the certificate (if available). The key is provided as PEM/Base64-encoded data.

Note: The SSLAcceptServerCertPrivateKey may be available but not exportable. In this case, SSLAcceptServerCertPrivateKey returns an empty string.

This property is read-only.

Data Type

String

SSLAcceptServerCertPrivateKeyAvailable Property (GoogleDrive Control)

Whether a PrivateKey is available for the selected certificate.

Syntax

googledrivecontrol.SSLAcceptServerCertPrivateKeyAvailable

Default Value

False

Remarks

Whether a SSLAcceptServerCertPrivateKey is available for the selected certificate. If SSLAcceptServerCertPrivateKeyAvailable is True, the certificate may be used for authentication purposes (e.g., server authentication).

This property is read-only.

Data Type

Boolean

SSLAcceptServerCertPrivateKeyContainer Property (GoogleDrive Control)

The name of the PrivateKey container for the certificate (if available).

Syntax

googledrivecontrol.SSLAcceptServerCertPrivateKeyContainer

Default Value

""

Remarks

The name of the SSLAcceptServerCertPrivateKey container for the certificate (if available). This functionality is available only on Windows platforms.

This property is read-only.

Data Type

String

SSLAcceptServerCertPublicKey Property (GoogleDrive Control)

The public key of the certificate.

Syntax

googledrivecontrol.SSLAcceptServerCertPublicKey

Default Value

""

Remarks

The public key of the certificate. The key is provided as PEM/Base64-encoded data.

This property is read-only.

Data Type

String

SSLAcceptServerCertPublicKeyAlgorithm Property (GoogleDrive Control)

The textual description of the certificate's public key algorithm.

Syntax

googledrivecontrol.SSLAcceptServerCertPublicKeyAlgorithm

Default Value

""

Remarks

The textual description of the certificate's public key algorithm. The property contains either the name of the algorithm (e.g., "RSA" or "RSA_DH") or an object identifier (OID) string representing the algorithm.

This property is read-only.

Data Type

String

SSLAcceptServerCertPublicKeyLength Property (GoogleDrive Control)

The length of the certificate's public key (in bits).

Syntax

googledrivecontrol.SSLAcceptServerCertPublicKeyLength

Default Value

0

Remarks

The length of the certificate's public key (in bits). Common values are 512, 1024, and 2048.

This property is read-only.

Data Type

Integer

SSLAcceptServerCertSerialNumber Property (GoogleDrive Control)

The serial number of the certificate encoded as a string.

Syntax

googledrivecontrol.SSLAcceptServerCertSerialNumber

Default Value

""

Remarks

The serial number of the certificate encoded as a string. The number is encoded as a series of hexadecimal digits, with each pair representing a byte of the serial number.

This property is read-only.

Data Type

String

SSLAcceptServerCertSignatureAlgorithm Property (GoogleDrive Control)

The text description of the certificate's signature algorithm.

Syntax

googledrivecontrol.SSLAcceptServerCertSignatureAlgorithm

Default Value

""

Remarks

The text description of the certificate's signature algorithm. The property contains either the name of the algorithm (e.g., "RSA" or "RSA_MD5RSA") or an object identifier (OID) string representing the algorithm.

This property is read-only.

Data Type

String

SSLAcceptServerCertStore Property (GoogleDrive Control)

The name of the certificate store for the client certificate.

Syntax

googledrivecontrol.SSLAcceptServerCertStore[=string]

Default Value

"MY"

Remarks

The name of the certificate store for the client certificate.

The SSLAcceptServerCertStoreType property denotes the type of the certificate store specified by SSLAcceptServerCertStore. If the store is password-protected, specify the password in SSLAcceptServerCertStorePassword.

SSLAcceptServerCertStore is used in conjunction with the SSLAcceptServerCertSubject property to specify client certificates. If SSLAcceptServerCertStore has a value, and SSLAcceptServerCertSubject or SSLAcceptServerCertEncoded is set, a search for a certificate is initiated. Please see the SSLAcceptServerCertSubject 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 cstPFXFile, this property must be set to the name of the file. When the type is cstPFXBlob, the property must be set to the binary contents of a PFX file (i.e., PKCS#12 certificate store).

To read or write binary data to the property, a Variant (Byte Array) version is provided in .SSLAcceptServerCertStoreB.

Data Type

Binary String

SSLAcceptServerCertStorePassword Property (GoogleDrive Control)

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

Syntax

googledrivecontrol.SSLAcceptServerCertStorePassword[=string]

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

SSLAcceptServerCertStoreType Property (GoogleDrive Control)

The type of certificate store for this certificate.

Syntax

googledrivecontrol.SSLAcceptServerCertStoreType[=integer]

Possible Values

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

0

Remarks

The type of certificate store for this certificate.

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

Data Type

Integer

SSLAcceptServerCertSubjectAltNames Property (GoogleDrive Control)

Comma-separated lists of alternative subject names for the certificate.

Syntax

googledrivecontrol.SSLAcceptServerCertSubjectAltNames

Default Value

""

Remarks

Comma-separated lists of alternative subject names for the certificate.

This property is read-only.

Data Type

String

SSLAcceptServerCertThumbprintMD5 Property (GoogleDrive Control)

The MD5 hash of the certificate.

Syntax

googledrivecontrol.SSLAcceptServerCertThumbprintMD5

Default Value

""

Remarks

The MD5 hash of the certificate. It is primarily used for X.509 certificates. If the hash does not already exist, it is automatically computed.

This property is read-only.

Data Type

String

SSLAcceptServerCertThumbprintSHA1 Property (GoogleDrive Control)

The SHA-1 hash of the certificate.

Syntax

googledrivecontrol.SSLAcceptServerCertThumbprintSHA1

Default Value

""

Remarks

The SHA-1 hash of the certificate. It is primarily used for X.509 certificates. If the hash does not already exist, it is automatically computed.

This property is read-only.

Data Type

String

SSLAcceptServerCertThumbprintSHA256 Property (GoogleDrive Control)

The SHA-256 hash of the certificate.

Syntax

googledrivecontrol.SSLAcceptServerCertThumbprintSHA256

Default Value

""

Remarks

The SHA-256 hash of the certificate. It is primarily used for X.509 certificates. If the hash does not already exist, it is automatically computed.

This property is read-only.

Data Type

String

SSLAcceptServerCertUsage Property (GoogleDrive Control)

The text description of UsageFlags .

Syntax

googledrivecontrol.SSLAcceptServerCertUsage

Default Value

""

Remarks

The text description of SSLAcceptServerCertUsageFlags.

This value will be one or more of the following strings and will be separated by commas:

• Digital Signature
• Non-Repudiation
• Key Encipherment
• Data Encipherment
• Key Agreement
• Certificate Signing
• CRL Signing
• Encipher Only

If the provider is OpenSSL, the value is a comma-separated list of X.509 certificate extension names.

This property is read-only.

Data Type

String

SSLAcceptServerCertUsageFlags Property (GoogleDrive Control)

The flags that show intended use for the certificate.

Syntax

googledrivecontrol.SSLAcceptServerCertUsageFlags

Default Value

0

Remarks

The flags that show intended use for the certificate. The value of SSLAcceptServerCertUsageFlags is a combination of the following flags:

Please see the SSLAcceptServerCertUsage property for a text representation of SSLAcceptServerCertUsageFlags.

This functionality currently is not available when the provider is OpenSSL.

This property is read-only.

Data Type

Integer

SSLAcceptServerCertVersion Property (GoogleDrive Control)

The certificate's version number.

Syntax

googledrivecontrol.SSLAcceptServerCertVersion

Default Value

""

Remarks

The certificate's version number. The possible values are the strings "V1", "V2", and "V3".

This property is read-only.

Data Type

String

SSLAcceptServerCertSubject Property (GoogleDrive Control)

The subject of the certificate used for client authentication.

Syntax

googledrivecontrol.SSLAcceptServerCertSubject[=string]

Default Value

""

Remarks

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

SSLAcceptServerCertEncoded Property (GoogleDrive Control)

The certificate (PEM/Base64 encoded).

Syntax

googledrivecontrol.SSLAcceptServerCertEncoded[=string]

Default Value

""

Remarks

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.

To read or write binary data to the property, a Variant (Byte Array) version is provided in .SSLAcceptServerCertEncodedB.

This property is not available at design time.

Data Type

Binary String

SSLCertEffectiveDate Property (GoogleDrive Control)

The date on which this certificate becomes valid.

Syntax

googledrivecontrol.SSLCertEffectiveDate

Default Value

""

Remarks

The date on which this certificate becomes valid. Before this date, it is not valid. The date is localized to the system's time zone. The following example illustrates the format of an encoded date:

23-Jan-2000 15:00:00.

This property is read-only.

Data Type

String

SSLCertExpirationDate Property (GoogleDrive Control)

The date on which the certificate expires.

Syntax

googledrivecontrol.SSLCertExpirationDate

Default Value

""

Remarks

The date on which the certificate expires. After this date, the certificate will no longer be valid. The date is localized to the system's time zone. The following example illustrates the format of an encoded date:

23-Jan-2001 15:00:00.

This property is read-only.

Data Type

String

SSLCertExtendedKeyUsage Property (GoogleDrive Control)

A comma-delimited list of extended key usage identifiers.

Syntax

googledrivecontrol.SSLCertExtendedKeyUsage

Default Value

""

Remarks

A comma-delimited list of extended key usage identifiers. These are the same as ASN.1 object identifiers (OIDs).

This property is read-only.

Data Type

String

SSLCertFingerprint Property (GoogleDrive Control)

The hex-encoded, 16-byte MD5 fingerprint of the certificate.

Syntax

googledrivecontrol.SSLCertFingerprint

Default Value

""

Remarks

The hex-encoded, 16-byte MD5 fingerprint of the certificate. This property is primarily used for keys which do not have a corresponding X.509 public certificate, such as PEM keys that only contain a private key. It is commonly used for SSH keys.

The following example illustrates the format: bc:2a:72:af:fe:58:17:43:7a:5f:ba:5a:7c:90:f7:02

This property is read-only.

Data Type

String

SSLCertFingerprintSHA1 Property (GoogleDrive Control)

The hex-encoded, 20-byte SHA-1 fingerprint of the certificate.

Syntax

googledrivecontrol.SSLCertFingerprintSHA1

Default Value

""

Remarks

The hex-encoded, 20-byte SHA-1 fingerprint of the certificate. This property is primarily used for keys which do not have a corresponding X.509 public certificate, such as PEM keys that only contain a private key. It is commonly used for SSH keys.

The following example illustrates the format: 30:7b:fa:38:65:83:ff:da:b4:4e:07:3f:17:b8:a4:ed:80:be:ff:84

This property is read-only.

Data Type

String

SSLCertFingerprintSHA256 Property (GoogleDrive Control)

The hex-encoded, 32-byte SHA-256 fingerprint of the certificate.

Syntax

googledrivecontrol.SSLCertFingerprintSHA256

Default Value

""

Remarks

The hex-encoded, 32-byte SHA-256 fingerprint of the certificate. This property is primarily used for keys which do not have a corresponding X.509 public certificate, such as PEM keys that only contain a private key. It is commonly used for SSH keys.

The following example illustrates the format: 6a:80:5c:33:a9:43:ea:b0:96:12:8a:64:96:30:ef:4a:8a:96:86:ce:f4:c7:be:10:24:8e:2b:60:9e:f3:59:53

This property is read-only.

Data Type

String

SSLCertIssuer Property (GoogleDrive Control)

The issuer of the certificate.

Syntax

googledrivecontrol.SSLCertIssuer

Default Value

""

Remarks

The issuer of the certificate. This property contains a string representation of the name of the issuing authority for the certificate.

This property is read-only.

Data Type

String

SSLCertPrivateKey Property (GoogleDrive Control)

The private key of the certificate (if available).

Syntax

googledrivecontrol.SSLCertPrivateKey

Default Value

""

Remarks

The private key of the certificate (if available). The key is provided as PEM/Base64-encoded data.

Note: The SSLCertPrivateKey may be available but not exportable. In this case, SSLCertPrivateKey returns an empty string.

This property is read-only.

Data Type

String

SSLCertPrivateKeyAvailable Property (GoogleDrive Control)

Whether a PrivateKey is available for the selected certificate.

Syntax

googledrivecontrol.SSLCertPrivateKeyAvailable

Default Value

False

Remarks

Whether a SSLCertPrivateKey is available for the selected certificate. If SSLCertPrivateKeyAvailable is True, the certificate may be used for authentication purposes (e.g., server authentication).

This property is read-only.

Data Type

Boolean

SSLCertPrivateKeyContainer Property (GoogleDrive Control)

The name of the PrivateKey container for the certificate (if available).

Syntax

googledrivecontrol.SSLCertPrivateKeyContainer

Default Value

""

Remarks

The name of the SSLCertPrivateKey container for the certificate (if available). This functionality is available only on Windows platforms.

This property is read-only.

Data Type

String

SSLCertPublicKey Property (GoogleDrive Control)

The public key of the certificate.

Syntax

googledrivecontrol.SSLCertPublicKey

Default Value

""

Remarks

The public key of the certificate. The key is provided as PEM/Base64-encoded data.

This property is read-only.

Data Type

String

SSLCertPublicKeyAlgorithm Property (GoogleDrive Control)

The textual description of the certificate's public key algorithm.

Syntax

googledrivecontrol.SSLCertPublicKeyAlgorithm

Default Value

""

Remarks

The textual description of the certificate's public key algorithm. The property contains either the name of the algorithm (e.g., "RSA" or "RSA_DH") or an object identifier (OID) string representing the algorithm.

This property is read-only.

Data Type

String

SSLCertPublicKeyLength Property (GoogleDrive Control)

The length of the certificate's public key (in bits).

Syntax

googledrivecontrol.SSLCertPublicKeyLength

Default Value

0

Remarks

The length of the certificate's public key (in bits). Common values are 512, 1024, and 2048.

This property is read-only.

Data Type

Integer

SSLCertSerialNumber Property (GoogleDrive Control)

The serial number of the certificate encoded as a string.

Syntax

googledrivecontrol.SSLCertSerialNumber

Default Value

""

Remarks

The serial number of the certificate encoded as a string. The number is encoded as a series of hexadecimal digits, with each pair representing a byte of the serial number.

This property is read-only.

Data Type

String

SSLCertSignatureAlgorithm Property (GoogleDrive Control)

The text description of the certificate's signature algorithm.

Syntax

googledrivecontrol.SSLCertSignatureAlgorithm

Default Value

""

Remarks

The text description of the certificate's signature algorithm. The property contains either the name of the algorithm (e.g., "RSA" or "RSA_MD5RSA") or an object identifier (OID) string representing the algorithm.

This property is read-only.

Data Type

String

SSLCertStore Property (GoogleDrive Control)

The name of the certificate store for the client certificate.

Syntax

googledrivecontrol.SSLCertStore[=string]

Default Value

"MY"

Remarks

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 cstPFXFile, this property must be set to the name of the file. When the type is cstPFXBlob, the property must be set to the binary contents of a PFX file (i.e., PKCS#12 certificate store).

To read or write binary data to the property, a Variant (Byte Array) version is provided in .SSLCertStoreB.

Data Type

Binary String

SSLCertStorePassword Property (GoogleDrive Control)

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

Syntax

googledrivecontrol.SSLCertStorePassword[=string]

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 (GoogleDrive Control)

The type of certificate store for this certificate.

Syntax

googledrivecontrol.SSLCertStoreType[=integer]

Possible Values

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

0

Remarks

The type of certificate store for this certificate.

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

Data Type

Integer

SSLCertSubjectAltNames Property (GoogleDrive Control)

Comma-separated lists of alternative subject names for the certificate.

Syntax

googledrivecontrol.SSLCertSubjectAltNames

Default Value

""

Remarks

Comma-separated lists of alternative subject names for the certificate.

This property is read-only.

Data Type

String

SSLCertThumbprintMD5 Property (GoogleDrive Control)

The MD5 hash of the certificate.

Syntax

googledrivecontrol.SSLCertThumbprintMD5

Default Value

""

Remarks

The MD5 hash of the certificate. It is primarily used for X.509 certificates. If the hash does not already exist, it is automatically computed.

This property is read-only.

Data Type

String

SSLCertThumbprintSHA1 Property (GoogleDrive Control)

The SHA-1 hash of the certificate.

Syntax

googledrivecontrol.SSLCertThumbprintSHA1

Default Value

""

Remarks

The SHA-1 hash of the certificate. It is primarily used for X.509 certificates. If the hash does not already exist, it is automatically computed.

This property is read-only.

Data Type

String

SSLCertThumbprintSHA256 Property (GoogleDrive Control)

The SHA-256 hash of the certificate.

Syntax

googledrivecontrol.SSLCertThumbprintSHA256

Default Value

""

Remarks

The SHA-256 hash of the certificate. It is primarily used for X.509 certificates. If the hash does not already exist, it is automatically computed.

This property is read-only.

Data Type

String

SSLCertUsage Property (GoogleDrive Control)

The text description of UsageFlags .

Syntax

googledrivecontrol.SSLCertUsage

Default Value

""

Remarks

The text description of SSLCertUsageFlags.

This value will be one or more of the following strings and will be separated by commas:

• Digital Signature
• Non-Repudiation
• Key Encipherment
• Data Encipherment
• Key Agreement
• Certificate Signing
• CRL Signing
• Encipher Only

If the provider is OpenSSL, the value is a comma-separated list of X.509 certificate extension names.

This property is read-only.

Data Type

String

SSLCertUsageFlags Property (GoogleDrive Control)

The flags that show intended use for the certificate.

Syntax

googledrivecontrol.SSLCertUsageFlags

Default Value

0

Remarks

The flags that show intended use for the certificate. The value of SSLCertUsageFlags is a combination of the following flags:

Please see the SSLCertUsage property for a text representation of SSLCertUsageFlags.

This functionality currently is not available when the provider is OpenSSL.

This property is read-only.

Data Type

Integer

SSLCertVersion Property (GoogleDrive Control)

The certificate's version number.

Syntax

googledrivecontrol.SSLCertVersion

Default Value

""

Remarks

The certificate's version number. The possible values are the strings "V1", "V2", and "V3".

This property is read-only.

Data Type

String

SSLCertSubject Property (GoogleDrive Control)

The subject of the certificate used for client authentication.

Syntax

googledrivecontrol.SSLCertSubject[=string]

Default Value

""

Remarks

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

SSLCertEncoded Property (GoogleDrive Control)

The certificate (PEM/Base64 encoded).

Syntax

googledrivecontrol.SSLCertEncoded[=string]

Default Value

""

Remarks

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.

To read or write binary data to the property, a Variant (Byte Array) version is provided in .SSLCertEncodedB.

This property is not available at design time.

Data Type

Binary String

SSLProvider Property (GoogleDrive Control)

The Secure Sockets Layer/Transport Layer Security (SSL/TLS) implementation to use.

Syntax

googledrivecontrol.SSLProvider[=integer]

Possible Values

sslpAutomatic(0), 
sslpPlatform(1), 
sslpInternal(2)

Default Value

0

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 control 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 as follows:

Additional Notes

In most cases using the default value (Automatic) is recommended. The control 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

SSLServerCertEffectiveDate Property (GoogleDrive Control)

The date on which this certificate becomes valid.

Syntax

googledrivecontrol.SSLServerCertEffectiveDate

Default Value

""

Remarks

The date on which this certificate becomes valid. Before this date, it is not valid. The date is localized to the system's time zone. The following example illustrates the format of an encoded date:

23-Jan-2000 15:00:00.

This property is read-only.

Data Type

String

SSLServerCertExpirationDate Property (GoogleDrive Control)

The date on which the certificate expires.

Syntax

googledrivecontrol.SSLServerCertExpirationDate

Default Value

""

Remarks

The date on which the certificate expires. After this date, the certificate will no longer be valid. The date is localized to the system's time zone. The following example illustrates the format of an encoded date:

23-Jan-2001 15:00:00.

This property is read-only.

Data Type

String

SSLServerCertExtendedKeyUsage Property (GoogleDrive Control)

A comma-delimited list of extended key usage identifiers.

Syntax

googledrivecontrol.SSLServerCertExtendedKeyUsage

Default Value

""

Remarks

A comma-delimited list of extended key usage identifiers. These are the same as ASN.1 object identifiers (OIDs).

This property is read-only.

Data Type

String

SSLServerCertFingerprint Property (GoogleDrive Control)

The hex-encoded, 16-byte MD5 fingerprint of the certificate.

Syntax

googledrivecontrol.SSLServerCertFingerprint

Default Value

""

Remarks

The hex-encoded, 16-byte MD5 fingerprint of the certificate. This property is primarily used for keys which do not have a corresponding X.509 public certificate, such as PEM keys that only contain a private key. It is commonly used for SSH keys.

The following example illustrates the format: bc:2a:72:af:fe:58:17:43:7a:5f:ba:5a:7c:90:f7:02

This property is read-only.

Data Type

String

SSLServerCertFingerprintSHA1 Property (GoogleDrive Control)

The hex-encoded, 20-byte SHA-1 fingerprint of the certificate.

Syntax

googledrivecontrol.SSLServerCertFingerprintSHA1

Default Value

""

Remarks

The hex-encoded, 20-byte SHA-1 fingerprint of the certificate. This property is primarily used for keys which do not have a corresponding X.509 public certificate, such as PEM keys that only contain a private key. It is commonly used for SSH keys.

The following example illustrates the format: 30:7b:fa:38:65:83:ff:da:b4:4e:07:3f:17:b8:a4:ed:80:be:ff:84

This property is read-only.

Data Type

String

SSLServerCertFingerprintSHA256 Property (GoogleDrive Control)

The hex-encoded, 32-byte SHA-256 fingerprint of the certificate.

Syntax

googledrivecontrol.SSLServerCertFingerprintSHA256

Default Value

""

Remarks

The hex-encoded, 32-byte SHA-256 fingerprint of the certificate. This property is primarily used for keys which do not have a corresponding X.509 public certificate, such as PEM keys that only contain a private key. It is commonly used for SSH keys.

The following example illustrates the format: 6a:80:5c:33:a9:43:ea:b0:96:12:8a:64:96:30:ef:4a:8a:96:86:ce:f4:c7:be:10:24:8e:2b:60:9e:f3:59:53

This property is read-only.

Data Type

String

SSLServerCertIssuer Property (GoogleDrive Control)

The issuer of the certificate.

Syntax

googledrivecontrol.SSLServerCertIssuer

Default Value

""

Remarks

The issuer of the certificate. This property contains a string representation of the name of the issuing authority for the certificate.

This property is read-only.

Data Type

String

SSLServerCertPrivateKey Property (GoogleDrive Control)

The private key of the certificate (if available).

Syntax

googledrivecontrol.SSLServerCertPrivateKey

Default Value

""

Remarks

The private key of the certificate (if available). The key is provided as PEM/Base64-encoded data.

Note: The SSLServerCertPrivateKey may be available but not exportable. In this case, SSLServerCertPrivateKey returns an empty string.

This property is read-only.

Data Type

String

SSLServerCertPrivateKeyAvailable Property (GoogleDrive Control)

Whether a PrivateKey is available for the selected certificate.

Syntax

googledrivecontrol.SSLServerCertPrivateKeyAvailable

Default Value

False

Remarks

Whether a SSLServerCertPrivateKey is available for the selected certificate. If SSLServerCertPrivateKeyAvailable is True, the certificate may be used for authentication purposes (e.g., server authentication).

This property is read-only.

Data Type

Boolean

SSLServerCertPrivateKeyContainer Property (GoogleDrive Control)

The name of the PrivateKey container for the certificate (if available).

Syntax

googledrivecontrol.SSLServerCertPrivateKeyContainer

Default Value

""

Remarks

The name of the SSLServerCertPrivateKey container for the certificate (if available). This functionality is available only on Windows platforms.

This property is read-only.

Data Type

String

SSLServerCertPublicKey Property (GoogleDrive Control)

The public key of the certificate.

Syntax

googledrivecontrol.SSLServerCertPublicKey

Default Value

""

Remarks

The public key of the certificate. The key is provided as PEM/Base64-encoded data.

This property is read-only.

Data Type

String

SSLServerCertPublicKeyAlgorithm Property (GoogleDrive Control)

The textual description of the certificate's public key algorithm.

Syntax

googledrivecontrol.SSLServerCertPublicKeyAlgorithm

Default Value

""

Remarks

The textual description of the certificate's public key algorithm. The property contains either the name of the algorithm (e.g., "RSA" or "RSA_DH") or an object identifier (OID) string representing the algorithm.

This property is read-only.

Data Type

String

SSLServerCertPublicKeyLength Property (GoogleDrive Control)

The length of the certificate's public key (in bits).

Syntax

googledrivecontrol.SSLServerCertPublicKeyLength

Default Value

0

Remarks

The length of the certificate's public key (in bits). Common values are 512, 1024, and 2048.

This property is read-only.

Data Type

Integer

SSLServerCertSerialNumber Property (GoogleDrive Control)

The serial number of the certificate encoded as a string.

Syntax

googledrivecontrol.SSLServerCertSerialNumber

Default Value

""

Remarks

The serial number of the certificate encoded as a string. The number is encoded as a series of hexadecimal digits, with each pair representing a byte of the serial number.

This property is read-only.

Data Type

String

SSLServerCertSignatureAlgorithm Property (GoogleDrive Control)

The text description of the certificate's signature algorithm.

Syntax

googledrivecontrol.SSLServerCertSignatureAlgorithm

Default Value

""

Remarks

The text description of the certificate's signature algorithm. The property contains either the name of the algorithm (e.g., "RSA" or "RSA_MD5RSA") or an object identifier (OID) string representing the algorithm.

This property is read-only.

Data Type

String

SSLServerCertStore Property (GoogleDrive Control)

The name of the certificate store for the client certificate.

Syntax

googledrivecontrol.SSLServerCertStore

Default Value

"MY"

Remarks

The name of the certificate store for the client certificate.

The SSLServerCertStoreType property denotes the type of the certificate store specified by SSLServerCertStore. If the store is password-protected, specify the password in SSLServerCertStorePassword.

SSLServerCertStore is used in conjunction with the SSLServerCertSubject property to specify client certificates. If SSLServerCertStore has a value, and SSLServerCertSubject or SSLServerCertEncoded is set, a search for a certificate is initiated. Please see the SSLServerCertSubject 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 cstPFXFile, this property must be set to the name of the file. When the type is cstPFXBlob, the property must be set to the binary contents of a PFX file (i.e., PKCS#12 certificate store).

To read or write binary data to the property, a Variant (Byte Array) version is provided in .SSLServerCertStoreB.

This property is read-only.

Data Type

Binary String

SSLServerCertStorePassword Property (GoogleDrive Control)

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

Syntax

googledrivecontrol.SSLServerCertStorePassword

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.

This property is read-only.

Data Type

String

SSLServerCertStoreType Property (GoogleDrive Control)

The type of certificate store for this certificate.

Syntax

googledrivecontrol.SSLServerCertStoreType

Possible Values

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

0

Remarks

The type of certificate store for this certificate.

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

This property is read-only.

Data Type

Integer

SSLServerCertSubjectAltNames Property (GoogleDrive Control)

Comma-separated lists of alternative subject names for the certificate.

Syntax

googledrivecontrol.SSLServerCertSubjectAltNames

Default Value

""

Remarks

Comma-separated lists of alternative subject names for the certificate.

This property is read-only.

Data Type

String

SSLServerCertThumbprintMD5 Property (GoogleDrive Control)

The MD5 hash of the certificate.

Syntax

googledrivecontrol.SSLServerCertThumbprintMD5

Default Value

""

Remarks

The MD5 hash of the certificate. It is primarily used for X.509 certificates. If the hash does not already exist, it is automatically computed.

This property is read-only.

Data Type

String

SSLServerCertThumbprintSHA1 Property (GoogleDrive Control)

The SHA-1 hash of the certificate.

Syntax

googledrivecontrol.SSLServerCertThumbprintSHA1

Default Value

""

Remarks

The SHA-1 hash of the certificate. It is primarily used for X.509 certificates. If the hash does not already exist, it is automatically computed.

This property is read-only.

Data Type

String

SSLServerCertThumbprintSHA256 Property (GoogleDrive Control)

The SHA-256 hash of the certificate.

Syntax

googledrivecontrol.SSLServerCertThumbprintSHA256

Default Value

""

Remarks

The SHA-256 hash of the certificate. It is primarily used for X.509 certificates. If the hash does not already exist, it is automatically computed.

This property is read-only.

Data Type

String

SSLServerCertUsage Property (GoogleDrive Control)

The text description of UsageFlags .

Syntax

googledrivecontrol.SSLServerCertUsage

Default Value

""

Remarks

The text description of SSLServerCertUsageFlags.

This value will be one or more of the following strings and will be separated by commas:

• Digital Signature
• Non-Repudiation
• Key Encipherment
• Data Encipherment
• Key Agreement
• Certificate Signing
• CRL Signing
• Encipher Only

If the provider is OpenSSL, the value is a comma-separated list of X.509 certificate extension names.

This property is read-only.

Data Type

String

SSLServerCertUsageFlags Property (GoogleDrive Control)

The flags that show intended use for the certificate.

Syntax

googledrivecontrol.SSLServerCertUsageFlags

Default Value

0

Remarks

The flags that show intended use for the certificate. The value of SSLServerCertUsageFlags is a combination of the following flags:

Please see the SSLServerCertUsage property for a text representation of SSLServerCertUsageFlags.

This functionality currently is not available when the provider is OpenSSL.

This property is read-only.

Data Type

Integer

SSLServerCertVersion Property (GoogleDrive Control)

The certificate's version number.

Syntax

googledrivecontrol.SSLServerCertVersion

Default Value

""

Remarks

The certificate's version number. The possible values are the strings "V1", "V2", and "V3".

This property is read-only.

Data Type

String

SSLServerCertSubject Property (GoogleDrive Control)

The subject of the certificate used for client authentication.

Syntax

googledrivecontrol.SSLServerCertSubject

Default Value

""

Remarks

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.

This property is read-only.

Data Type

String

SSLServerCertEncoded Property (GoogleDrive Control)

The certificate (PEM/Base64 encoded).

Syntax

googledrivecontrol.SSLServerCertEncoded

Default Value

""

Remarks

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.

To read or write binary data to the property, a Variant (Byte Array) version is provided in .SSLServerCertEncodedB.

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

Data Type

Binary String

StartByte Property (GoogleDrive Control)

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

Syntax

googledrivecontrol.StartByte[=long64]

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 (GoogleDrive Control)

The timeout for the control.

Syntax

googledrivecontrol.Timeout[=integer]

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 control will wait for the operation to complete before returning control.

The control 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 control fails with an error.

Note: By default, all timeouts are inactivity timeouts, that is, 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 (GoogleDrive Control)

Whether to use resumable uploads.

Syntax

googledrivecontrol.UseResumableUpload[=boolean]

Default Value

False

Remarks

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

Refer to UploadFile for more information.

This property is not available at design time.

Data Type

Boolean

AddParents Method (GoogleDrive Control)

Adds folders to the list of parents for a file or folder.

Syntax

googledrivecontrol.AddParents ResourceId, ParentIds

Remarks

This method adds one or more folders, specified by ParentIds, to the list of parents for the file or folder specified by ResourceId.

ParentIds should be specified as a comma-separated list of one or more resource Ids.

Note that resources within a shared drive must always have exactly one parent, and that only shared drive members with the "file organizer" or "organizer" roles can move files and folders within a shared drive.

AddQueryParam Method (GoogleDrive Control)

Adds a query parameter to the QueryParams properties.

Syntax

googledrivecontrol.AddQueryParam Name, Value

Remarks

This method is used to add a query parameter to the QueryParams 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 control automatically. Consult the service documentation for details on the available parameters.

AddSharedDriveMember Method (GoogleDrive Control)

Creates a new shared drive member.

Syntax

googledrivecontrol.AddSharedDriveMember SharedDriveId, Role, PermissionType, Email

Remarks

This is a convenience method that adds a new member to the shared drive specified by SharedDriveId by creating a permission on that shared drive. The Id of the newly-created permission is returned.

Role specifies the member's role. Valid values are:

PermissionType must be one of:

• 0 (ptUser) - A single user.
• 1 (ptGroup) - A group.

Email specifies the email address of the user or the group.

Refer to UpdatePermissions for more information about how permissions work in general, how permissions relate to shared drive members, and how to manipulate multiple members at once. string sharedDriveId = "20983euijdsds"; // First, we'll add a new member to the shared drive. The two integer parameters signify: // * The role type. 2 is the "Writer" role, which provides read and write (but not organize) permissions. // * The permission type. 0 means this is a single user (versus a group). // The Id of the new permission we've created on the shared drive--which is what actually causes the user to // be a member of the shared drive--is returned. string permId = googledrive.AddSharedDriveMember(sharedDriveId, 2, 0, "fakeuser@example.com"); // At some point later, perhaps this user has abused their privileges and we wish to revoke their writer // permissions. We change their role to "Commenter", which provides reader and commenting permissions. googledrive.UpdateSharedDriveMember(sharedDriveId, permId, 1); // 1 is the "Commenter" role. // Or perhaps we wish to simply remove the user's shared drive membership completely. googledrive.RemoveSharedDriveMember(sharedDriveId, permId);

Authorize Method (GoogleDrive Control)

Get the authorization string required to access the protected resource.

Syntax

googledrivecontrol.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 property.

For more information, see the introduction section.

CalcAuthorization Method (GoogleDrive Control)

Calculates the Authorization header based on provided credentials.

Syntax

googledrivecontrol.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 control 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 (GoogleDrive Control)

Sets or retrieves a configuration setting.

Syntax

googledrivecontrol.Config ConfigurationString

Remarks

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

These settings are similar in functionality to properties, but they are rarely used. In order to avoid "polluting" the property namespace of the control, 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 (GoogleDrive Control)

Copies a file.

Syntax

googledrivecontrol.CopyResource ResourceId, NewName, ParentIds

Remarks

This method copies the file identified by ResourceId and returns the Id of the newly created copy.

The NewName parameter defines the name of the copied file.

The ParentIds parameter should be a comma-separated list of existing folder Ids to use as parents for the copied file. If left blank, the copied file will inherit the same parents of the original.

CreateFolder Method (GoogleDrive Control)

Creates a new folder.

Syntax

googledrivecontrol.CreateFolder Name, ParentIds

Remarks

This method creates a new folder with the specified Name and returns its Id. ParentIds can be a list of existing folder Ids to use as parents for the new folder, or empty string to create the folder at the root of the drive.

If the IncludeFolderProperties configuration setting is when this method is called, the control will include the metadata held by the first item in the Resources properties when creating the folder. (Note that the Name and ParentIds passed to this method will take precedence.)

Google treats files and folders in the same way, and folders are included when listing resources. The ResourceType property can be used to determine if a resource is a folder, a file, or a revision of a file.

To list, delete, and update folders use the ListResources, DeleteResource, and UpdateResource methods.

CreateSharedDrive Method (GoogleDrive Control)

Creates a new shared drive.

Syntax

googledrivecontrol.CreateSharedDrive Name, RequestId

Remarks

This method creates a new shared drive and returns the newly-created shared drive's Id.

Name is the name of the new shared drive.

RequestId is a unique value used by the server to identify an idempotent request by the current user to create a shared drive. (That is, the server ensures that duplicate shared drives are not created if any given user makes repeated shared drive creation requests with the same Name and RequestId.)

DeleteResource Method (GoogleDrive Control)

Deletes the specified file or folder permanently.

Syntax

googledrivecontrol.DeleteResource ResourceId

Remarks

This method deletes the file or folder specified by ResourceId permanently.

Files and folders are not moved to the trash, they are deleted permanently. You can use TrashResource to move files or folders to the trash.

DeleteSharedDrive Method (GoogleDrive Control)

Deletes a shared drive.

Syntax

googledrivecontrol.DeleteSharedDrive SharedDriveId

Remarks

This method deletes the shared drive specified by SharedDriveId.

Note that only members of a shared drive with the prOrganizer (5) role can delete it, and that the shared drive must be empty (or all of its items must be in the trash).

DownloadFile Method (GoogleDrive Control)

Downloads, and optionally converts, a file.

Syntax

googledrivecontrol.DownloadFile ResourceId, MimeType

Remarks

This method downloads the file specified by ResourceId.

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

If the empty string is passed for MimeType, the file will be downloaded as-is. If the file is in one of the Google formats shown in the table below, one of the MIME types shown in the third column can be passed for MimeType instead to convert the file before downloading it.

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 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"; 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 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. 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, "");

EmptyTrash Method (GoogleDrive Control)

Permanently deletes all of the current user's trashed files.

Syntax

googledrivecontrol.EmptyTrash 

Remarks

This method permanently deletes all of the current user's trashed files by emptying the trash for their "My Drive".

It is not possible to recover trashed files after this method is called!

GetAccountInfo Method (GoogleDrive Control)

Gets information about the current user's account and space usage.

Syntax

googledrivecontrol.GetAccountInfo 

Remarks

This method gets information about the current user's account and space usage, populating the Account object property's properties.

GetCurrentChangeMarker Method (GoogleDrive Control)

Gets the most current change marker.

Syntax

googledrivecontrol.GetCurrentChangeMarker 

Remarks

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

Refer to ListChanges for more information.

If SharedDrive is set, this method will get the most current change marker available for that shared drive's changes.

GetPermissionInfo Method (GoogleDrive Control)

Gets information about a specific permission.

Syntax

googledrivecontrol.GetPermissionInfo ResourceId, PermissionId

Remarks

This method retrieves information about the permission specified by PermissionId on the file, folder, or shared drive specified by ResourceId.

Calling this method will fire the PermissionList event, and will populate the Permissions properties (clearing any previously-held items in the process).

Shared Drive Members

Refer to UpdatePermissions for more information about how permissions work in general, how permissions relate to shared drive members, and how to manipulate multiple members at once.

GetResourceInfo Method (GoogleDrive Control)

Gets information about specific files and folders.

Syntax

googledrivecontrol.GetResourceInfo ResourceIds

Remarks

This method retrieves information about the file and folder resources specified by ResourceIds (which should be specified as a comma-separated list of resource Ids).

Calling this method will fire the ResourceList event once for each resource, and will populate the Resources properties (clearing any previously-held items in the process).

Note that, unlike the ListResources and ListChildren methods, this method uses the resource Ids to retrieve information directly. This means that it does not support paged results or complex search queries (the "q" query parameter), does not need to know whether the resources are in shared drives, etc.

GetSharedDriveInfo Method (GoogleDrive Control)

Gets information about a specific shared drive.

Syntax

googledrivecontrol.GetSharedDriveInfo SharedDriveId

Remarks

This method retrieves information about the shared drive specified by SharedDriveId.

Calling this method will fire the SharedDriveList event, and will populate the SharedDrives properties (clearing any previously-held items in the process).

GetUploadStatus Method (GoogleDrive Control)

Gets the status of a resumable upload session.

Syntax

googledrivecontrol.GetUploadStatus 

Remarks

This method gets the status of a resumable upload session. Set ResumeURL before calling this method. After calling this method StartByte will be populated.

Interrupt Method (GoogleDrive Control)

This method interrupts the current method.

Syntax

googledrivecontrol.Interrupt 

Remarks

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

ListChanges Method (GoogleDrive Control)

Lists changes to resources and shared drives.

Syntax

googledrivecontrol.ListChanges 

Remarks

This method lists changes to resources and shared drives.

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 ChangeList event to fire once for each change, and will also populate the Changes 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 Changes properties. (Once there aren't any more changes available to list, the NextChangeMarker property will be populated instead.) Alternatively, the AccumulatePages configuration setting can be disabled to clear the Changes properties every time a page of results is returned.

Calling GetCurrentChangeMarker will immediately populate NextChangeMarker. Regardless of whether it is populated because of a call to GetCurrentChangeMarker or to ListChanges, NextChangeMarker 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.)

Setting ChangeMarker to "1" will cause ListChanges to list changes beginning with the very first change available.

Example of Listing Changes // Start listing changes from the beginning, and list a maximum of 10 changes at a time. googledrive.ChangeMarker = "1"; googledrive.Config("MaxResults=10"); // List changes once. googledrive.ListChanges(); do { for (int i = 0; i < googledrive.Changes.Count; i++) { Console.WriteLine(googledrive.Changes[i].ResourceId); Console.WriteLine(googledrive.Changes[i].Time); Console.WriteLine(googledrive.Changes[i].Removed); } // Continue to call ListChanges() until ChangeMarker is the empty string (indicating there // are no more changes to list). googledrive.ListChanges(); } while (googledrive.ChangeMarker.Length > 0); // 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. Thread.Sleep(120000); googledrive.ListChanges(); do { for (int i = 0; i < googledrive.Changes.Count; i++) { Console.WriteLine(googledrive.Changes[i].ResourceId); Console.WriteLine(googledrive.Changes[i].Time); Console.WriteLine(googledrive.Changes[i].Removed); } googledrive.ListChanges(); } while (googledrive.ChangeMarker.Length > 0);

Shared Drive Functionality

When working in the context of shared drives, there are additional properties that can be configured to specify what kinds of changes should returned.

If SharedDrive is empty string, then changes for items in shared drives that the user has accessed will be included (in addition to the usual changes for the user's items). Changes to the shared drives themselves which the user is a member of will also be included.

If SharedDrive is populated with a shared drive resource Id, then only changes to items within that shared drive, as well as changes to that shared drive itself, will be returned.

A change's ChangeType will reflect whether it is associated with a file or folder (0), or a shared drive itself (1).

ListChildren Method (GoogleDrive Control)

Lists the child resources of one or more folders.

Syntax

googledrivecontrol.ListChildren FolderIds

Remarks

This is a convenience method that works the same way as ListResources, but limits the results to children of one or more folders specified by FolderIds (which should be specified as a comma-separated list of folder resource Ids).

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

If there are still more child resources available to list when this method returns, the ChildMarker property will be populated. Continue to call this method until ChildMarker is empty to accumulate all pages of results in the Children properties. Alternatively, the AccumulatePages configuration setting can be disabled to clear the Children properties every time a page of results is returned.

Note that the string "root" may be used as a folder Id to represent the root folder of a drive.

Refer to ListResources for more information about how listing resources works in general, everything there applies to this method too. // ResourceList event handler. googledrive.OnResourceList += (s, e) => { Console.WriteLine(e.Name); }; // List all of the children of the given folder resource. do { googledrive.ListChildren("12978eyuihusd"); for (int i = 0; i < googledrive.Children.Count; i++) { // Process child resources here. } } while (!string.IsNullOrEmpty(googledrive.ChildMarker));

ListParents Method (GoogleDrive Control)

Lists the parent folders of a file or folder.

Syntax

googledrivecontrol.ListParents ResourceId

Remarks

This is a convenience method that simply retrieves the parent Ids of the file or folder specified by ResourceId and passes them to GetResourceInfo.

Refer to GetResourceInfo for more information.

ListPermissions Method (GoogleDrive Control)

Lists the permissions for a file, folder, or shared drive.

Syntax

googledrivecontrol.ListPermissions ResourceId

Remarks

This method is used to list permissions for the file, folder, or shared drive specified by ResourceId.

Calling this method will fire the PermissionList event once for each permission, and will also populate the Permissions properties.

If there are still more permissions available to list when this method returns, the PermissionMarker property will be populated. Continue to call this method until PermissionMarker is empty to accumulate all pages of results in the Permissions properties. Alternatively, the AccumulatePages configuration setting can be disabled to clear the Permissions properties every time a page of results is returned. // PermissionList event handler. googledrive.OnPermissionList += (s, e) => { Console.WriteLine("Permission Id: " + e.Id); }; // List all of the permissions on the given resource. do { googledrive.ListPermissions("fdjhskdf89o3wi"); for (int i = 0; i < googledrive.Permissions.Count; i++) { // Process permissions here. } } while (!string.IsNullOrEmpty(googledrive.PermissionMarker));

Shared Drive Members

Refer to UpdatePermissions for more information about how permissions work in general, how permissions relate to shared drive members, and how to manipulate multiple members at once.

Shared Drive Capabilities

To determine the effective capabilities the current user has for shared drives that they're a member of, call ListSharedDrives instead and inspect the SharedDriveCapabilities property of the returned items.

ListResources Method (GoogleDrive Control)

Lists files and folders.

Syntax

googledrivecontrol.ListResources 

Remarks

This method is used to list file and folders. Calling this method will fire the ResourceList event once for each resource, and will also populate the Resources 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 Resources properties. Alternatively, the AccumulatePages configuration setting can be disabled to clear the Resources properties every time a page of results is returned.

Listing Resources

By default, all files and folders in the scope specified by the ListResourcesScope property will be returned. The ListResourcesMode configuration setting can be used to specify that only files or only folders should be returned. Refer to the "Result Scopes" section, below, for more information about what the results for each scope are comprised of.

To simply list the children or parents of specific resources, use ListChildren or ListParents. To retrieve information about specific resources, use GetResourceInfo.

For more complex queries, refer to the Google Drive API documentation for information on how to construct a search query, then use the AddQueryParam method to add a query parameter named "q" to the QueryParams properties before calling this method.

Result Scopes

There are a number of different search scopes which the results of this method can be drawn from, some of which are exclusive to shared drives.

When ListResources is called with ListResourcesScope set to the default of lrsUser (0), the results will consist of items that are in the current user's "My Drive" and "Shared with me" spaces.

If ListResourcesScope is set to lrsDomain (1), the results will instead consist of items which have been shared to the current user's domain, whether or not the user has actually accessed them.

(To clarify, items shared to a user's domain are only added to their "Shared with me" space once the user accesses them for the first time. So, items shared to a user's domain that they have not actually accessed before would not show up when ListResourcesScope is set to lrsUser (0), but would show up when it is set to lrsDomain (1).)

When ListResourcesScope is set to lrsSharedDrive (2), the SharedDrive property must be set to the resource Id of a shared drive, and the results of this method will consist only of items within that shared drive.

When ListResourcesScope is set to lrsAllDrives (3), the results will consist of anything in the user's "My Drive" and "Shared with me" spaces, and all items in all shared drives which the user is a member of.

Note: Under some circumstances, if a user is a member of many shared drives, using the lrsAllDrives (3) will not yield a complete set of results (even with paged results). This is a direct limitation of the Google Drive API, and the only solution is to use a narrower scope. When using the lrsAllDrives (3) scope, you should check the SearchIncomplete configuration setting after calling ListResources; it will return "True" if the result set is incomplete.

How Shared Drives Work

Shared drives are, more than anything else, very similar to a normal user account. Once this is understood, it becomes much easier to understand how shared drives fit into the overall Google Drive architecture.

Just like a real user, a shared drive itself owns the files in its storage space (this is why the permissions for members of a shared drive use the "file organizer" and "organizer" roles instead of the "owner" role). Also like a real user, a shared drive's files can be explicitly shared with other users (even if they aren't members of the shared drive), and with the overall domain.

The difference, of course, is that a shared drive has a defined set of members, all of which have access to everything in the shared drive (though with varying capabilities). Refer to UpdatePermissions, AddSharedDriveMember, UpdateSharedDriveMember, and RemoveSharedDriveMember for more information. // 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));

ListRevisions Method (GoogleDrive Control)

List the revisions of a file.

Syntax

googledrivecontrol.ListRevisions FileId

Remarks

This method will list the revisions of the specified file. Calling this method will fire the ResourceList event once for each revision, and will also populate the Resources properties. The Revision ID will be help in the ResourceId property.

If the Revision ID is set to the RevisionId configuration setting, the following methods can be used to interact with the specific revision:

• DeleteResource
• DownloadFile
• GetResourceInfo
• UpdateResource

After these methods are no longer needed, it is recommended to clear to the RevisionId configuration setting to avoid unattended changes to functionality.

ListSharedDrives Method (GoogleDrive Control)

Lists shared drives that the current user is a member of.

Syntax

googledrivecontrol.ListSharedDrives 

Remarks

This method lists the shared drives which the current user is a member of.

Calling this method will fire the SharedDriveList event once for each shared drive, and will also populate the SharedDrives properties.

If there are still more shared drives available to list when this method returns, the SharedDriveMarker property will be populated. Continue to call this method until SharedDriveMarker is empty to accumulate all pages of results in the SharedDrives properties. Alternatively, the AccumulatePages configuration setting can be disabled to clear the SharedDrives properties every time a page of results is returned. // SharedDriveList event handler. googledrive.OnSharedDriveList += (s, e) => { Console.WriteLine(e.Name); }; // List all shared drives the current user is a member of. do { googledrive.ListSharedDrives(); for (int i = 0; i < googledrive.SharedDrives.Count; i++) { // Process shared drives here. } } while (!string.IsNullOrEmpty(googledrive.SharedDriveMarker));

MoveResource Method (GoogleDrive Control)

Moves a file or folder.

Syntax

googledrivecontrol.MoveResource ResourceId, NewParentIds

Remarks

This method "moves" an existing file or folder specified by ResourceId to the folders specified by NewParentIds (which should be specified as a comma-separated list of folder resource Ids).

After this method returns, the folders specified by NewParentIds will be the only parents of in the resource's parent list. If you wish to add additional parents for the resource without removing its existing parents, use AddParents instead.

Note that resources within a shared drive must always have exactly one parent, and that only shared drive members with the "file organizer" or "organizer" roles can move files and folders within a shared drive.

RemoveParents Method (GoogleDrive Control)

Removes folders from the list of parents for a file or folder.

Syntax

googledrivecontrol.RemoveParents ResourceId, ParentIds

Remarks

This method removes one or more folders, specified by ParentIds, from the list of parents for the file or folder specified by ResourceId.

ParentIds should be specified as a comma-separated list of one or more resource Ids.

Note that resources within a shared drive must always have exactly one parent, and that only shared drive members with the "file organizer" or "organizer" roles can move files and folders within a shared drive.

RemoveSharedDriveMember Method (GoogleDrive Control)

Removes an existing shared drive member.

Syntax

googledrivecontrol.RemoveSharedDriveMember SharedDriveId, PermissionId

Remarks

This is a convenience method that removes an existing member of a shared drive (specified by SharedDriveId) by deleting their associated permission (specified by PermissionId).

Refer to UpdatePermissions for more information about how permissions work in general, how permissions relate to shared drive members, and how to manipulate multiple members at once. string sharedDriveId = "20983euijdsds"; // First, we'll add a new member to the shared drive. The two integer parameters signify: // * The role type. 2 is the "Writer" role, which provides read and write (but not organize) permissions. // * The permission type. 0 means this is a single user (versus a group). // The Id of the new permission we've created on the shared drive--which is what actually causes the user to // be a member of the shared drive--is returned. string permId = googledrive.AddSharedDriveMember(sharedDriveId, 2, 0, "fakeuser@example.com"); // At some point later, perhaps this user has abused their privileges and we wish to revoke their writer // permissions. We change their role to "Commenter", which provides reader and commenting permissions. googledrive.UpdateSharedDriveMember(sharedDriveId, permId, 1); // 1 is the "Commenter" role. // Or perhaps we wish to simply remove the user's shared drive membership completely. googledrive.RemoveSharedDriveMember(sharedDriveId, permId);

Reset Method (GoogleDrive Control)

Resets the control to its initial state.

Syntax

googledrivecontrol.Reset 

Remarks

This method resets the control to its initial state.

RestoreResource Method (GoogleDrive Control)

Restores a file or folder from the trash.

Syntax

googledrivecontrol.RestoreResource ResourceId

Remarks

This method restores the file or folder specified by ResourceId from the trash.

SendCustomRequest Method (GoogleDrive Control)

Sends a custom request to the Google Drive API.

Syntax

googledrivecontrol.SendCustomRequest HttpMethod, RequestPath, RequestBody

Remarks

This method can be used to send arbitrary requests to the Google Drive 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 Google Drive API. The RequestBody parameter may be empty if not needed.

Usage

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

1. Builds a request URL, including query parameters, as follows:
   • The specified RequestPath is appended to the Google Drive API endpoint, https://www.googleapis.com/drive/v3.
   • All query parameters in the QueryParams 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 ParsedHeaders 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.

ToggleSharedDriveHidden Method (GoogleDrive Control)

Hides or unhides a shared drive.

Syntax

googledrivecontrol.ToggleSharedDriveHidden SharedDriveId, Hidden

Remarks

This method hides or unhides the shared drive specified by SharedDriveId.

If a shared drive is hidden, it will not show up in the Google Drive UI by default (but is still otherwise accessible). Google Drive tracks this setting separately for each user; i.e., each member of a shared drive can choose whether the shared drive should be hidden or not.

TrashResource Method (GoogleDrive Control)

Moves the specified file or folder to the trash.

Syntax

googledrivecontrol.TrashResource ResourceId

Remarks

This method moves the file or folder specified by ResourceId to the trash. The resource may be restored from the trash by calling RestoreResource.

To permanently delete a resource, call DeleteResource. To empty the trash (thus permanently deleting all trashed items), call EmptyTrash.

UpdatePermissions Method (GoogleDrive Control)

Create, update, and delete permissions on a file, folder, or shared drive.

Syntax

googledrivecontrol.UpdatePermissions ResourceId

Remarks

This method is used to create, update, and delete permissions for the file, folder, or shared drive specified by ResourceId.

Each item in the Permissions properties has a PermissionModOp property which can be set to one of the following values:

When this method is called, the control will iterate through the Permissions properties and execute the requested operation for each permission.

For each permission operation which completes successfully, the control will change its PermissionModOp property back to moNone (0).

Important: The control executes permission operations one-by-one due to how the Google Drive API works. If the control encounters an issue during one of the operations, it will fail with an error, and won't attempt to execute any remaining permission items' operations. The error message will indicate the index of the permission item which caused the error.

Usage

ListPermissions must be called before using this method in order to populate the Permissions properties with a resource's existing permissions. (When creating new permissions, calling ListPermissions first is optional, but still recommended to ensure that the control reflects the latest information.)

To create new permissions, add new items to the Permissions properties by incrementing the PermissionCount property as necessary.

For each permission being created or updated, set its properties to the desired values. The PermissionModOp property should be set to a value other than moNone (0) for any permission that should be created, updated, or deleted.

Once the permission items have been set up as desired, call this method. // For simplicity's sake, assume that this file currently has no permissions on it. string fileId = "awd0s79uocijl23wf"; // Add permissions for a couple of users to the file. googledrive.Permissions.Add(new GDrivePermission() { Email = "fakeuser1@example.com", Role = GDrivePermissionRoles.prReader, ModOp = GDrivePermissionModOps.moCreate }); googledrive.Permissions.Add(new GDrivePermission() { Email = "fakeuser2@example.com", Role = GDrivePermissionRoles.prWriter, ModOp = GDrivePermissionModOps.moCreate }); googledrive.UpdatePermissions(fileId); // Now we'll update the permissions on the file, removing one of the users and // changing the other's role to "Commenter". Always list the permissions first // to ensure that the latest data is loaded into the control. googledrive.ListPermissions(fileId); googledrive.Permissions[0].ModOp = GDrivePermissionModOps.moDelete; googledrive.Permissions[1].Role = GDrivePermissionRoles.prCommenter; googledrive.Permissions[1].ModOp = GDrivePermissionModOps.moUpdate; // Now commit the changes. googledrive.UpdatePermissions(fileId);

Transferring Ownership

When creating or updating a permission with the prOwner (3) role on a file or folder, the old owner will have their role downgraded to prWriter (2). The TransferOwnership configuration setting must be set to "True" before calling UpdatePermissions to acknowledge this side effect.

Note that this does not apply to shared drives themselves, or resources in shared drives. It also does not apply when moving resources into or out of shared drives.

Shared Drive Permissions

The permissions on a shared drive itself determine what users are members of the shared drive, and what capabilities they have within the shared drive. Said another way, creating, updating, and deleting the permissions on a shared drive will create, update the capabilities of, and delete shared drive memberships.

Since members are determined by the permissions on a shared drive, this method can of course be used to manipulate one or more shared drive members at once. For simpler use cases which only need to modify one member at a time, the AddSharedDriveMember, UpdateSharedDriveMember, and RemoveSharedDriveMember convenience methods can be used.

Note: Only the ptUser (0) and ptGroup (1) permission types are valid for permissions on a shared drive itself.

Just like in a regular user's drive, permissions can also be applied to files within a shared drive to explicitly share them with specific users (whether they're members of the shared drive or not).

UpdateResource Method (GoogleDrive Control)

Updates a file or folder.

Syntax

googledrivecontrol.UpdateResource ResourceId

Remarks

This method updates the metadata for the file or folder resource identified by ResourceId. For file resources, the file data can optionally be updated as well.

Usage

There must be a GDriveResource properties whose ResourceId property matches the specified ResourceId value before this method is called.

1. If necessary, call GetResourceInfo or ListResources to ensure an item with the resource's latest information is present in the Resources properties.
2. Modify the item's Resource* properties as desired; the following properties are supported:
   • ResourceContentAccessible
   • ResourceDescription
   • ResourceMIMEType (only updated for files, if not empty and new file data is uploaded)
   • ResourceModifiedTime (only updated if not empty)
   • ResourceName
   • ResourceStarred
   • ResourceTrashed
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.

// Load the latest information about the resource into the Resources collection. string resId = "2309urjdojwefs0d09u"; googledrive.GetResourceInfo(resId); // We'll update the file resource's name, description, and content. googledrive.ResourceData = "new file content"; googledrive.Resources[0].Name = "CoolStuff2.txt"; googledrive.Resources[0].Description = "This is a text file with cool stuff in it"; googledrive.UpdateResource(resId);

UpdateSharedDrive Method (GoogleDrive Control)

Updates a shared drive.

Syntax

googledrivecontrol.UpdateSharedDrive SharedDriveId, NewName, SetRestrictions, UnsetRestrictions

Remarks

This method updates the name of and/or restrictions applied to the shared drive specified by SharedDriveId.

If the current user is allowed to rename the shared drive (i.e., if the SharedDriveCapabilities property has the 0x08000 flag set), then a new name can be provided using the NewName parameter. If the user is not allowed to rename the shared drive, or wishes to preserve its current name, pass empty string for NewName.

Similarly, if the current user is allowed to alter one or more of the shared drive's SharedDriveRestrictions (i.e., if the SharedDriveCapabilities property has the 0x00002, 0x00004, and/or 0x00010 flags set), then the desired restrictions can be set or unset by including their associated flags, listed below, in the values passed for the SetRestrictions and UnsetRestrictions parameters.

Note that calls to this method will fail if:

• A non-empty string is passed for NewName, but the current user isn't allowed to rename the shared drive.
• The values passed for SetRestrictions and/or UnsetRestrictions contains any flag that corresponds to a restriction the current user isn't allowed to alter.
• Any restriction flag appears in both SetRestrictions and UnsetRestrictions.

Changes requested using this method are "all-or-nothing"; e.g., if both a new name and a new set of restrictions are requested, but the current user isn't allowed to rename the shared drive, the entire request fails.

UpdateSharedDriveMember Method (GoogleDrive Control)

Updates an existing shared drive member's role.

Syntax

googledrivecontrol.UpdateSharedDriveMember SharedDriveId, PermissionId, Role

Remarks

This is a convenience method that updates the role of an existing member of a shared drive (specified by SharedDriveId) by modifying their associated permission (specified by PermissionId).

Role specifies the member's role. Valid values are:

Refer to UpdatePermissions for more information about how permissions work in general, how permissions relate to shared drive members, and how to manipulate multiple members at once. string sharedDriveId = "20983euijdsds"; // First, we'll add a new member to the shared drive. The two integer parameters signify: // * The role type. 2 is the "Writer" role, which provides read and write (but not organize) permissions. // * The permission type. 0 means this is a single user (versus a group). // The Id of the new permission we've created on the shared drive--which is what actually causes the user to // be a member of the shared drive--is returned. string permId = googledrive.AddSharedDriveMember(sharedDriveId, 2, 0, "fakeuser@example.com"); // At some point later, perhaps this user has abused their privileges and we wish to revoke their writer // permissions. We change their role to "Commenter", which provides reader and commenting permissions. googledrive.UpdateSharedDriveMember(sharedDriveId, permId, 1); // 1 is the "Commenter" role. // Or perhaps we wish to simply remove the user's shared drive membership completely. googledrive.RemoveSharedDriveMember(sharedDriveId, permId);

UploadFile Method (GoogleDrive Control)

Uploads, and optionally converts, a new file.

Syntax

googledrivecontrol.UploadFile FileName, MimeType

Remarks

This method uploads a new file and returns the Id of the newly-created file resource.

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.

Usage

The name specified by the FileName parameter should include a file extension.

If MimeType is "", the file will be uploaded as-is and its MIME type will be automatically determined. The file can be converted to one of the Google formats by explicitly setting MimeType to one of the MIME types in the table below.

Before calling this method, always set ResourceCount to 0 to clear the stored resource data. Then, if you wish to set file metadata and/or assign parent Ids when the file is uploaded, set ResourceCount to 1 and set the desired properties. (Note that the name and MIME type passed to this method will take precedence.)

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

Finally, call this method to upload the file, along with any metadata that may be set.

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 control uses the simple upload mechanism. googledrive.LocalFile = "../MyFile.zip"; googledrive.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. 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", "");

ChangeList Event (GoogleDrive Control)

Fires once for each change when ListChanges is called.

Syntax

Sub googledrivecontrol_ChangeList(ResourceId As String, SharedDriveId As String, Removed As Boolean, Time As String, ChangeType As Integer)

Remarks

This event fires once for each change returned when ListChanges is called.

ResourceId is the Id of the file or folder to which the change applies.

SharedDriveId is the Id of the shared drive associated with the change.

Removed indicates whether the file or shared drive has been removed from the view of the change list. For example, if a file was permanently deleted or access to it was revoked, this would return (it would still return if the file was simply in the trash).

Time is a DateTime string representing the time of the change. This is a combined date-time value (formatted according to RFC 3339).

ChangeType indicates whether this is a file (0) or a shared drive (1) change.

Refer to ListChanges for more information.

EndTransfer Event (GoogleDrive Control)

This event fires when a document finishes transferring.

Syntax

Sub googledrivecontrol_EndTransfer(Direction As Integer)

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 (GoogleDrive Control)

Fired when information is available about errors during data delivery.

Syntax

Sub googledrivecontrol_Error(ErrorCode As Integer, Description As String)

Remarks

The Error event is fired in case of exceptional conditions during message processing. Normally the control fails with an error.

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 (GoogleDrive Control)

Fires after each fragment of a resumable upload is completed.

Syntax

Sub googledrivecontrol_FragmentComplete(FragmentNumber As Integer, FragmentCount As Integer, Interrupt As Boolean)

Remarks

When UseResumableUpload is 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 to interrupt the upload. The upload may be resumed later.

Header Event (GoogleDrive Control)

Fired every time a header line comes in.

Syntax

Sub googledrivecontrol_Header(Field As String, Value As String)

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 (GoogleDrive Control)

Fired once for each log message.

Syntax

Sub googledrivecontrol_Log(LogLevel As Integer, Message As String, LogType As String)

Remarks

This event is fired once for each log message generated by the control. 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"

PermissionList Event (GoogleDrive Control)

This event fires once for each permission returned when listing permissions.

Syntax

Sub googledrivecontrol_PermissionList(Id As String, Role As Integer, PermissionType As Integer, Email As String, Domain As String, AllowFileDiscovery As Boolean)

Remarks

When calling ListPermissions this event will fire once for each permission that is returned.

Id is the Id of the permission.

Role is the role of the permission. Possible values are:

PermissionType indicates the type of the permission. Possible values are:

Email holds the email address of the user or group that the permission applies to when Type is 0 or 1.

Domain holds the domain that the permission applies to when Type is 2.

AllowFileDiscovery signifies whether the permission allows the file to be discovered through search. It is only applicable when Type is 2 or 3.

Progress Event (GoogleDrive Control)

Fires during an upload or download to indicate transfer progress.

Syntax

Sub googledrivecontrol_Progress(Direction As Integer, BytesTransferred As Long64, TotalBytes As Long64, PercentDone As Integer)

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 control 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 control 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 (GoogleDrive Control)

Fires once for each resource returned when listing resources.

Syntax

Sub googledrivecontrol_ResourceList(Id As String, Name As String, Extension As String, Description As String, ResourceType As Integer, SharedDriveId As String, CreatedTime As String, ModifiedTime As String, Size As Long64, Trashed As Boolean)

Remarks

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

Id is the Id of the resource.

Name holds the resource's name.

Extension is the file extension.

Description holds a short description of the resource (if any).

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

SharedDriveId is the Id of the shared drive which the resource is in, or empty string if it is not in a shared drive.

CreatedTime holds a DateTime string representing the creation date of the resource. This is a combined date-time value (formatted according to RFC 3339).

ModifiedTime holds a DateTime string representing the last modified date of the resource. This is a combined date-time value (formatted according to RFC 3339).

Size holds the size of the file in bytes. This is only applicable to files.

Trashed indicates whether the resource is in the trash.

SharedDriveList Event (GoogleDrive Control)

Fires once for each shared drive returned when listing shared drives.

Syntax

Sub googledrivecontrol_SharedDriveList(Id As String, Name As String, CreatedTime As String, Hidden As Boolean, Capabilities As Integer, Restrictions As Integer)

Remarks

This event fires once for each shared drive returned when ListSharedDrives is called.

Id is the Id of the shared drive.

Name holds the shared drive's name.

CreatedTime holds a DateTime string representing the creation date of the resource. This is a combined date-time value (formatted according to RFC 3339).

Hidden indicates whether the shared drive is hidden from default view (i.e., whether it is shown by default in the Google Drive UI).

Capabilities describes the effective capabilities that the current user has for the shared drive. The value is a bit field comprised of one or more of the following, OR'ed together:

Restrictions describes any restrictions that apply to the shared drive and/or its contents. The value is a bit field comprised of one or more of the following, OR'ed together:

SSLServerAuthentication Event (GoogleDrive Control)

Fired after the server presents its certificate to the client.

Syntax

Sub googledrivecontrol_SSLServerAuthentication(CertEncoded As String, CertSubject As String, CertIssuer As String, Status As String, Accept As Boolean)

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 (GoogleDrive Control)

Fired when secure connection progress messages are available.

Syntax

Sub googledrivecontrol_SSLStatus(Message As String)

Remarks

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

StartTransfer Event (GoogleDrive Control)

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

Syntax

Sub googledrivecontrol_StartTransfer(Direction As Integer)

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 (GoogleDrive Control)

Fired while a document transfers (delivers document).

Syntax

Sub googledrivecontrol_Transfer(Direction As Integer, BytesTransferred As Long64, PercentDone As Integer, Text As String)

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 (GoogleDrive Control)

The control accepts one or more of the following configuration settings. Configuration settings are similar in functionality to properties, but they are rarely used. In order to avoid "polluting" the property namespace of the control, access to these internal properties is provided through the Config method.

GoogleDrive Config Settings

OAuth Config Settings

HTTP Config Settings

TCPClient Config Settings

SSL Config Settings

Socket Config Settings

Base Config Settings

Trappable Errors (GoogleDrive Control)

Common Errors

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

HTTP Errors

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

TCPClient Errors

SSL Errors

TCP/IP Errors