# Struct cloudstorage::GoogleDrive

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

## Syntax

```text
cloudstorage::GoogleDrive
```

## Remarks

The GoogleDrive struct 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 struct requires authentication via OAuth 2.0. First, perform OAuth authentication using the o_auth property to set the appropriate fields for the chosen [o_auth_client_profile](#o_auth_client_profile-property-googledrive-struct) and [o_auth_grant_type](#o_auth_grant_type-property-googledrive-struct).

The struct has the following defaults:

|  |  |
| --- | --- |
| Authorization Server URL | "https://accounts.google.com/o/oauth2/auth" |
| Token Server URL | "https://accounts.google.com/o/oauth2/token" |
| Scopes | "https://www.googleapis.com/auth/drive" |

Below is a brief description of the different [o_auth_client_profile](#o_auth_client_profile-property-googledrive-struct) and [o_auth_grant_type](#o_auth_grant_type-property-googledrive-struct) values that are supported by this struct. 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 struct. 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](#authorize-method-googledrive-struct) method should be called. If the authorization and authentication was successful, then the [o_auth_access_token](#o_auth_access_token-property-googledrive-struct) property will be populated. Additionally, if a *refresh token* was provided the [o_auth_refresh_token](#o_auth_refresh_token-property-googledrive-struct) property will be populated as well. These values of the fields are for informational purposes. The struct will also cache these tokens along with when the [o_auth_access_token](#o_auth_access_token-property-googledrive-struct) will be expired. When a method that makes requests to the service provider is called or the [authorize](#authorize-method-googledrive-struct) method is called the struct will automatically check to see if the *access token* is expired. If it is, it will then automatically try to get a new [o_auth_access_token](#o_auth_access_token-property-googledrive-struct). If the [authorize](#authorize-method-googledrive-struct) method was not used and user interaction would be required, the struct will throw an error which can be caught. When user interaction is needed depends on what grant type is set in the [o_auth_grant_type](#o_auth_grant_type-property-googledrive-struct) property. To force the component to only check the *access token* when the [authorize](#authorize-method-googledrive-struct) method is called, the [OAuthAutomaticRefresh](#OAuthAutomaticRefresh) configuration setting can be set to false.

A brief description of the supported values for the [o_auth_grant_type](#o_auth_grant_type-property-googledrive-struct) property are below. For more information, see the service documentation.

**Authorization Code**

When using the *Authorization Code* grant type, the struct will use an *authorization code* to get an *access token*. For this [o_auth_grant_type](#o_auth_grant_type-property-googledrive-struct) the struct expects a [o_auth_client_id](#o_auth_client_id-property-googledrive-struct), [o_auth_client_secret](#o_auth_client_secret-property-googledrive-struct), [o_auth_server_auth_url](#o_auth_server_auth_url-property-googledrive-struct), and [o_auth_server_token_url](#o_auth_server_token_url-property-googledrive-struct) to be set. When the [authorize](#authorize-method-googledrive-struct) 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 struct will parse the *authorization code*, setting the [o_auth_authorization_code](#o_auth_authorization_code-property-googledrive-struct) property, from the redirect. Immediately, the struct 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 [o_auth_refresh_token](#o_auth_refresh_token-property-googledrive-struct) property is set, or a *refresh token* is cached, then the struct will not launch the browser and use the *refresh token* in its request to the token server instead of an *authorization code*.

**Example: **

```csharp
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 struct will request the authorization server to get an *access token*. For this [o_auth_grant_type](#o_auth_grant_type-property-googledrive-struct) the struct expects a [o_auth_client_id](#o_auth_client_id-property-googledrive-struct), [o_auth_client_secret](#o_auth_client_secret-property-googledrive-struct), and [o_auth_server_auth_url](#o_auth_server_auth_url-property-googledrive-struct) to be set. When the [authorize](#authorize-method-googledrive-struct) 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 struct 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 struct will not be able to automatically get a fresh token once it expires.

### Web Profile

 This profile is similar to setting the struct to the Application profile and Authorization Code grant type except the struct 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 [o_auth_client_id](#o_auth_client_id-property-googledrive-struct), [o_auth_client_secret](#o_auth_client_secret-property-googledrive-struct), [o_auth_server_auth_url](#o_auth_server_auth_url-property-googledrive-struct), [o_auth_server_token_url](#o_auth_server_token_url-property-googledrive-struct), and the [o_auth_return_url](#o_auth_return_url-property-googledrive-struct) properties to be set. Before calling the [authorize](#authorize-method-googledrive-struct) method, the [o_auth_web_auth_url](#o_auth_web_auth_url-property-googledrive-struct) 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 [o_auth_return_url](#o_auth_return_url-property-googledrive-struct) property. The [o_auth_return_url](#o_auth_return_url-property-googledrive-struct) 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 [o_auth_authorization_code](#o_auth_authorization_code-property-googledrive-struct) property. Once that is set, the [authorize](#authorize-method-googledrive-struct) method can be called to exchange the *authorization code* for an *access token* and *refresh token* if provided. The struct will then cache these values like normal and use them to make requests. If the [o_auth_refresh_token](#o_auth_refresh_token-property-googledrive-struct) field is set, or a *refresh token* is cached, then the [authorize](#authorize-method-googledrive-struct) 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 a separate OAuth client. Once complete you should have an authorization string which looks like:

```text
Bearer ACCESS_TOKEN_VALUE
```

Assign this value to the [authorization](#authorization-property-googledrive-struct) property before attempting any operations. Setting the [authorization](#authorization-property-googledrive-struct) property will cause the struct to ignore the values set in the o_auth property.

 For Example:

```csharp
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 [list_resources](#list_resources-method-googledrive-struct) method is used to list resources within the scope specified by the [list_resources_scope](#list_resources_scope-property-googledrive-struct) property.

The [list_children](#list_children-method-googledrive-struct), [list_parents](#list_parents-method-googledrive-struct), and [get_resource_info](#get_resource_info-method-googledrive-struct) methods are also available for finer-grained control.

```text
// 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 [download_file](#download_file-method-googledrive-struct) method is used to download files.

### Download Notes

 **Downloading an Encrypted File**

To decrypt an encrypted file set [encryption_algorithm](#encryption_algorithm-property-googledrive-struct) and [encryption_password](#encryption_password-property-googledrive-struct) before calling this method.

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

**Resuming Downloads**

The struct also supports resuming failed downloads by using the [start_byte](#start_byte-property-googledrive-struct) property. If a download is interrupted, set [start_byte](#start_byte-property-googledrive-struct) to the appropriate offset before calling this method to resume the download.

```text
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 [local_file](#local_file-property-googledrive-struct) was set in the initial download attempt.

If [local_file](#local_file-property-googledrive-struct) is set when beginning an encrypted download, the struct creates a temporary file in [TempPath](#TempPath) to hold the encrypted data until the download is complete. If the download is interrupted, [DownloadTempFile](#DownloadTempFile) will be populated with the path of the temporary file that holds the partial data.

To resume, [DownloadTempFile](#DownloadTempFile) must be populated, along with [start_byte](#start_byte-property-googledrive-struct), to allow the remainder of the encrypted data to be downloaded. Once the encrypted data is downloaded it will be decrypted and written to [local_file](#local_file-property-googledrive-struct).

```text
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 [upload_file](#upload_file-method-googledrive-struct) 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 struct uses the simple upload mechanism.

```text
googledrive.LocalFile = "../MyFile.zip";
googledrive.UploadFile("MyFile.zip", "");
```

**Resumable**

To enable resumable uploads set [use_resumable_upload](#use_resumable_upload-property-googledrive-struct) to *true*. This is recommended for large files. The struct will automatically fragment the specified file into smaller pieces and upload each individually. [FragmentSize](#FragmentSize) may be set to specify the size of the fragment if desired. The default fragment size is 10 MB.

When [use_resumable_upload](#use_resumable_upload-property-googledrive-struct) is set to *true* and [upload_file](#upload_file-method-googledrive-struct) is called, a resumable upload session is started by the struct. [resume_url](#resume_url-property-googledrive-struct) is populated with a URL identifying the session (this value may be needed for additional operations if the upload does not complete normally).

During a resumable upload, the [on_fragment_complete](#on_fragment_complete-event-googledrive-struct) event fires after each fragment is uploaded to indicate overall progress. The struct also updates [start_byte](#start_byte-property-googledrive-struct) as necessary to indicate the current offset in the file.

If the upload is interrupted for any reason, resuming it is easy. First, verify that [resume_url](#resume_url-property-googledrive-struct) and [start_byte](#start_byte-property-googledrive-struct) are populated (if the same instance of the struct is used, they should already be populated, and no special action should be needed). Then call [upload_file](#upload_file-method-googledrive-struct) again to resume the upload at the specified [start_byte](#start_byte-property-googledrive-struct) offset.

Note that if the upload is not resumed after some time the upload session will expire. [get_upload_status](#get_upload_status-method-googledrive-struct) may be used to check the status of a resumable upload.

```text
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 struct 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 struct with Google Shared Drives, refer to both the shared-drive-specific documentation sections for commonly-used methods like [list_resources](#list_resources-method-googledrive-struct), [move_resource](#move_resource-method-googledrive-struct), [update_permissions](#update_permissions-method-googledrive-struct), etc.; and browse through the documentation for shared-drive-specific methods and properties such as the [add_shared_drive_member](#add_shared_drive_member-method-googledrive-struct) and [list_shared_drives](#list_shared_drives-method-googledrive-struct) methods, the [shared_drive](#shared_drive-property-googledrive-struct) property, etc.

## Additional Functionality

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

- Encrypt and decrypt files using the [encryption_algorithm](#encryption_algorithm-property-googledrive-struct) and [encryption_password](#encryption_password-property-googledrive-struct) properties.
- Basic file and folder manipulation and organization using methods such as [copy_resource](#copy_resource-method-googledrive-struct), [create_folder](#create_folder-method-googledrive-struct), [delete_resource](#delete_resource-method-googledrive-struct), [move_resource](#move_resource-method-googledrive-struct), and [update_resource](#update_resource-method-googledrive-struct).
- Enumeration and manipulation of parent-child relationships using the [add_parents](#add_parents-method-googledrive-struct), [list_children](#list_children-method-googledrive-struct), [list_parents](#list_parents-method-googledrive-struct), and [remove_parents](#remove_parents-method-googledrive-struct) methods.
- Resourcing trashing and deletion: [delete_resource](#delete_resource-method-googledrive-struct), [trash_resource](#trash_resource-method-googledrive-struct), [restore_resource](#restore_resource-method-googledrive-struct).
- Control over permissions using [list_permissions](#list_permissions-method-googledrive-struct) and [update_permissions](#update_permissions-method-googledrive-struct).
- Change tracking with [list_changes](#list_changes-method-googledrive-struct).
- And more!

### Object Lifetime

 The *new()* method returns a mutable reference to a struct instance. The object itself is kept in the global list maintained by CloudStorage. Due to this, the GoogleDrive struct cannot be disposed of automatically. Please, call the *dispose(&mut; self)* method of GoogleDrive when you have finished using the instance.

## Property List

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

|  |  |
| --- | --- |
| [account_can_create_shared_drives](#account_can_create_shared_drives-property-googledrive-struct) | Whether the account has permission to create shared drives. |
| [account_drive_usage](#account_drive_usage-property-googledrive-struct) | Amount of storage used in Google Drive. |
| [account_email](#account_email-property-googledrive-struct) | The email address of the account. |
| [account_name](#account_name-property-googledrive-struct) | The name of the account's user. |
| [account_permission_id](#account_permission_id-property-googledrive-struct) | The permission Id associated with the account. |
| [account_storage_quota](#account_storage_quota-property-googledrive-struct) | The account's storage quota. |
| [account_storage_usage](#account_storage_usage-property-googledrive-struct) | Amount of storage used across all Google services. |
| [account_trash_usage](#account_trash_usage-property-googledrive-struct) | Amount of storage used by trashed items in Google Drive. |
| [authorization](#authorization-property-googledrive-struct) | The OAuth 2.0 authorization token. |
| [change_marker](#change_marker-property-googledrive-struct) | A marker indicating what page of changes to return next. |
| [change_count](#change_count-property-googledrive-struct) | The number of records in the Change arrays. |
| [change_type](#change_type-property-googledrive-struct) | Whether the change is for a file or a shared drive. |
| [change_removed](#change_removed-property-googledrive-struct) | Whether the file or shared drive has been removed. |
| [change_resource_id](#change_resource_id-property-googledrive-struct) | The Id of the file to which the change applies. |
| [change_shared_drive_id](#change_shared_drive_id-property-googledrive-struct) | The Id of the shared drive. |
| [change_time](#change_time-property-googledrive-struct) | The time of the change. |
| [child_marker](#child_marker-property-googledrive-struct) | A marker when child resources are paged. |
| [child_count](#child_count-property-googledrive-struct) | The number of records in the Child arrays. |
| [child_content_accessible](#child_content_accessible-property-googledrive-struct) | Whether the resource's content is accessible to less-privileged users. |
| [child_created_time](#child_created_time-property-googledrive-struct) | The creation date of the resource. |
| [child_description](#child_description-property-googledrive-struct) | A short description of the resource. |
| [child_extension](#child_extension-property-googledrive-struct) | The file extension of the resource. |
| [child_id](#child_id-property-googledrive-struct) | The Id of the resource. |
| [child_md5_checksum](#child_md5_checksum-property-googledrive-struct) | The MD5 checksum of the file resource. |
| [child_mime_type](#child_mime_type-property-googledrive-struct) | The MIME type of the resource. |
| [child_modified_time](#child_modified_time-property-googledrive-struct) | The last modified date of the resource. |
| [child_name](#child_name-property-googledrive-struct) | The name of the resource. |
| [child_original_name](#child_original_name-property-googledrive-struct) | The original name of the file resource. |
| [child_owner](#child_owner-property-googledrive-struct) | The name of the resource's owner. |
| [child_owner_email](#child_owner_email-property-googledrive-struct) | The email address of the resource's owner. |
| [child_parent_ids](#child_parent_ids-property-googledrive-struct) | The Ids of the resource's parent folders. |
| [child_type](#child_type-property-googledrive-struct) | The resource's type. |
| [child_shared_drive_id](#child_shared_drive_id-property-googledrive-struct) | The Id of the shared drive the resource is in. |
| [child_size](#child_size-property-googledrive-struct) | The size of the file resource in bytes. |
| [child_starred](#child_starred-property-googledrive-struct) | Whether the resource is starred. |
| [child_trashed](#child_trashed-property-googledrive-struct) | Whether the resource is in the trash. |
| [child_viewed](#child_viewed-property-googledrive-struct) | Whether the resource has been viewed. |
| [child_view_link](#child_view_link-property-googledrive-struct) | A link for opening the resource in a relevant Google editor or viewer in a browser. |
| [encryption_algorithm](#encryption_algorithm-property-googledrive-struct) | The encryption algorithm. |
| [encryption_password](#encryption_password-property-googledrive-struct) | The encryption password. |
| [firewall_auto_detect](#firewall_auto_detect-property-googledrive-struct) | Whether to automatically detect and use firewall system settings, if available. |
| [firewall_type](#firewall_type-property-googledrive-struct) | The type of firewall to connect through. |
| [firewall_host](#firewall_host-property-googledrive-struct) | The name or IP address of the firewall (optional). |
| [firewall_password](#firewall_password-property-googledrive-struct) | A password if authentication is to be used when connecting through the firewall. |
| [firewall_port](#firewall_port-property-googledrive-struct) | The Transmission Control Protocol (TCP) port for the firewall Host . |
| [firewall_user](#firewall_user-property-googledrive-struct) | A username if authentication is to be used when connecting through a firewall. |
| [idle](#idle-property-googledrive-struct) | The current status of the struct. |
| [list_resources_scope](#list_resources_scope-property-googledrive-struct) | Controls the scope of the results when listing resources. |
| [local_file](#local_file-property-googledrive-struct) | The location of the local file. |
| [local_host](#local_host-property-googledrive-struct) | The name of the local host or user-assigned IP interface through which connections are initiated or accepted. |
| [next_change_marker](#next_change_marker-property-googledrive-struct) | A marker indicating what page of changes to return in the future. |
| [o_auth_access_token](#o_auth_access_token-property-googledrive-struct) | The access token returned by the authorization server. |
| [o_auth_authorization_code](#o_auth_authorization_code-property-googledrive-struct) | The authorization code that is exchanged for an access token. |
| [o_auth_authorization_scope](#o_auth_authorization_scope-property-googledrive-struct) | The scope request or response parameter used during authorization. |
| [o_auth_client_id](#o_auth_client_id-property-googledrive-struct) | The id of the client assigned when registering the application. |
| [o_auth_client_profile](#o_auth_client_profile-property-googledrive-struct) | The type of client that is requesting authorization. |
| [o_auth_client_secret](#o_auth_client_secret-property-googledrive-struct) | The secret value for the client assigned when registering the application. |
| [o_auth_grant_type](#o_auth_grant_type-property-googledrive-struct) | The OAuth grant type used to acquire an OAuth access token. |
| [o_auth_refresh_token](#o_auth_refresh_token-property-googledrive-struct) | Specifies the refresh token received from or sent to the authorization server. |
| [o_auth_request_refresh_token](#o_auth_request_refresh_token-property-googledrive-struct) | Specifies whether the struct will request a refresh token during authorization. |
| [o_auth_return_url](#o_auth_return_url-property-googledrive-struct) | The URL where the user (browser) returns after authenticating. |
| [o_auth_server_auth_url](#o_auth_server_auth_url-property-googledrive-struct) | The URL of the authorization server. |
| [o_auth_server_token_url](#o_auth_server_token_url-property-googledrive-struct) | The URL of the token server used to obtain the access token. |
| [o_auth_timeout](#o_auth_timeout-property-googledrive-struct) | The amount of time (in seconds) the struct will wait for a response from the browser in the LaunchBrowser event. |
| [o_auth_web_auth_url](#o_auth_web_auth_url-property-googledrive-struct) | The URL to which the user should be re-directed for authorization. |
| [other_headers](#other_headers-property-googledrive-struct) | Other headers as determined by the user (optional). |
| [overwrite](#overwrite-property-googledrive-struct) | Determines if local files are overwritten. |
| [parsed_header_count](#parsed_header_count-property-googledrive-struct) | The number of records in the ParsedHeader arrays. |
| [parsed_header_field](#parsed_header_field-property-googledrive-struct) | This property contains the name of the HTTP header (this is the same case as it is delivered). |
| [parsed_header_value](#parsed_header_value-property-googledrive-struct) | This property contains the header contents. |
| [permission_marker](#permission_marker-property-googledrive-struct) | A marker when permissions are paged. |
| [permission_count](#permission_count-property-googledrive-struct) | The number of records in the Permission arrays. |
| [permission_allow_file_discovery](#permission_allow_file_discovery-property-googledrive-struct) | Whether the permission allows the file or folder to be discovered through search. |
| [permission_domain](#permission_domain-property-googledrive-struct) | The domain to which the permission applies. |
| [permission_email](#permission_email-property-googledrive-struct) | The user or group to which the permission applies. |
| [permission_grantee_type](#permission_grantee_type-property-googledrive-struct) | The set of users to which the permission applies. |
| [permission_id](#permission_id-property-googledrive-struct) | The Id of the permission. |
| [permission_mod_op](#permission_mod_op-property-googledrive-struct) | The operation to perform on the permission. |
| [permission_role](#permission_role-property-googledrive-struct) | The role specified by the permission. |
| [proxy_auth_scheme](#proxy_auth_scheme-property-googledrive-struct) | The type of authorization to perform when connecting to the proxy. |
| [proxy_auto_detect](#proxy_auto_detect-property-googledrive-struct) | Whether to automatically detect and use proxy system settings, if available. |
| [proxy_password](#proxy_password-property-googledrive-struct) | A password if authentication is to be used for the proxy. |
| [proxy_port](#proxy_port-property-googledrive-struct) | The Transmission Control Protocol (TCP) port for the proxy Server (default 80). |
| [proxy_server](#proxy_server-property-googledrive-struct) | If a proxy Server is given, then the HTTP request is sent to the proxy instead of the server otherwise specified. |
| [proxy_ssl](#proxy_ssl-property-googledrive-struct) | When to use a Secure Sockets Layer (SSL) for the connection to the proxy. |
| [proxy_user](#proxy_user-property-googledrive-struct) | A username if authentication is to be used for the proxy. |
| [query_param_count](#query_param_count-property-googledrive-struct) | The number of records in the QueryParam arrays. |
| [query_param_name](#query_param_name-property-googledrive-struct) | The name of the query parameter. |
| [query_param_value](#query_param_value-property-googledrive-struct) | The value of the query parameter. |
| [resource_data](#resource_data-property-googledrive-struct) | The data that was downloaded, or that should be uploaded. |
| [resource_marker](#resource_marker-property-googledrive-struct) | A marker indicating what page of resources to return next. |
| [resource_count](#resource_count-property-googledrive-struct) | The number of records in the Resource arrays. |
| [resource_content_accessible](#resource_content_accessible-property-googledrive-struct) | Whether the resource's content is accessible to less-privileged users. |
| [resource_created_time](#resource_created_time-property-googledrive-struct) | The creation date of the resource. |
| [resource_description](#resource_description-property-googledrive-struct) | A short description of the resource. |
| [resource_extension](#resource_extension-property-googledrive-struct) | The file extension of the resource. |
| [resource_id](#resource_id-property-googledrive-struct) | The Id of the resource. |
| [resource_md5_checksum](#resource_md5_checksum-property-googledrive-struct) | The MD5 checksum of the file resource. |
| [resource_mime_type](#resource_mime_type-property-googledrive-struct) | The MIME type of the resource. |
| [resource_modified_time](#resource_modified_time-property-googledrive-struct) | The last modified date of the resource. |
| [resource_name](#resource_name-property-googledrive-struct) | The name of the resource. |
| [resource_original_name](#resource_original_name-property-googledrive-struct) | The original name of the file resource. |
| [resource_owner](#resource_owner-property-googledrive-struct) | The name of the resource's owner. |
| [resource_owner_email](#resource_owner_email-property-googledrive-struct) | The email address of the resource's owner. |
| [resource_parent_ids](#resource_parent_ids-property-googledrive-struct) | The Ids of the resource's parent folders. |
| [resource_type](#resource_type-property-googledrive-struct) | The resource's type. |
| [resource_shared_drive_id](#resource_shared_drive_id-property-googledrive-struct) | The Id of the shared drive the resource is in. |
| [resource_size](#resource_size-property-googledrive-struct) | The size of the file resource in bytes. |
| [resource_starred](#resource_starred-property-googledrive-struct) | Whether the resource is starred. |
| [resource_trashed](#resource_trashed-property-googledrive-struct) | Whether the resource is in the trash. |
| [resource_viewed](#resource_viewed-property-googledrive-struct) | Whether the resource has been viewed. |
| [resource_view_link](#resource_view_link-property-googledrive-struct) | A link for opening the resource in a relevant Google editor or viewer in a browser. |
| [resume_url](#resume_url-property-googledrive-struct) | The resumable upload URL. |
| [shared_drive](#shared_drive-property-googledrive-struct) | The shared drive to list file and folder resources for. |
| [shared_drive_marker](#shared_drive_marker-property-googledrive-struct) | A marker when shared drives are paged. |
| [shared_drive_count](#shared_drive_count-property-googledrive-struct) | The number of records in the SharedDrive arrays. |
| [shared_drive_capabilities](#shared_drive_capabilities-property-googledrive-struct) | The capabilities that the current user has for the shared drive. |
| [shared_drive_created_time](#shared_drive_created_time-property-googledrive-struct) | The creation date of the shared drive. |
| [shared_drive_hidden](#shared_drive_hidden-property-googledrive-struct) | Whether the shared drive is hidden from default view. |
| [shared_drive_id](#shared_drive_id-property-googledrive-struct) | The Id of the shared drive. |
| [shared_drive_name](#shared_drive_name-property-googledrive-struct) | The name of the shared drive. |
| [shared_drive_restrictions](#shared_drive_restrictions-property-googledrive-struct) | The restrictions that apply to the shared drive. |
| [ssl_accept_server_cert_effective_date](#ssl_accept_server_cert_effective_date-property-googledrive-struct) | The date on which this certificate becomes valid. |
| [ssl_accept_server_cert_expiration_date](#ssl_accept_server_cert_expiration_date-property-googledrive-struct) | The date on which the certificate expires. |
| [ssl_accept_server_cert_extended_key_usage](#ssl_accept_server_cert_extended_key_usage-property-googledrive-struct) | A comma-delimited list of extended key usage identifiers. |
| [ssl_accept_server_cert_fingerprint](#ssl_accept_server_cert_fingerprint-property-googledrive-struct) | The hex-encoded, 16-byte MD5 fingerprint of the certificate. |
| [ssl_accept_server_cert_fingerprint_sha1](#ssl_accept_server_cert_fingerprint_sha1-property-googledrive-struct) | The hex-encoded, 20-byte SHA-1 fingerprint of the certificate. |
| [ssl_accept_server_cert_fingerprint_sha256](#ssl_accept_server_cert_fingerprint_sha256-property-googledrive-struct) | The hex-encoded, 32-byte SHA-256 fingerprint of the certificate. |
| [ssl_accept_server_cert_issuer](#ssl_accept_server_cert_issuer-property-googledrive-struct) | The issuer of the certificate. |
| [ssl_accept_server_cert_private_key](#ssl_accept_server_cert_private_key-property-googledrive-struct) | The private key of the certificate (if available). |
| [ssl_accept_server_cert_private_key_available](#ssl_accept_server_cert_private_key_available-property-googledrive-struct) | Whether a PrivateKey is available for the selected certificate. |
| [ssl_accept_server_cert_private_key_container](#ssl_accept_server_cert_private_key_container-property-googledrive-struct) | The name of the PrivateKey container for the certificate (if available). |
| [ssl_accept_server_cert_public_key](#ssl_accept_server_cert_public_key-property-googledrive-struct) | The public key of the certificate. |
| [ssl_accept_server_cert_public_key_algorithm](#ssl_accept_server_cert_public_key_algorithm-property-googledrive-struct) | The textual description of the certificate's public key algorithm. |
| [ssl_accept_server_cert_public_key_length](#ssl_accept_server_cert_public_key_length-property-googledrive-struct) | The length of the certificate's public key (in bits). |
| [ssl_accept_server_cert_serial_number](#ssl_accept_server_cert_serial_number-property-googledrive-struct) | The serial number of the certificate encoded as a string. |
| [ssl_accept_server_cert_signature_algorithm](#ssl_accept_server_cert_signature_algorithm-property-googledrive-struct) | The text description of the certificate's signature algorithm. |
| [ssl_accept_server_cert_store](#ssl_accept_server_cert_store-property-googledrive-struct) | The name of the certificate store for the client certificate. |
| [ssl_accept_server_cert_store_password](#ssl_accept_server_cert_store_password-property-googledrive-struct) | If the type of certificate store requires a password, this property is used to specify the password needed to open the certificate store. |
| [ssl_accept_server_cert_store_type](#ssl_accept_server_cert_store_type-property-googledrive-struct) | The type of certificate store for this certificate. |
| [ssl_accept_server_cert_subject_alt_names](#ssl_accept_server_cert_subject_alt_names-property-googledrive-struct) | Comma-separated lists of alternative subject names for the certificate. |
| [ssl_accept_server_cert_thumbprint_md5](#ssl_accept_server_cert_thumbprint_md5-property-googledrive-struct) | The MD5 hash of the certificate. |
| [ssl_accept_server_cert_thumbprint_sha1](#ssl_accept_server_cert_thumbprint_sha1-property-googledrive-struct) | The SHA-1 hash of the certificate. |
| [ssl_accept_server_cert_thumbprint_sha256](#ssl_accept_server_cert_thumbprint_sha256-property-googledrive-struct) | The SHA-256 hash of the certificate. |
| [ssl_accept_server_cert_usage](#ssl_accept_server_cert_usage-property-googledrive-struct) | The text description of UsageFlags . |
| [ssl_accept_server_cert_usage_flags](#ssl_accept_server_cert_usage_flags-property-googledrive-struct) | The flags that show intended use for the certificate. |
| [ssl_accept_server_cert_version](#ssl_accept_server_cert_version-property-googledrive-struct) | The certificate's version number. |
| [ssl_accept_server_cert_subject](#ssl_accept_server_cert_subject-property-googledrive-struct) | The subject of the certificate used for client authentication. |
| [ssl_accept_server_cert_encoded](#ssl_accept_server_cert_encoded-property-googledrive-struct) | The certificate (PEM/Base64 encoded). |
| [ssl_cert_effective_date](#ssl_cert_effective_date-property-googledrive-struct) | The date on which this certificate becomes valid. |
| [ssl_cert_expiration_date](#ssl_cert_expiration_date-property-googledrive-struct) | The date on which the certificate expires. |
| [ssl_cert_extended_key_usage](#ssl_cert_extended_key_usage-property-googledrive-struct) | A comma-delimited list of extended key usage identifiers. |
| [ssl_cert_fingerprint](#ssl_cert_fingerprint-property-googledrive-struct) | The hex-encoded, 16-byte MD5 fingerprint of the certificate. |
| [ssl_cert_fingerprint_sha1](#ssl_cert_fingerprint_sha1-property-googledrive-struct) | The hex-encoded, 20-byte SHA-1 fingerprint of the certificate. |
| [ssl_cert_fingerprint_sha256](#ssl_cert_fingerprint_sha256-property-googledrive-struct) | The hex-encoded, 32-byte SHA-256 fingerprint of the certificate. |
| [ssl_cert_issuer](#ssl_cert_issuer-property-googledrive-struct) | The issuer of the certificate. |
| [ssl_cert_private_key](#ssl_cert_private_key-property-googledrive-struct) | The private key of the certificate (if available). |
| [ssl_cert_private_key_available](#ssl_cert_private_key_available-property-googledrive-struct) | Whether a PrivateKey is available for the selected certificate. |
| [ssl_cert_private_key_container](#ssl_cert_private_key_container-property-googledrive-struct) | The name of the PrivateKey container for the certificate (if available). |
| [ssl_cert_public_key](#ssl_cert_public_key-property-googledrive-struct) | The public key of the certificate. |
| [ssl_cert_public_key_algorithm](#ssl_cert_public_key_algorithm-property-googledrive-struct) | The textual description of the certificate's public key algorithm. |
| [ssl_cert_public_key_length](#ssl_cert_public_key_length-property-googledrive-struct) | The length of the certificate's public key (in bits). |
| [ssl_cert_serial_number](#ssl_cert_serial_number-property-googledrive-struct) | The serial number of the certificate encoded as a string. |
| [ssl_cert_signature_algorithm](#ssl_cert_signature_algorithm-property-googledrive-struct) | The text description of the certificate's signature algorithm. |
| [ssl_cert_store](#ssl_cert_store-property-googledrive-struct) | The name of the certificate store for the client certificate. |
| [ssl_cert_store_password](#ssl_cert_store_password-property-googledrive-struct) | If the type of certificate store requires a password, this property is used to specify the password needed to open the certificate store. |
| [ssl_cert_store_type](#ssl_cert_store_type-property-googledrive-struct) | The type of certificate store for this certificate. |
| [ssl_cert_subject_alt_names](#ssl_cert_subject_alt_names-property-googledrive-struct) | Comma-separated lists of alternative subject names for the certificate. |
| [ssl_cert_thumbprint_md5](#ssl_cert_thumbprint_md5-property-googledrive-struct) | The MD5 hash of the certificate. |
| [ssl_cert_thumbprint_sha1](#ssl_cert_thumbprint_sha1-property-googledrive-struct) | The SHA-1 hash of the certificate. |
| [ssl_cert_thumbprint_sha256](#ssl_cert_thumbprint_sha256-property-googledrive-struct) | The SHA-256 hash of the certificate. |
| [ssl_cert_usage](#ssl_cert_usage-property-googledrive-struct) | The text description of UsageFlags . |
| [ssl_cert_usage_flags](#ssl_cert_usage_flags-property-googledrive-struct) | The flags that show intended use for the certificate. |
| [ssl_cert_version](#ssl_cert_version-property-googledrive-struct) | The certificate's version number. |
| [ssl_cert_subject](#ssl_cert_subject-property-googledrive-struct) | The subject of the certificate used for client authentication. |
| [ssl_cert_encoded](#ssl_cert_encoded-property-googledrive-struct) | The certificate (PEM/Base64 encoded). |
| [ssl_provider](#ssl_provider-property-googledrive-struct) | The Secure Sockets Layer/Transport Layer Security (SSL/TLS) implementation to use. |
| [ssl_server_cert_effective_date](#ssl_server_cert_effective_date-property-googledrive-struct) | The date on which this certificate becomes valid. |
| [ssl_server_cert_expiration_date](#ssl_server_cert_expiration_date-property-googledrive-struct) | The date on which the certificate expires. |
| [ssl_server_cert_extended_key_usage](#ssl_server_cert_extended_key_usage-property-googledrive-struct) | A comma-delimited list of extended key usage identifiers. |
| [ssl_server_cert_fingerprint](#ssl_server_cert_fingerprint-property-googledrive-struct) | The hex-encoded, 16-byte MD5 fingerprint of the certificate. |
| [ssl_server_cert_fingerprint_sha1](#ssl_server_cert_fingerprint_sha1-property-googledrive-struct) | The hex-encoded, 20-byte SHA-1 fingerprint of the certificate. |
| [ssl_server_cert_fingerprint_sha256](#ssl_server_cert_fingerprint_sha256-property-googledrive-struct) | The hex-encoded, 32-byte SHA-256 fingerprint of the certificate. |
| [ssl_server_cert_issuer](#ssl_server_cert_issuer-property-googledrive-struct) | The issuer of the certificate. |
| [ssl_server_cert_private_key](#ssl_server_cert_private_key-property-googledrive-struct) | The private key of the certificate (if available). |
| [ssl_server_cert_private_key_available](#ssl_server_cert_private_key_available-property-googledrive-struct) | Whether a PrivateKey is available for the selected certificate. |
| [ssl_server_cert_private_key_container](#ssl_server_cert_private_key_container-property-googledrive-struct) | The name of the PrivateKey container for the certificate (if available). |
| [ssl_server_cert_public_key](#ssl_server_cert_public_key-property-googledrive-struct) | The public key of the certificate. |
| [ssl_server_cert_public_key_algorithm](#ssl_server_cert_public_key_algorithm-property-googledrive-struct) | The textual description of the certificate's public key algorithm. |
| [ssl_server_cert_public_key_length](#ssl_server_cert_public_key_length-property-googledrive-struct) | The length of the certificate's public key (in bits). |
| [ssl_server_cert_serial_number](#ssl_server_cert_serial_number-property-googledrive-struct) | The serial number of the certificate encoded as a string. |
| [ssl_server_cert_signature_algorithm](#ssl_server_cert_signature_algorithm-property-googledrive-struct) | The text description of the certificate's signature algorithm. |
| [ssl_server_cert_store](#ssl_server_cert_store-property-googledrive-struct) | The name of the certificate store for the client certificate. |
| [ssl_server_cert_store_password](#ssl_server_cert_store_password-property-googledrive-struct) | If the type of certificate store requires a password, this property is used to specify the password needed to open the certificate store. |
| [ssl_server_cert_store_type](#ssl_server_cert_store_type-property-googledrive-struct) | The type of certificate store for this certificate. |
| [ssl_server_cert_subject_alt_names](#ssl_server_cert_subject_alt_names-property-googledrive-struct) | Comma-separated lists of alternative subject names for the certificate. |
| [ssl_server_cert_thumbprint_md5](#ssl_server_cert_thumbprint_md5-property-googledrive-struct) | The MD5 hash of the certificate. |
| [ssl_server_cert_thumbprint_sha1](#ssl_server_cert_thumbprint_sha1-property-googledrive-struct) | The SHA-1 hash of the certificate. |
| [ssl_server_cert_thumbprint_sha256](#ssl_server_cert_thumbprint_sha256-property-googledrive-struct) | The SHA-256 hash of the certificate. |
| [ssl_server_cert_usage](#ssl_server_cert_usage-property-googledrive-struct) | The text description of UsageFlags . |
| [ssl_server_cert_usage_flags](#ssl_server_cert_usage_flags-property-googledrive-struct) | The flags that show intended use for the certificate. |
| [ssl_server_cert_version](#ssl_server_cert_version-property-googledrive-struct) | The certificate's version number. |
| [ssl_server_cert_subject](#ssl_server_cert_subject-property-googledrive-struct) | The subject of the certificate used for client authentication. |
| [ssl_server_cert_encoded](#ssl_server_cert_encoded-property-googledrive-struct) | The certificate (PEM/Base64 encoded). |
| [start_byte](#start_byte-property-googledrive-struct) | The byte offset from which to start the upload or download. |
| [timeout](#timeout-property-googledrive-struct) | The timeout for the struct. |
| [use_resumable_upload](#use_resumable_upload-property-googledrive-struct) | Whether to use resumable uploads. |

## Method List

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

|  |  |
| --- | --- |
| [add_parents](#add_parents-method-googledrive-struct) | Adds folders to the list of parents for a file or folder. |
| [add_query_param](#add_query_param-method-googledrive-struct) | Adds a query parameter to the QueryParams properties. |
| [add_shared_drive_member](#add_shared_drive_member-method-googledrive-struct) | Creates a new shared drive member. |
| [authorize](#authorize-method-googledrive-struct) | Get the authorization string required to access the protected resource. |
| [config](#config-method-googledrive-struct) | Sets or retrieves a configuration setting. |
| [copy_resource](#copy_resource-method-googledrive-struct) | Copies a file. |
| [create_folder](#create_folder-method-googledrive-struct) | Creates a new folder. |
| [create_shared_drive](#create_shared_drive-method-googledrive-struct) | Creates a new shared drive. |
| [delete_resource](#delete_resource-method-googledrive-struct) | Deletes the specified file or folder permanently. |
| [delete_shared_drive](#delete_shared_drive-method-googledrive-struct) | Deletes a shared drive. |
| [download_file](#download_file-method-googledrive-struct) | Downloads, and optionally converts, a file. |
| [empty_trash](#empty_trash-method-googledrive-struct) | Permanently deletes all of the current user's trashed files. |
| [get_account_info](#get_account_info-method-googledrive-struct) | Gets information about the current user's account and space usage. |
| [get_current_change_marker](#get_current_change_marker-method-googledrive-struct) | Gets the most current change marker. |
| [get_permission_info](#get_permission_info-method-googledrive-struct) | Gets information about a specific permission. |
| [get_resource_info](#get_resource_info-method-googledrive-struct) | Gets information about specific files and folders. |
| [get_shared_drive_info](#get_shared_drive_info-method-googledrive-struct) | Gets information about a specific shared drive. |
| [get_upload_status](#get_upload_status-method-googledrive-struct) | Gets the status of a resumable upload session. |
| [interrupt](#interrupt-method-googledrive-struct) | This method interrupts the current method. |
| [list_changes](#list_changes-method-googledrive-struct) | Lists changes to resources and shared drives. |
| [list_children](#list_children-method-googledrive-struct) | Lists the child resources of one or more folders. |
| [list_parents](#list_parents-method-googledrive-struct) | Lists the parent folders of a file or folder. |
| [list_permissions](#list_permissions-method-googledrive-struct) | Lists the permissions for a file, folder, or shared drive. |
| [list_resources](#list_resources-method-googledrive-struct) | Lists files and folders. |
| [list_revisions](#list_revisions-method-googledrive-struct) | List the revisions of a file. |
| [list_shared_drives](#list_shared_drives-method-googledrive-struct) | Lists shared drives that the current user is a member of. |
| [move_resource](#move_resource-method-googledrive-struct) | Moves a file or folder. |
| [remove_parents](#remove_parents-method-googledrive-struct) | Removes folders from the list of parents for a file or folder. |
| [remove_shared_drive_member](#remove_shared_drive_member-method-googledrive-struct) | Removes an existing shared drive member. |
| [reset](#reset-method-googledrive-struct) | Resets the struct to its initial state. |
| [restore_resource](#restore_resource-method-googledrive-struct) | Restores a file or folder from the trash. |
| [send_custom_request](#send_custom_request-method-googledrive-struct) | Sends a custom request to the Google Drive API. |
| [toggle_shared_drive_hidden](#toggle_shared_drive_hidden-method-googledrive-struct) | Hides or unhides a shared drive. |
| [trash_resource](#trash_resource-method-googledrive-struct) | Moves the specified file or folder to the trash. |
| [update_permissions](#update_permissions-method-googledrive-struct) | Create, update, and delete permissions on a file, folder, or shared drive. |
| [update_resource](#update_resource-method-googledrive-struct) | Updates a file or folder. |
| [update_shared_drive](#update_shared_drive-method-googledrive-struct) | Updates a shared drive. |
| [update_shared_drive_member](#update_shared_drive_member-method-googledrive-struct) | Updates an existing shared drive member's role. |
| [upload_file](#upload_file-method-googledrive-struct) | Uploads, and optionally converts, a new file. |

## Event List

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

|  |  |
| --- | --- |
| [on_change_list](#on_change_list-event-googledrive-struct) | Fires once for each change when ListChanges is called. |
| [on_end_transfer](#on_end_transfer-event-googledrive-struct) | Fired when a document finishes transferring. |
| [on_error](#on_error-event-googledrive-struct) | Fired when information is available about errors during data delivery. |
| [on_fragment_complete](#on_fragment_complete-event-googledrive-struct) | Fires after each fragment of a resumable upload is completed. |
| [on_header](#on_header-event-googledrive-struct) | Fired every time a header line comes in. |
| [on_log](#on_log-event-googledrive-struct) | Fired once for each log message. |
| [on_permission_list](#on_permission_list-event-googledrive-struct) | This event fires once for each permission returned when listing permissions. |
| [on_progress](#on_progress-event-googledrive-struct) | Fires during an upload or download to indicate transfer progress. |
| [on_resource_list](#on_resource_list-event-googledrive-struct) | Fires once for each resource returned when listing resources. |
| [on_shared_drive_list](#on_shared_drive_list-event-googledrive-struct) | Fires once for each shared drive returned when listing shared drives. |
| [on_ssl_server_authentication](#on_ssl_server_authentication-event-googledrive-struct) | Fired after the server presents its certificate to the client. |
| [on_ssl_status](#on_ssl_status-event-googledrive-struct) | Fired when secure connection progress messages are available. |
| [on_start_transfer](#on_start_transfer-event-googledrive-struct) | Fired when a document starts transferring (after the headers). |
| [on_transfer](#on_transfer-event-googledrive-struct) | Fired while a document transfers (delivers document). |

## Config Settings

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

|  |  |
| --- | --- |
| [AccumulatePages](#AccumulatePages) | Whether the struct should accumulate subsequent pages of results when listing them. |
| [DocsExportFormat](#DocsExportFormat) | The file format to export Google Docs files as when downloading. |
| [DownloadTempFile](#DownloadTempFile) | The temporary file used when downloading encrypted data. |
| [DrawingsExportFormat](#DrawingsExportFormat) | The file format to export Google Drawings files as when downloading. |
| [EncryptionIV](#EncryptionIV) | The initialization vector to be used for encryption/decryption. |
| [EncryptionKey](#EncryptionKey) | The key to use during encryption/decryption. |
| [EncryptionPasswordKDF](#EncryptionPasswordKDF) | The KDF algorithm to use during password based encryption and decryption. |
| [FragmentSize](#FragmentSize) | The fragment size. |
| [IconLink\[i\]](#IconLink[i]) | A static, unauthenticated link to the file icon for the specified resource. |
| [IncludeAllFields](#IncludeAllFields) | Whether to request all fields when listing resources. |
| [IncludeFolderProperties](#IncludeFolderProperties) | Whether resource properties apply when calling CreateFolder. |
| [ListResourcesMode](#ListResourcesMode) | What items to include when listing resources. |
| [MaxPermissionResults](#MaxPermissionResults) | Limits the number of permissions results. |
| [MaxResults](#MaxResults) | Limits the number of resource and change results. |
| [MaxSharedDriveResults](#MaxSharedDriveResults) | Limits the number of shared drive results. |
| [NormalizedFileName\[i\]](#NormalizedFileName[i]) | File name constructed using the specified resource's information. |
| [ProgressAbsolute](#ProgressAbsolute) | Whether the struct should track transfer progress absolutely. |
| [ProgressStep](#ProgressStep) | How often the progress event should be fired, in terms of percentage. |
| [RawRequest](#RawRequest) | Returns the data that was sent to the server. |
| [RawResponse](#RawResponse) | Returns the data that was received from the server. |
| [RequestedFields](#RequestedFields) | What fields to request when listing or getting objects. |
| [ResourceKey\[i\]](#ResourceKey[i]) | The resource key used to access a file. |
| [RevisionId](#RevisionId) | The ID of the revision to make request against. |
| [SearchIncomplete](#SearchIncomplete) | Indicates whether the server declined to search all possible locations when listing resources. |
| [SheetsExportFormat](#SheetsExportFormat) | The file format to export Google Sheets files as when downloading. |
| [SlidesExportFormat](#SlidesExportFormat) | The file format to export Google Slides files as when downloading. |
| [TempPath](#TempPath) | The path to the directory where temporary files are created. |
| [TransferOwnership](#TransferOwnership) | Must be set to True before modifying permissions in a manner that causes the owner of a resource to change. |
| [UseDomainAdminAccess](#UseDomainAdminAccess) | Whether to make requests using domain administrator permissions. |
| [XChildCount](#XChildCount) | The number of child elements of the current element. |
| [XChildName\[i\]](#XChildName[i]) | The name of the child element. |
| [XChildXText\[i\]](#XChildXText[i]) | The inner text of the child element. |
| [XElement](#XElement) | The name of the current element. |
| [XParent](#XParent) | The parent of the current element. |
| [XPath](#XPath) | Provides a way to point to a specific element in the returned XML or JSON response. |
| [XSubTree](#XSubTree) | A snapshot of the current element in the document. |
| [XText](#XText) | The text of the current element. |
| [OAuthAccessTokenExpiration](#OAuthAccessTokenExpiration) | The lifetime of the access token. |
| [OAuthAuthorizationTokenType](#OAuthAuthorizationTokenType) | The type of access token returned. |
| [OAuthAutomaticRefresh](#OAuthAutomaticRefresh) | Whether or not to refresh an expired access token automatically. |
| [OAuthBrowserResponseTimeout](#OAuthBrowserResponseTimeout) | Specifies the amount of time to wait for a response from the browser. |
| [OAuthIncludeEmptyRedirectURI](#OAuthIncludeEmptyRedirectURI) | Whether an empty redirect_uri parameter is included in requests. |
| [OAuthJWTPayload](#OAuthJWTPayload) | The payload of the JWT access token if present. |
| [OAuthJWTXChildCount](#OAuthJWTXChildCount) | The number of child elements of the current element. |
| [OauthJWTXChildName\[i\]](#OauthJWTXChildName[i]) | The name of the child element. |
| [OAuthJWTXChildXText\[i\]](#OAuthJWTXChildXText[i]) | The inner text of the child element. |
| [OAuthJWTXElement](#OAuthJWTXElement) | The name of the current element. |
| [OauthJWTXParent](#OauthJWTXParent) | The parent of the current element. |
| [OAuthJWTXPath](#OAuthJWTXPath) | Provides a way to point to a specific element in the returned payload of a JWT based access token. |
| [OAuthJWTXSubTree](#OAuthJWTXSubTree) | A snapshot of the current element in the document. |
| [OAuthJWTXText](#OAuthJWTXText) | The text of the current element. |
| [OAuthParamCount](#OAuthParamCount) | Specifies the number of additional parameters variables to include in the request. |
| [OAuthParamName\[i\]](#OAuthParamName[i]) | Specifies the parameter name at the specified index. |
| [OAuthParamValue\[i\]](#OAuthParamValue[i]) | Specifies the parameter value at the specified index. |
| [OAuthPasswordGrantUsername](#OAuthPasswordGrantUsername) | Used in the Resource Owner Password grant type. |
| [OAuthPKCEChallengeEncoding](#OAuthPKCEChallengeEncoding) | The PKCE code challenge method to use. |
| [OAuthPKCEVerifier](#OAuthPKCEVerifier) | The PKCE verifier used to generate the challenge. |
| [OAuthResetData](#OAuthResetData) | Determines if the Reset method applies to the OAuth settings. |
| [OAuthReUseWebServer](#OAuthReUseWebServer) | Determines if the same server instance is used between requests. |
| [OAuthTransferredRequest](#OAuthTransferredRequest) | The full OAuth request last sent by the client. |
| [OAuthUsePKCE](#OAuthUsePKCE) | Specifies if PKCE should be used. |
| [OAuthWebServerActive](#OAuthWebServerActive) | Specifies and controls whether the embedded web server is active. |
| [OAuthWebServerCertStore](#OAuthWebServerCertStore) | The certificate with private key to use when SSL is enabled. |
| [OAuthWebServerCertStorePassword](#OAuthWebServerCertStorePassword) | The certificate with private key to use when SSL is enabled. |
| [OAuthWebServerCertStoreType](#OAuthWebServerCertStoreType) | The certificate with private key to use when SSL is enabled. |
| [OAuthWebServerCertSubject](#OAuthWebServerCertSubject) | The certificate with private key to use when SSL is enabled. |
| [OAuthWebServerFailedResponse](#OAuthWebServerFailedResponse) | The custom response that will be displayed to the user if authentication failed. |
| [OAuthWebServerHost](#OAuthWebServerHost) | The hostname used by the embedded web server displayed in the ReturnURL. |
| [OAuthWebServerPort](#OAuthWebServerPort) | The local port on which the embedded web server listens. |
| [OAuthWebServerResponse](#OAuthWebServerResponse) | The custom response that will be displayed to the user. |
| [OAuthWebServerSSLEnabled](#OAuthWebServerSSLEnabled) | Whether the web server requires SSL connections. |
| [AcceptEncoding](#AcceptEncoding) | Used to tell the server which types of content encodings the client supports. |
| [AllowHTTPCompression](#AllowHTTPCompression) | This property enables HTTP compression for receiving data. |
| [AllowHTTPFallback](#AllowHTTPFallback) | Whether HTTP/2 connections are permitted to fallback to HTTP/1.1. |
| [Append](#Append) | Whether to append data to LocalFile. |
| [Authorization](#Authorization) | The Authorization string to be sent to the server. |
| [BytesTransferred](#BytesTransferred) | Contains the number of bytes transferred in the response data. |
| [ChunkSize](#ChunkSize) | Specifies the chunk size in bytes when using chunked encoding. |
| [CompressHTTPRequest](#CompressHTTPRequest) | Set to true to compress the body of a PUT or POST request. |
| [EncodeURL](#EncodeURL) | If set to True the URL will be encoded by the struct. |
| [FollowRedirects](#FollowRedirects) | Determines what happens when the server issues a redirect. |
| [GetOn302Redirect](#GetOn302Redirect) | If set to True the struct will perform a GET on the new location. |
| [HTTP2HeadersWithoutIndexing](#HTTP2HeadersWithoutIndexing) | HTTP2 headers that should not update the dynamic header table with incremental indexing. |
| [HTTPVersion](#HTTPVersion) | The version of HTTP used by the struct. |
| [IfModifiedSince](#IfModifiedSince) | A date determining the maximum age of the desired document. |
| [KeepAlive](#KeepAlive) | Determines whether the HTTP connection is closed after completion of the request. |
| [KerberosSPN](#KerberosSPN) | The Service Principal Name for the Kerberos Domain Controller. |
| [LogLevel](#LogLevel) | The level of detail that is logged. |
| [MaxRedirectAttempts](#MaxRedirectAttempts) | Limits the number of redirects that are followed in a request. |
| [NegotiatedHTTPVersion](#NegotiatedHTTPVersion) | The negotiated HTTP version. |
| [OtherHeaders](#OtherHeaders) | Other headers as determined by the user (optional). |
| [ProxyAuthorization](#ProxyAuthorization) | The authorization string to be sent to the proxy server. |
| [ProxyAuthScheme](#ProxyAuthScheme) | The authorization scheme to be used for the proxy. |
| [ProxyPassword](#ProxyPassword) | A password if authentication is to be used for the proxy. |
| [ProxyPort](#ProxyPort) | Port for the proxy server (default 80). |
| [ProxyServer](#ProxyServer) | Name or IP address of a proxy server (optional). |
| [ProxyUser](#ProxyUser) | A user name if authentication is to be used for the proxy. |
| [SentHeaders](#SentHeaders) | The full set of headers as sent by the client. |
| [StatusCode](#StatusCode) | The status code of the last response from the server. |
| [StatusLine](#StatusLine) | The first line of the last response from the server. |
| [TransferredData](#TransferredData) | The contents of the last response from the server. |
| [TransferredDataLimit](#TransferredDataLimit) | The maximum number of incoming bytes to be stored by the struct. |
| [TransferredHeaders](#TransferredHeaders) | The full set of headers as received from the server. |
| [TransferredRequest](#TransferredRequest) | The full request as sent by the client. |
| [UseChunkedEncoding](#UseChunkedEncoding) | Enables or Disables HTTP chunked encoding for transfers. |
| [UseIDNs](#UseIDNs) | Whether to encode hostnames to internationalized domain names. |
| [UseProxyAutoConfigURL](#UseProxyAutoConfigURL) | Whether to use a Proxy auto-config file when attempting a connection. |
| [UserAgent](#UserAgent) | Information about the user agent (browser). |
| [ConnectionTimeout](#ConnectionTimeout) | Sets a separate timeout value for establishing a connection. |
| [FirewallAutoDetect](#FirewallAutoDetect) | Tells the struct whether or not to automatically detect and use firewall system settings, if available. |
| [FirewallHost](#FirewallHost) | Name or IP address of firewall (optional). |
| [FirewallHTTPVersion](#FirewallHTTPVersion) | The HTTP version to be used when connecting through a tunneling proxy. |
| [FirewallPassword](#FirewallPassword) | Password to be used if authentication is to be used when connecting through the firewall. |
| [FirewallPort](#FirewallPort) | The TCP port for the FirewallHost;. |
| [FirewallType](#FirewallType) | Determines the type of firewall to connect through. |
| [FirewallUser](#FirewallUser) | A user name if authentication is to be used connecting through a firewall. |
| [KeepAliveInterval](#KeepAliveInterval) | The retry interval, in milliseconds, to be used when a TCP keep-alive packet is sent and no response is received. |
| [KeepAliveTime](#KeepAliveTime) | The inactivity time in milliseconds before a TCP keep-alive packet is sent. |
| [Linger](#Linger) | When set to True, connections are terminated gracefully. |
| [LingerTime](#LingerTime) | Time in seconds to have the connection linger. |
| [LocalHost](#LocalHost) | The name of the local host through which connections are initiated or accepted. |
| [LocalPort](#LocalPort) | The port in the local host where the struct binds. |
| [MaxLineLength](#MaxLineLength) | The maximum amount of data to accumulate when no EOL is found. |
| [MaxTransferRate](#MaxTransferRate) | The transfer rate limit in bytes per second. |
| [ProxyExceptionsList](#ProxyExceptionsList) | A semicolon separated list of hosts and IPs to bypass when using a proxy. |
| [TCPKeepAlive](#TCPKeepAlive) | Determines whether or not the keep alive socket option is enabled. |
| [TcpNoDelay](#TcpNoDelay) | Whether or not to delay when sending packets. |
| [UseIPv6](#UseIPv6) | Whether to use IPv6. |
| [UseNTLMv2](#UseNTLMv2) | Whether to use NTLM V2. |
| [LogSSLPackets](#LogSSLPackets) | Controls whether SSL packets are logged when using the internal security API. |
| [OpenSSLCADir](#OpenSSLCADir) | The path to a directory containing CA certificates. |
| [OpenSSLCAFile](#OpenSSLCAFile) | Name of the file containing the list of CA's trusted by your application. |
| [OpenSSLCipherList](#OpenSSLCipherList) | A string that controls the ciphers to be used by SSL. |
| [OpenSSLPrngSeedData](#OpenSSLPrngSeedData) | The data to seed the pseudo random number generator (PRNG). |
| [ReuseSSLSession](#ReuseSSLSession) | Determines if the SSL session is reused. |
| [SSLCACerts](#SSLCACerts) | A newline separated list of CA certificates to be included when performing an SSL handshake. |
| [SSLCheckCRL](#SSLCheckCRL) | Whether to check the Certificate Revocation List for the server certificate. |
| [SSLCheckOCSP](#SSLCheckOCSP) | Whether to use OCSP to check the status of the server certificate. |
| [SSLCipherStrength](#SSLCipherStrength) | The minimum cipher strength used for bulk encryption. |
| [SSLClientCACerts](#SSLClientCACerts) | A newline separated list of CA certificates to use during SSL client certificate validation. |
| [SSLEnabledCipherSuites](#SSLEnabledCipherSuites) | The cipher suite to be used in an SSL negotiation. |
| [SSLEnabledProtocols](#SSLEnabledProtocols) | Used to enable/disable the supported security protocols. |
| [SSLEnableRenegotiation](#SSLEnableRenegotiation) | Whether the renegotiation_info SSL extension is supported. |
| [SSLIncludeCertChain](#SSLIncludeCertChain) | Whether the entire certificate chain is included in the SSLServerAuthentication event. |
| [SSLKeyLogFile](#SSLKeyLogFile) | The location of a file where per-session secrets are written for debugging purposes. |
| [SSLNegotiatedCipher](#SSLNegotiatedCipher) | Returns the negotiated cipher suite. |
| [SSLNegotiatedCipherStrength](#SSLNegotiatedCipherStrength) | Returns the negotiated cipher suite strength. |
| [SSLNegotiatedCipherSuite](#SSLNegotiatedCipherSuite) | Returns the negotiated cipher suite. |
| [SSLNegotiatedKeyExchange](#SSLNegotiatedKeyExchange) | Returns the negotiated key exchange algorithm. |
| [SSLNegotiatedKeyExchangeStrength](#SSLNegotiatedKeyExchangeStrength) | Returns the negotiated key exchange algorithm strength. |
| [SSLNegotiatedVersion](#SSLNegotiatedVersion) | Returns the negotiated protocol version. |
| [SSLSecurityFlags](#SSLSecurityFlags) | Flags that control certificate verification. |
| [SSLServerCACerts](#SSLServerCACerts) | A newline separated list of CA certificates to use during SSL server certificate validation. |
| [TLS12SignatureAlgorithms](#TLS12SignatureAlgorithms) | Defines the allowed TLS 1.2 signature algorithms when SSLProvider is set to Internal. |
| [TLS12SupportedGroups](#TLS12SupportedGroups) | The supported groups for ECC. |
| [TLS13KeyShareGroups](#TLS13KeyShareGroups) | The groups for which to pregenerate key shares. |
| [TLS13SignatureAlgorithms](#TLS13SignatureAlgorithms) | The allowed certificate signature algorithms. |
| [TLS13SupportedGroups](#TLS13SupportedGroups) | The supported groups for (EC)DHE key exchange. |
| [AbsoluteTimeout](#AbsoluteTimeout) | Determines whether timeouts are inactivity timeouts or absolute timeouts. |
| [FirewallData](#FirewallData) | Used to send extra data to the firewall. |
| [InBufferSize](#InBufferSize) | The size in bytes of the incoming queue of the socket. |
| [OutBufferSize](#OutBufferSize) | The size in bytes of the outgoing queue of the socket. |
| [BuildInfo](#BuildInfo) | Information about the product's build. |
| [CodePage](#CodePage) | The system code page used for Unicode to Multibyte translations. |
| [LicenseInfo](#LicenseInfo) | Information about the current license. |
| [MaskSensitiveData](#MaskSensitiveData) | Whether sensitive data is masked in log messages. |
| [UseInternalSecurityAPI](#UseInternalSecurityAPI) | Whether or not to use the system security libraries or an internal implementation. |

# account_can_create_shared_drives property ([GoogleDrive](#struct-cloudstoragegoogledrive) Struct)

Whether the account has permission to create shared drives.

## Syntax

*Rust Syntax*

```text
fn account_can_create_shared_drives(&self ) -> Result<bool, CloudStorageError>
```

## 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.

## Data Type

bool

# account_drive_usage property ([GoogleDrive](#struct-cloudstoragegoogledrive) Struct)

Amount of storage used in Google Drive.

## Syntax

*Rust Syntax*

```text
fn account_drive_usage(&self ) -> Result<i64, CloudStorageError>
```

## 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.

## Data Type

i64

# account_email property ([GoogleDrive](#struct-cloudstoragegoogledrive) Struct)

The email address of the account.

## Syntax

*Rust Syntax*

```text
fn account_email(&self ) -> Result<String, CloudStorageError>
```

## Default Value

""

## Remarks

The email address of the account.

This property reflects the email address associated with the account.

This property is read-only.

## Data Type

String

# account_name property ([GoogleDrive](#struct-cloudstoragegoogledrive) Struct)

The name of the account's user.

## Syntax

*Rust Syntax*

```text
fn account_name(&self ) -> Result<String, CloudStorageError>
```

## 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.

## Data Type

String

# account_permission_id property ([GoogleDrive](#struct-cloudstoragegoogledrive) Struct)

The permission Id associated with the account.

## Syntax

*Rust Syntax*

```text
fn account_permission_id(&self ) -> Result<String, CloudStorageError>
```

## 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.

## Data Type

String

# account_storage_quota property ([GoogleDrive](#struct-cloudstoragegoogledrive) Struct)

The account's storage quota.

## Syntax

*Rust Syntax*

```text
fn account_storage_quota(&self ) -> Result<i64, CloudStorageError>
```

## 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.

## Data Type

i64

# account_storage_usage property ([GoogleDrive](#struct-cloudstoragegoogledrive) Struct)

Amount of storage used across all Google services.

## Syntax

*Rust Syntax*

```text
fn account_storage_usage(&self ) -> Result<i64, CloudStorageError>
```

## 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.

## Data Type

i64

# account_trash_usage property ([GoogleDrive](#struct-cloudstoragegoogledrive) Struct)

Amount of storage used by trashed items in Google Drive.

## Syntax

*Rust Syntax*

```text
fn account_trash_usage(&self ) -> Result<i64, CloudStorageError>
```

## 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.

## Data Type

i64

# authorization property ([GoogleDrive](#struct-cloudstoragegoogledrive) Struct)

The OAuth 2.0 authorization token.

## Syntax

*Rust Syntax*

```text
fn authorization(&self ) -> Result<String, CloudStorageError> fn set_authorization(&self, value : &str) ->  Option<CloudStorageError>
fn set_authorization_ref(&self, value : &String) ->  Option<CloudStorageError>
```

## Default Value

""

## Remarks

This property is used to specify the OAuth 2.0 authorization token that was obtained as a result of performing OAuth. A valid OAuth token will come in the following format:

```text
Bearer ACCESS_TOKEN
```

The *ACCESS_TOKEN* segment must be supplied to this property before attempting any other operations. Consult the documentation for the service for more information about supported scope values and more details on performing OAuth.

## Data Type

String

# change_marker property ([GoogleDrive](#struct-cloudstoragegoogledrive) Struct)

A marker indicating what page of changes to return next.

## Syntax

*Rust Syntax*

```text
fn change_marker(&self ) -> Result<String, CloudStorageError> fn set_change_marker(&self, value : &str) ->  Option<CloudStorageError>
fn set_change_marker_ref(&self, value : &String) ->  Option<CloudStorageError>
```

## Default Value

""

## Remarks

This property will be populated when [list_changes](#list_changes-method-googledrive-struct) is called if the results are paged and there are more pages. To list all changes, continue to call [list_changes](#list_changes-method-googledrive-struct) until this property returns empty string.

Setting change_marker will cause [next_change_marker](#next_change_marker-property-googledrive-struct) to be set to empty string.

Refer to [list_changes](#list_changes-method-googledrive-struct) for more information.

## Data Type

String

# change_count property ([GoogleDrive](#struct-cloudstoragegoogledrive) Struct)

The number of records in the Change arrays.

## Syntax

*Rust Syntax*

```text
fn change_count(&self ) -> Result<i32, CloudStorageError>
```

## Default Value

0

## Remarks

This property controls the size of the following arrays:

- [change_removed](#change_removed-property-googledrive-struct)
- [change_resource_id](#change_resource_id-property-googledrive-struct)
- [change_shared_drive_id](#change_shared_drive_id-property-googledrive-struct)
- [change_time](#change_time-property-googledrive-struct)
- [change_type](#change_type-property-googledrive-struct)

The array indices start at *0* and end at *change_count - 1*.

This property is read-only.

## Data Type

i32

# change_type property ([GoogleDrive](#struct-cloudstoragegoogledrive) Struct)

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

## Syntax

*Rust Syntax*

```text
fn change_type(&self , ChangeIndex : i32) -> Result<i32, CloudStorageError>
```

## Possible Values

```text
0   // File1   // SharedDrive
```

## 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](#change_count-property-googledrive-struct) property.

This property is read-only.

## Data Type

i32

# change_removed property ([GoogleDrive](#struct-cloudstoragegoogledrive) Struct)

Whether the file or shared drive has been removed.

## Syntax

*Rust Syntax*

```text
fn change_removed(&self , ChangeIndex : i32) -> Result<bool, CloudStorageError>
```

## 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](#change_count-property-googledrive-struct) property.

This property is read-only.

## Data Type

bool

# change_resource_id property ([GoogleDrive](#struct-cloudstoragegoogledrive) Struct)

The Id of the file to which the change applies.

## Syntax

*Rust Syntax*

```text
fn change_resource_id(&self , ChangeIndex : i32) -> Result<String, CloudStorageError>
```

## 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](#change_count-property-googledrive-struct) property.

This property is read-only.

## Data Type

String

# change_shared_drive_id property ([GoogleDrive](#struct-cloudstoragegoogledrive) Struct)

The Id of the shared drive.

## Syntax

*Rust Syntax*

```text
fn change_shared_drive_id(&self , ChangeIndex : i32) -> Result<String, CloudStorageError>
```

## Default Value

""

## Remarks

The Id of the shared drive.

This property holds the Id of the shared drive to which the change applies (if [change_change_type](#GoogleDrive_p_ChangeChangeType) is *ctSharedDrive (1)*), or which owns the file to which the change applies (if [change_change_type](#GoogleDrive_p_ChangeChangeType) 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](#change_count-property-googledrive-struct) property.

This property is read-only.

## Data Type

String

# change_time property ([GoogleDrive](#struct-cloudstoragegoogledrive) Struct)

The time of the change.

## Syntax

*Rust Syntax*

```text
fn change_time(&self , ChangeIndex : i32) -> Result<String, CloudStorageError>
```

## 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](#change_count-property-googledrive-struct) property.

This property is read-only.

## Data Type

String

# child_marker property ([GoogleDrive](#struct-cloudstoragegoogledrive) Struct)

A marker when child resources are paged.

## Syntax

*Rust Syntax*

```text
fn child_marker(&self ) -> Result<String, CloudStorageError> fn set_child_marker(&self, value : &str) ->  Option<CloudStorageError>
fn set_child_marker_ref(&self, value : &String) ->  Option<CloudStorageError>
```

## Default Value

""

## Remarks

This property returns a marker used to iterate over pages of child resources; it's populated when [list_children](#list_children-method-googledrive-struct) is called if the results are paged.

Continue to call [list_children](#list_children-method-googledrive-struct) until this property returns empty string in order to list all resources.

## Data Type

String

# child_count property ([GoogleDrive](#struct-cloudstoragegoogledrive) Struct)

The number of records in the Child arrays.

## Syntax

*Rust Syntax*

```text
fn child_count(&self ) -> Result<i32, CloudStorageError>
```

## Default Value

0

## Remarks

This property controls the size of the following arrays:

- [child_content_accessible](#child_content_accessible-property-googledrive-struct)
- [child_created_time](#child_created_time-property-googledrive-struct)
- [child_description](#child_description-property-googledrive-struct)
- [child_extension](#child_extension-property-googledrive-struct)
- [child_id](#child_id-property-googledrive-struct)
- [child_md5_checksum](#child_md5_checksum-property-googledrive-struct)
- [child_mime_type](#child_mime_type-property-googledrive-struct)
- [child_modified_time](#child_modified_time-property-googledrive-struct)
- [child_name](#child_name-property-googledrive-struct)
- [child_original_name](#child_original_name-property-googledrive-struct)
- [child_owner](#child_owner-property-googledrive-struct)
- [child_owner_email](#child_owner_email-property-googledrive-struct)
- [child_parent_ids](#child_parent_ids-property-googledrive-struct)
- [child_shared_drive_id](#child_shared_drive_id-property-googledrive-struct)
- [child_size](#child_size-property-googledrive-struct)
- [child_starred](#child_starred-property-googledrive-struct)
- [child_trashed](#child_trashed-property-googledrive-struct)
- [child_type](#child_type-property-googledrive-struct)
- [child_viewed](#child_viewed-property-googledrive-struct)
- [child_view_link](#child_view_link-property-googledrive-struct)

The array indices start at *0* and end at *child_count - 1*.

This property is read-only.

## Data Type

i32

# child_content_accessible property ([GoogleDrive](#struct-cloudstoragegoogledrive) Struct)

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

## Syntax

*Rust Syntax*

```text
fn child_content_accessible(&self , ChildIndex : i32) -> Result<bool, CloudStorageError>
```

## 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](#child_count-property-googledrive-struct) property.

This property is read-only.

## Data Type

bool

# child_created_time property ([GoogleDrive](#struct-cloudstoragegoogledrive) Struct)

The creation date of the resource.

## Syntax

*Rust Syntax*

```text
fn child_created_time(&self , ChildIndex : i32) -> Result<String, CloudStorageError>
```

## 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 struct only uses it as input when [upload_file](#upload_file-method-googledrive-struct) is called; it is ignored when calling [update_resource](#update_resource-method-googledrive-struct).

The *ChildIndex* parameter specifies the index of the item in the array. The size of the array is controlled by the [ChildCount](#child_count-property-googledrive-struct) property.

This property is read-only.

## Data Type

String

# child_description property ([GoogleDrive](#struct-cloudstoragegoogledrive) Struct)

A short description of the resource.

## Syntax

*Rust Syntax*

```text
fn child_description(&self , ChildIndex : i32) -> Result<String, CloudStorageError>
```

## 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](#child_count-property-googledrive-struct) property.

This property is read-only.

## Data Type

String

# child_extension property ([GoogleDrive](#struct-cloudstoragegoogledrive) Struct)

The file extension of the resource.

## Syntax

*Rust Syntax*

```text
fn child_extension(&self , ChildIndex : i32) -> Result<String, CloudStorageError>
```

## 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 [upload_file](#upload_file-method-googledrive-struct).

The *ChildIndex* parameter specifies the index of the item in the array. The size of the array is controlled by the [ChildCount](#child_count-property-googledrive-struct) property.

This property is read-only.

## Data Type

String

# child_id property ([GoogleDrive](#struct-cloudstoragegoogledrive) Struct)

The Id of the resource.

## Syntax

*Rust Syntax*

```text
fn child_id(&self , ChildIndex : i32) -> Result<String, CloudStorageError>
```

## Default Value

""

## Remarks

The Id of the resource.

This property holds the Id of the resource.

This property must be set before calling [update_resource](#update_resource-method-googledrive-struct).

The *ChildIndex* parameter specifies the index of the item in the array. The size of the array is controlled by the [ChildCount](#child_count-property-googledrive-struct) property.

This property is read-only.

## Data Type

String

# child_md5_checksum property ([GoogleDrive](#struct-cloudstoragegoogledrive) Struct)

The MD5 checksum of the file resource.

## Syntax

*Rust Syntax*

```text
fn child_md5_checksum(&self , ChildIndex : i32) -> Result<String, CloudStorageError>
```

## 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](#child_count-property-googledrive-struct) property.

This property is read-only.

## Data Type

String

# child_mime_type property ([GoogleDrive](#struct-cloudstoragegoogledrive) Struct)

The MIME type of the resource.

## Syntax

*Rust Syntax*

```text
fn child_mime_type(&self , ChildIndex : i32) -> Result<String, CloudStorageError>
```

## Default Value

""

## Remarks

The MIME type of the resource.

This property specifies the MIME type of the resource.

When calling [upload_file](#upload_file-method-googledrive-struct), this property is ignored in favor of the *MimeType* parameter of [upload_file](#upload_file-method-googledrive-struct).

When calling [update_resource](#update_resource-method-googledrive-struct), this property is only submitted if new file data is being uploaded.

Some Google Drive MIME types:

|  |  |
| --- | --- |
| application/vnd.google-apps.audio |  |
| application/vnd.google-apps.document | Google Docs |
| application/vnd.google-apps.drawing | Google Drawing |
| application/vnd.google-apps.file | Google Drive file |
| application/vnd.google-apps.folder | Google Drive folder |
| application/vnd.google-apps.form | Google Forms |
| application/vnd.google-apps.fusiontable | Google Fusion Tables |
| application/vnd.google-apps.kix | Google Docs |
| application/vnd.google-apps.photo |  |
| application/vnd.google-apps.presentation | Google Slides |
| application/vnd.google-apps.script | Google Apps Scripts |
| application/vnd.google-apps.sites | Google Sites |
| application/vnd.google-apps.spreadsheet | Google Sheets |
| application/vnd.google-apps.unknown |  |
| application/vnd.google-apps.video |  |

The *ChildIndex* parameter specifies the index of the item in the array. The size of the array is controlled by the [ChildCount](#child_count-property-googledrive-struct) property.

This property is read-only.

## Data Type

String

# child_modified_time property ([GoogleDrive](#struct-cloudstoragegoogledrive) Struct)

The last modified date of the resource.

## Syntax

*Rust Syntax*

```text
fn child_modified_time(&self , ChildIndex : i32) -> Result<String, CloudStorageError>
```

## 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](#child_count-property-googledrive-struct) property.

This property is read-only.

## Data Type

String

# child_name property ([GoogleDrive](#struct-cloudstoragegoogledrive) Struct)

The name of the resource.

## Syntax

*Rust Syntax*

```text
fn child_name(&self , ChildIndex : i32) -> Result<String, CloudStorageError>
```

## 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](#child_count-property-googledrive-struct) property.

This property is read-only.

## Data Type

String

# child_original_name property ([GoogleDrive](#struct-cloudstoragegoogledrive) Struct)

The original name of the file resource.

## Syntax

*Rust Syntax*

```text
fn child_original_name(&self , ChildIndex : i32) -> Result<String, CloudStorageError>
```

## 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 [child_name](#child_name-property-googledrive-struct) 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](#child_count-property-googledrive-struct) property.

This property is read-only.

## Data Type

String

# child_owner property ([GoogleDrive](#struct-cloudstoragegoogledrive) Struct)

The name of the resource's owner.

## Syntax

*Rust Syntax*

```text
fn child_owner(&self , ChildIndex : i32) -> Result<String, CloudStorageError>
```

## 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](#child_count-property-googledrive-struct) property.

This property is read-only.

## Data Type

String

# child_owner_email property ([GoogleDrive](#struct-cloudstoragegoogledrive) Struct)

The email address of the resource's owner.

## Syntax

*Rust Syntax*

```text
fn child_owner_email(&self , ChildIndex : i32) -> Result<String, CloudStorageError>
```

## 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](#child_count-property-googledrive-struct) property.

This property is read-only.

## Data Type

String

# child_parent_ids property ([GoogleDrive](#struct-cloudstoragegoogledrive) Struct)

The Ids of the resource's parent folders.

## Syntax

*Rust Syntax*

```text
fn child_parent_ids(&self , ChildIndex : i32) -> Result<String, CloudStorageError>
```

## 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 struct only uses it as input when [upload_file](#upload_file-method-googledrive-struct) is called. To modify a resource's parents in any other case, use the [add_parents](#add_parents-method-googledrive-struct), [remove_parents](#remove_parents-method-googledrive-struct), and [move_resource](#move_resource-method-googledrive-struct) methods.

The *ChildIndex* parameter specifies the index of the item in the array. The size of the array is controlled by the [ChildCount](#child_count-property-googledrive-struct) property.

This property is read-only.

## Data Type

String

# child_type property ([GoogleDrive](#struct-cloudstoragegoogledrive) Struct)

The resource's type.

## Syntax

*Rust Syntax*

```text
fn child_type(&self , ChildIndex : i32) -> Result<i32, CloudStorageError>
```

## Possible Values

```text
0   // File1   // Folder
```

## Default Value

0

## Remarks

The resource's type.

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

|  |  |
| --- | --- |
| 0 (gdrtFile) | A file. |
| 1 (gdrtFolder) | A folder. |
| 2 (gdrtRevision) | A revision. |

Google treats files and folders in the same way, and folders are included when listing resources. The [resource_access_type](#Dropbox_p_ResourceAccessType) 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 [list_resources](#list_resources-method-googledrive-struct), [delete_resource](#delete_resource-method-googledrive-struct), and [update_resource](#update_resource-method-googledrive-struct) methods.

The *ChildIndex* parameter specifies the index of the item in the array. The size of the array is controlled by the [ChildCount](#child_count-property-googledrive-struct) property.

This property is read-only.

## Data Type

i32

# child_shared_drive_id property ([GoogleDrive](#struct-cloudstoragegoogledrive) Struct)

The Id of the shared drive the resource is in.

## Syntax

*Rust Syntax*

```text
fn child_shared_drive_id(&self , ChildIndex : i32) -> Result<String, CloudStorageError>
```

## 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](#child_count-property-googledrive-struct) property.

This property is read-only.

## Data Type

String

# child_size property ([GoogleDrive](#struct-cloudstoragegoogledrive) Struct)

The size of the file resource in bytes.

## Syntax

*Rust Syntax*

```text
fn child_size(&self , ChildIndex : i32) -> Result<i64, CloudStorageError>
```

## 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](#child_count-property-googledrive-struct) property.

This property is read-only.

## Data Type

i64

# child_starred property ([GoogleDrive](#struct-cloudstoragegoogledrive) Struct)

Whether the resource is starred.

## Syntax

*Rust Syntax*

```text
fn child_starred(&self , ChildIndex : i32) -> Result<bool, CloudStorageError>
```

## 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](#child_count-property-googledrive-struct) property.

This property is read-only.

## Data Type

bool

# child_trashed property ([GoogleDrive](#struct-cloudstoragegoogledrive) Struct)

Whether the resource is in the trash.

## Syntax

*Rust Syntax*

```text
fn child_trashed(&self , ChildIndex : i32) -> Result<bool, CloudStorageError>
```

## 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 struct only uses it as input when [update_resource](#update_resource-method-googledrive-struct) is called; it is ignored when calling [upload_file](#upload_file-method-googledrive-struct).

The *ChildIndex* parameter specifies the index of the item in the array. The size of the array is controlled by the [ChildCount](#child_count-property-googledrive-struct) property.

This property is read-only.

## Data Type

bool

# child_viewed property ([GoogleDrive](#struct-cloudstoragegoogledrive) Struct)

Whether the resource has been viewed.

## Syntax

*Rust Syntax*

```text
fn child_viewed(&self , ChildIndex : i32) -> Result<bool, CloudStorageError>
```

## 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](#child_count-property-googledrive-struct) property.

This property is read-only.

## Data Type

bool

# child_view_link property ([GoogleDrive](#struct-cloudstoragegoogledrive) Struct)

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

## Syntax

*Rust Syntax*

```text
fn child_view_link(&self , ChildIndex : i32) -> Result<String, CloudStorageError>
```

## 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](#child_count-property-googledrive-struct) property.

This property is read-only.

## Data Type

String

# encryption_algorithm property ([GoogleDrive](#struct-cloudstoragegoogledrive) Struct)

The encryption algorithm.

## Syntax

*Rust Syntax*

```text
fn encryption_algorithm(&self ) -> Result<i32, CloudStorageError> fn set_encryption_algorithm(&self, value : i32) ->  Option<CloudStorageError>
```

## Possible Values

```text
0   // AES1   // Blowfish2   // CAST3   // DES4   // IDEA5   // RC26   // RC47   // TEA8   // TripleDES9   // Twofish10   // Rijndael11   // ChaCha12   // XSalsa20
```

## 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:

| Algorithm | Key Size |
| --- | --- |
| 0 (eaAES - default) | 256 |
| 1 (eaBlowfish) | 448 |
| 2 (eaCAST) | 128 |
| 3 (eaDES) | 64 |
| 4 (eaIDEA) | 128 |
| 5 (eaRC2) | 128 |
| 6 (eaRC4) | 2048 |
| 7 (eaTEA) | 128 |
| 8 (eaTripleDES) | 192 |
| 9 (eaTwofish) | 256 |
| 10 (eaRijndael) | 256 |
| 11 (eaChaCha) | 256 |
| 12 (eaXSalsa20) | 256 |

## Data Type

i32

# encryption_password property ([GoogleDrive](#struct-cloudstoragegoogledrive) Struct)

The encryption password.

## Syntax

*Rust Syntax*

```text
fn encryption_password(&self ) -> Result<String, CloudStorageError> fn set_encryption_password(&self, value : &str) ->  Option<CloudStorageError>
fn set_encryption_password_ref(&self, value : &String) ->  Option<CloudStorageError>
```

## Default Value

""

## Remarks

If this property is populated when [upload_file](#upload_file-method-googledrive-struct) or [download_file](#download_file-method-googledrive-struct) is called, the struct will attempt to encrypt or decrypt the data before uploading or after downloading it.

The struct 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](#EncryptionKey) and [EncryptionIV](#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.

## Data Type

String

# firewall_auto_detect property ([GoogleDrive](#struct-cloudstoragegoogledrive) Struct)

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

## Syntax

*Rust Syntax*

```text
fn firewall_auto_detect(&self ) -> Result<bool, CloudStorageError> fn set_firewall_auto_detect(&self, value : bool) ->  Option<CloudStorageError>
```

## Default Value

false

## Remarks

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

## Data Type

bool

# firewall_type property ([GoogleDrive](#struct-cloudstoragegoogledrive) Struct)

The type of firewall to connect through.

## Syntax

*Rust Syntax*

```text
fn firewall_type(&self ) -> Result<i32, CloudStorageError> fn set_firewall_type(&self, value : i32) ->  Option<CloudStorageError>
```

## Possible Values

```text
0   // None1   // Tunnel2   // SOCKS43   // SOCKS510   // SOCKS4A
```

## Default Value

0

## Remarks

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

|  |  |
| --- | --- |
| fwNone (0) | No firewall (default setting). |
| fwTunnel (1) | Connect through a tunneling proxy. [firewall_port](#firewall_port-property-googledrive-struct) is set to 80. |
| fwSOCKS4 (2) | Connect through a SOCKS4 Proxy. [firewall_port](#firewall_port-property-googledrive-struct) is set to 1080. |
| fwSOCKS5 (3) | Connect through a SOCKS5 Proxy. [firewall_port](#firewall_port-property-googledrive-struct) is set to 1080. |
| fwSOCKS4A (10) | Connect through a SOCKS4A Proxy. [firewall_port](#firewall_port-property-googledrive-struct) is set to 1080. |

## Data Type

i32

# firewall_host property ([GoogleDrive](#struct-cloudstoragegoogledrive) Struct)

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

## Syntax

*Rust Syntax*

```text
fn firewall_host(&self ) -> Result<String, CloudStorageError> fn set_firewall_host(&self, value : &str) ->  Option<CloudStorageError>
fn set_firewall_host_ref(&self, value : &String) ->  Option<CloudStorageError>
```

## Default Value

""

## Remarks

The name or IP address of the firewall (optional). If a [firewall_host](#firewall_host-property-googledrive-struct) 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 struct fails with an error.

## Data Type

String

# firewall_password property ([GoogleDrive](#struct-cloudstoragegoogledrive) Struct)

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

## Syntax

*Rust Syntax*

```text
fn firewall_password(&self ) -> Result<String, CloudStorageError> fn set_firewall_password(&self, value : &str) ->  Option<CloudStorageError>
fn set_firewall_password_ref(&self, value : &String) ->  Option<CloudStorageError>
```

## Default Value

""

## Remarks

A password if authentication is to be used when connecting through the firewall. If [firewall_host](#firewall_host-property-googledrive-struct) is specified, the [firewall_user](#firewall_user-property-googledrive-struct) and [firewall_password](#firewall_password-property-googledrive-struct) properties are used to connect and authenticate to the given firewall. If the authentication fails, the struct fails with an error.

## Data Type

String

# firewall_port property ([GoogleDrive](#struct-cloudstoragegoogledrive) Struct)

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

## Syntax

*Rust Syntax*

```text
fn firewall_port(&self ) -> Result<i32, CloudStorageError> fn set_firewall_port(&self, value : i32) ->  Option<CloudStorageError>
```

## Default Value

0

## Remarks

The Transmission Control Protocol (TCP) port for the firewall [firewall_host](#firewall_host-property-googledrive-struct). See the description of the [firewall_host](#firewall_host-property-googledrive-struct) property for details.

NOTE: This property is set automatically when [firewall_firewall_type](#GoogleDrive_p_FirewallFirewallType) is set to a valid value. See the description of the [firewall_firewall_type](#GoogleDrive_p_FirewallFirewallType) property for details.

## Data Type

i32

# firewall_user property ([GoogleDrive](#struct-cloudstoragegoogledrive) Struct)

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

## Syntax

*Rust Syntax*

```text
fn firewall_user(&self ) -> Result<String, CloudStorageError> fn set_firewall_user(&self, value : &str) ->  Option<CloudStorageError>
fn set_firewall_user_ref(&self, value : &String) ->  Option<CloudStorageError>
```

## Default Value

""

## Remarks

A username if authentication is to be used when connecting through a firewall. If [firewall_host](#firewall_host-property-googledrive-struct) is specified, this property and the [firewall_password](#firewall_password-property-googledrive-struct) property are used to connect and authenticate to the given [Firewall](#Type_Firewall). If the authentication fails, the struct fails with an error.

## Data Type

String

# idle property ([GoogleDrive](#struct-cloudstoragegoogledrive) Struct)

The current status of the struct.

## Syntax

*Rust Syntax*

```text
fn idle(&self ) -> Result<bool, CloudStorageError>
```

## 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

bool

# list_resources_scope property ([GoogleDrive](#struct-cloudstoragegoogledrive) Struct)

Controls the scope of the results when listing resources.

## Syntax

*Rust Syntax*

```text
fn list_resources_scope(&self ) -> Result<i32, CloudStorageError> fn set_list_resources_scope(&self, value : i32) ->  Option<CloudStorageError>
```

## Possible Values

```text
0   // User1   // Domain2   // SharedDrive3   // AllDrives
```

## Default Value

0

## Remarks

This property controls the scope of the results when listing resources with [list_resources](#list_resources-method-googledrive-struct) or [list_children](#list_children-method-googledrive-struct). Valid values are:

|  |  |
| --- | --- |
| lrsUser (0) (default) | Items in the user's "My Drive" and "Shared with me" collections. |
| lrsDomain (1) | Items shared to the user's domain. |
| lrsSharedDrive (2) | Items within the shared drive specified by the [shared_drive](#shared_drive-property-googledrive-struct) property. |
| lrsAllDrives (3) | Items in the user's "My Drive" and "Shared with me" collections, as well as all items in all shared drives that the user is a member of. |

Refer to [list_resources](#list_resources-method-googledrive-struct) for more information.

## Data Type

i32

# local_file property ([GoogleDrive](#struct-cloudstoragegoogledrive) Struct)

The location of the local file.

## Syntax

*Rust Syntax*

```text
fn local_file(&self ) -> Result<String, CloudStorageError> fn set_local_file(&self, value : &str) ->  Option<CloudStorageError>
fn set_local_file_ref(&self, value : &String) ->  Option<CloudStorageError>
```

## Default Value

""

## Remarks

This property specifies the location of a file on disk. This is used as the source file when calling [upload_file](#upload_file-method-googledrive-struct) or [update_resource](#update_resource-method-googledrive-struct), and as the destination file when calling [download_file](#download_file-method-googledrive-struct).

## Data Type

String

# local_host property ([GoogleDrive](#struct-cloudstoragegoogledrive) Struct)

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

## Syntax

*Rust Syntax*

```text
fn local_host(&self ) -> Result<String, CloudStorageError> fn set_local_host(&self, value : &str) ->  Option<CloudStorageError>
fn set_local_host_ref(&self, value : &String) ->  Option<CloudStorageError>
```

## 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 struct initiate connections (or accept in the case of server structs) 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 struct is connected, the local_host 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: local_host is not persistent. You must always set it in code, and never in the property window.

## Data Type

String

# next_change_marker property ([GoogleDrive](#struct-cloudstoragegoogledrive) Struct)

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

## Syntax

*Rust Syntax*

```text
fn next_change_marker(&self ) -> Result<String, CloudStorageError> fn set_next_change_marker(&self, value : &str) ->  Option<CloudStorageError>
fn set_next_change_marker_ref(&self, value : &String) ->  Option<CloudStorageError>
```

## Default Value

""

## Remarks

This property will be populated when [list_changes](#list_changes-method-googledrive-struct) is called if there are no more changes to list.

This property will be populated with the most current change marker if [get_current_change_marker](#get_current_change_marker-method-googledrive-struct) is called.

Setting next_change_marker will cause [change_marker](#change_marker-property-googledrive-struct) to be set to empty string.

Refer to [list_changes](#list_changes-method-googledrive-struct) for more information.

## Data Type

String

# o_auth_access_token property ([GoogleDrive](#struct-cloudstoragegoogledrive) Struct)

The access token returned by the authorization server.

## Syntax

*Rust Syntax*

```text
fn o_auth_access_token(&self ) -> Result<String, CloudStorageError> fn set_o_auth_access_token(&self, value : &str) ->  Option<CloudStorageError>
fn set_o_auth_access_token_ref(&self, value : &String) ->  Option<CloudStorageError>
```

## Default Value

""

## Remarks

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

## Data Type

String

# o_auth_authorization_code property ([GoogleDrive](#struct-cloudstoragegoogledrive) Struct)

The authorization code that is exchanged for an access token.

## Syntax

*Rust Syntax*

```text
fn o_auth_authorization_code(&self ) -> Result<String, CloudStorageError> fn set_o_auth_authorization_code(&self, value : &str) ->  Option<CloudStorageError>
fn set_o_auth_authorization_code_ref(&self, value : &String) ->  Option<CloudStorageError>
```

## Default Value

""

## Remarks

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

## Data Type

String

# o_auth_authorization_scope property ([GoogleDrive](#struct-cloudstoragegoogledrive) Struct)

The scope request or response parameter used during authorization.

## Syntax

*Rust Syntax*

```text
fn o_auth_authorization_scope(&self ) -> Result<String, CloudStorageError> fn set_o_auth_authorization_scope(&self, value : &str) ->  Option<CloudStorageError>
fn set_o_auth_authorization_scope_ref(&self, value : &String) ->  Option<CloudStorageError>
```

## Default Value

""

## Remarks

The scope request or response parameter used during authorization.

## Data Type

String

# o_auth_client_id property ([GoogleDrive](#struct-cloudstoragegoogledrive) Struct)

The id of the client assigned when registering the application.

## Syntax

*Rust Syntax*

```text
fn o_auth_client_id(&self ) -> Result<String, CloudStorageError> fn set_o_auth_client_id(&self, value : &str) ->  Option<CloudStorageError>
fn set_o_auth_client_id_ref(&self, value : &String) ->  Option<CloudStorageError>
```

## Default Value

""

## Remarks

The id of the client assigned when registering the application.

## Data Type

String

# o_auth_client_profile property ([GoogleDrive](#struct-cloudstoragegoogledrive) Struct)

The type of client that is requesting authorization.

## Syntax

*Rust Syntax*

```text
fn o_auth_client_profile(&self ) -> Result<i32, CloudStorageError> fn set_o_auth_client_profile(&self, value : i32) ->  Option<CloudStorageError>
```

## Possible Values

```text
0   // Application1   // Web
```

## Default Value

0

## Remarks

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

|  |  |
| --- | --- |
| 0 (cocpApplication - Default) | The application profile is applicable to applications that are run by the user directly. For instance a windows form application would use the application profile. To authorize your application (client) using the application profile see the introduction section. |
| 1 (cocpWeb) | The Web profile is applicable to applications that are run on the server side where the user uses the application from a web browser. To authorize your application (client) using this profile follow see the introduction section. |

## Data Type

i32

# o_auth_client_secret property ([GoogleDrive](#struct-cloudstoragegoogledrive) Struct)

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

## Syntax

*Rust Syntax*

```text
fn o_auth_client_secret(&self ) -> Result<String, CloudStorageError> fn set_o_auth_client_secret(&self, value : &str) ->  Option<CloudStorageError>
fn set_o_auth_client_secret_ref(&self, value : &String) ->  Option<CloudStorageError>
```

## Default Value

""

## Remarks

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

## Data Type

String

# o_auth_grant_type property ([GoogleDrive](#struct-cloudstoragegoogledrive) Struct)

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

## Syntax

*Rust Syntax*

```text
fn o_auth_grant_type(&self ) -> Result<i32, CloudStorageError> fn set_o_auth_grant_type(&self, value : i32) ->  Option<CloudStorageError>
```

## Possible Values

```text
0   // AuthorizationCode1   // Implicit2   // Password3   // ClientCredentials
```

## 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:

|  |  |
| --- | --- |
| 0 (cogtAuthorizationCode - Default) | Authorization Code grant type |
| 1 (cogtImplicit) | Implicit grant type |
| 2 (cogtPassword) | Resource Owner Password Credentials grant type |
| 3 (cogtClientCredentials) | Client Credentials grant type |

## Data Type

i32

# o_auth_refresh_token property ([GoogleDrive](#struct-cloudstoragegoogledrive) Struct)

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

## Syntax

*Rust Syntax*

```text
fn o_auth_refresh_token(&self ) -> Result<String, CloudStorageError> fn set_o_auth_refresh_token(&self, value : &str) ->  Option<CloudStorageError>
fn set_o_auth_refresh_token_ref(&self, value : &String) ->  Option<CloudStorageError>
```

## 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 o_auth_grant_type property is set to a grant that can use refresh tokens.

## Data Type

String

# o_auth_request_refresh_token property ([GoogleDrive](#struct-cloudstoragegoogledrive) Struct)

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

## Syntax

*Rust Syntax*

```text
fn o_auth_request_refresh_token(&self ) -> Result<bool, CloudStorageError> fn set_o_auth_request_refresh_token(&self, value : bool) ->  Option<CloudStorageError>
```

## Default Value

true

## Remarks

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

When *True*, the struct 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 o_auth_grant_type property is set to *cogtAuthorizationCode*.

## Data Type

bool

# o_auth_return_url property ([GoogleDrive](#struct-cloudstoragegoogledrive) Struct)

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

## Syntax

*Rust Syntax*

```text
fn o_auth_return_url(&self ) -> Result<String, CloudStorageError> fn set_o_auth_return_url(&self, value : &str) ->  Option<CloudStorageError>
fn set_o_auth_return_url_ref(&self, value : &String) ->  Option<CloudStorageError>
```

## 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 struct 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.

## Data Type

String

# o_auth_server_auth_url property ([GoogleDrive](#struct-cloudstoragegoogledrive) Struct)

The URL of the authorization server.

## Syntax

*Rust Syntax*

```text
fn o_auth_server_auth_url(&self ) -> Result<String, CloudStorageError> fn set_o_auth_server_auth_url(&self, value : &str) ->  Option<CloudStorageError>
fn set_o_auth_server_auth_url_ref(&self, value : &String) ->  Option<CloudStorageError>
```

## Default Value

""

## Remarks

The URL of the authorization server.

## Data Type

String

# o_auth_server_token_url property ([GoogleDrive](#struct-cloudstoragegoogledrive) Struct)

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

## Syntax

*Rust Syntax*

```text
fn o_auth_server_token_url(&self ) -> Result<String, CloudStorageError> fn set_o_auth_server_token_url(&self, value : &str) ->  Option<CloudStorageError>
fn set_o_auth_server_token_url_ref(&self, value : &String) ->  Option<CloudStorageError>
```

## Default Value

""

## Remarks

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

## Data Type

String

# o_auth_timeout property ([GoogleDrive](#struct-cloudstoragegoogledrive) Struct)

The amount of time (in seconds) the struct will wait for a response from the browser in the LaunchBrowser event.

## Syntax

*Rust Syntax*

```text
fn o_auth_timeout(&self ) -> Result<i32, CloudStorageError> fn set_o_auth_timeout(&self, value : i32) ->  Option<CloudStorageError>
```

## Default Value

60

## Remarks

The amount of time (in seconds) the component will wait for a response from the browser in the on_launch_browser event. The default value is 60.

## Data Type

i32

# o_auth_web_auth_url property ([GoogleDrive](#struct-cloudstoragegoogledrive) Struct)

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

## Syntax

*Rust Syntax*

```text
fn o_auth_web_auth_url(&self ) -> Result<String, CloudStorageError>
```

## 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.

## Data Type

String

# other_headers property ([GoogleDrive](#struct-cloudstoragegoogledrive) Struct)

Other headers as determined by the user (optional).

## Syntax

*Rust Syntax*

```text
fn other_headers(&self ) -> Result<String, CloudStorageError> fn set_other_headers(&self, value : &str) ->  Option<CloudStorageError>
fn set_other_headers_ref(&self, value : &String) ->  Option<CloudStorageError>
```

## 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 content_type and from.

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

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

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

## Data Type

String

# overwrite property ([GoogleDrive](#struct-cloudstoragegoogledrive) Struct)

Determines if local files are overwritten.

## Syntax

*Rust Syntax*

```text
fn overwrite(&self ) -> Result<bool, CloudStorageError> fn set_overwrite(&self, value : bool) ->  Option<CloudStorageError>
```

## Default Value

false

## Remarks

This property controls whether local files are overwritten when calling [download_file](#download_file-method-googledrive-struct). It is only applicable to local files. The default value is *false*.

## Data Type

bool

# parsed_header_count property ([GoogleDrive](#struct-cloudstoragegoogledrive) Struct)

The number of records in the ParsedHeader arrays.

## Syntax

*Rust Syntax*

```text
fn parsed_header_count(&self ) -> Result<i32, CloudStorageError>
```

## Default Value

0

## Remarks

This property controls the size of the following arrays:

- [parsed_header_field](#parsed_header_field-property-googledrive-struct)
- [parsed_header_value](#parsed_header_value-property-googledrive-struct)

The array indices start at *0* and end at *parsed_header_count - 1*.

This property is read-only.

## Data Type

i32

# parsed_header_field property ([GoogleDrive](#struct-cloudstoragegoogledrive) Struct)

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

## Syntax

*Rust Syntax*

```text
fn parsed_header_field(&self , ParsedHeaderIndex : i32) -> Result<String, CloudStorageError>
```

## Default Value

""

## Remarks

This property contains the name of the HTTP [Header](#Type_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](#parsed_header_count-property-googledrive-struct) property.

This property is read-only.

## Data Type

String

# parsed_header_value property ([GoogleDrive](#struct-cloudstoragegoogledrive) Struct)

This property contains the header contents.

## Syntax

*Rust Syntax*

```text
fn parsed_header_value(&self , ParsedHeaderIndex : i32) -> Result<String, CloudStorageError>
```

## Default Value

""

## Remarks

This property contains the [Header](#Type_Header) contents.

The *ParsedHeaderIndex* parameter specifies the index of the item in the array. The size of the array is controlled by the [ParsedHeaderCount](#parsed_header_count-property-googledrive-struct) property.

This property is read-only.

## Data Type

String

# permission_marker property ([GoogleDrive](#struct-cloudstoragegoogledrive) Struct)

A marker when permissions are paged.

## Syntax

*Rust Syntax*

```text
fn permission_marker(&self ) -> Result<String, CloudStorageError> fn set_permission_marker(&self, value : &str) ->  Option<CloudStorageError>
fn set_permission_marker_ref(&self, value : &String) ->  Option<CloudStorageError>
```

## Default Value

""

## Remarks

This property returns a marker used to iterate over pages of permissions; it's populated when [list_permissions](#list_permissions-method-googledrive-struct) is called if the results are paged.

Continue to call [list_permissions](#list_permissions-method-googledrive-struct) until this property returns empty string in order to list all permissions.

## Data Type

String

# permission_count property ([GoogleDrive](#struct-cloudstoragegoogledrive) Struct)

The number of records in the Permission arrays.

## Syntax

*Rust Syntax*

```text
fn permission_count(&self ) -> Result<i32, CloudStorageError> fn set_permission_count(&self, value : i32) ->  Option<CloudStorageError>
```

## Default Value

0

## Remarks

This property controls the size of the following arrays:

- [permission_allow_file_discovery](#permission_allow_file_discovery-property-googledrive-struct)
- [permission_domain](#permission_domain-property-googledrive-struct)
- [permission_email](#permission_email-property-googledrive-struct)
- [permission_grantee_type](#permission_grantee_type-property-googledrive-struct)
- [permission_id](#permission_id-property-googledrive-struct)
- [permission_mod_op](#permission_mod_op-property-googledrive-struct)
- [permission_role](#permission_role-property-googledrive-struct)

The array indices start at *0* and end at *permission_count - 1*.

## Data Type

i32

# permission_allow_file_discovery property ([GoogleDrive](#struct-cloudstoragegoogledrive) Struct)

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

## Syntax

*Rust Syntax*

```text
fn permission_allow_file_discovery(&self , PermissionIndex : i32) -> Result<bool, CloudStorageError> fn set_permission_allow_file_discovery(&self, PermissionIndex : i32, value : bool) ->  Option<CloudStorageError>
```

## 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 [permission_grantee_type](#permission_grantee_type-property-googledrive-struct) 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](#permission_count-property-googledrive-struct) property.

## Data Type

bool

# permission_domain property ([GoogleDrive](#struct-cloudstoragegoogledrive) Struct)

The domain to which the permission applies.

## Syntax

*Rust Syntax*

```text
fn permission_domain(&self , PermissionIndex : i32) -> Result<String, CloudStorageError> fn set_permission_domain(&self, PermissionIndex : i32, value : &str) ->  Option<CloudStorageError>
fn set_permission_domain_ref(&self, PermissionIndex : i32, value : &String) ->  Option<CloudStorageError>
```

## Default Value

""

## Remarks

The domain to which the permission applies.

This property is used to define the domain to which the permission applies when [permission_grantee_type](#permission_grantee_type-property-googledrive-struct) 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](#permission_count-property-googledrive-struct) property.

## Data Type

String

# permission_email property ([GoogleDrive](#struct-cloudstoragegoogledrive) Struct)

The user or group to which the permission applies.

## Syntax

*Rust Syntax*

```text
fn permission_email(&self , PermissionIndex : i32) -> Result<String, CloudStorageError> fn set_permission_email(&self, PermissionIndex : i32, value : &str) ->  Option<CloudStorageError>
fn set_permission_email_ref(&self, PermissionIndex : i32, value : &String) ->  Option<CloudStorageError>
```

## 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 [permission_grantee_type](#permission_grantee_type-property-googledrive-struct) 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](#permission_count-property-googledrive-struct) property.

## Data Type

String

# permission_grantee_type property ([GoogleDrive](#struct-cloudstoragegoogledrive) Struct)

The set of users to which the permission applies.

## Syntax

*Rust Syntax*

```text
fn permission_grantee_type(&self , PermissionIndex : i32) -> Result<i32, CloudStorageError> fn set_permission_grantee_type(&self, PermissionIndex : i32, value : i32) ->  Option<CloudStorageError>
```

## Possible Values

```text
0   // User1   // Group2   // Domain3   // Anyone
```

## 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 [permission_role](#permission_role-property-googledrive-struct) applies.

The [permission_email](#permission_email-property-googledrive-struct) and [permission_domain](#permission_domain-property-googledrive-struct) 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:

| Value | Description | Related property |
| --- | --- | --- |
| 0 (ptUser - default) | A single user. | [permission_email](#permission_email-property-googledrive-struct) |
| 1 (ptGroup) | A group. | [permission_email](#permission_email-property-googledrive-struct) |
| 2 (ptDomain) | A domain. | [permission_domain](#permission_domain-property-googledrive-struct) |
| 3 (ptAnyone) | Anyone, authenticated or not. | N/A |

The *PermissionIndex* parameter specifies the index of the item in the array. The size of the array is controlled by the [PermissionCount](#permission_count-property-googledrive-struct) property.

## Data Type

i32

# permission_id property ([GoogleDrive](#struct-cloudstoragegoogledrive) Struct)

The Id of the permission.

## Syntax

*Rust Syntax*

```text
fn permission_id(&self , PermissionIndex : i32) -> Result<String, CloudStorageError> fn set_permission_id(&self, PermissionIndex : i32, value : &str) ->  Option<CloudStorageError>
fn set_permission_id_ref(&self, PermissionIndex : i32, value : &String) ->  Option<CloudStorageError>
```

## 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](#permission_count-property-googledrive-struct) property.

## Data Type

String

# permission_mod_op property ([GoogleDrive](#struct-cloudstoragegoogledrive) Struct)

The operation to perform on the permission.

## Syntax

*Rust Syntax*

```text
fn permission_mod_op(&self , PermissionIndex : i32) -> Result<i32, CloudStorageError> fn set_permission_mod_op(&self, PermissionIndex : i32, value : i32) ->  Option<CloudStorageError>
```

## Possible Values

```text
0   // None1   // Create2   // Update3   // Delete
```

## Default Value

0

## Remarks

The operation to perform on the permission.

This property is used to specify the operation that the struct should perform on the permission when [update_permissions](#update_permissions-method-googledrive-struct) is called. Valid values are:

|  |  |
| --- | --- |
| moNone (0) (default) | No-Op (the struct skips the permission). |
| moCreate (1) | The permission will be created. |
| moUpdate (2) | The permission will be updated. |
| moDelete (3) | The permission will be deleted. |

Refer to [update_permissions](#update_permissions-method-googledrive-struct) 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](#permission_count-property-googledrive-struct) property.

## Data Type

i32

# permission_role property ([GoogleDrive](#struct-cloudstoragegoogledrive) Struct)

The role specified by the permission.

## Syntax

*Rust Syntax*

```text
fn permission_role(&self , PermissionIndex : i32) -> Result<i32, CloudStorageError> fn set_permission_role(&self, PermissionIndex : i32, value : i32) ->  Option<CloudStorageError>
```

## Possible Values

```text
0   // Reader1   // Commenter2   // Writer3   // Owner4   // FileOrganizer5   // Organizer
```

## Default Value

0

## Remarks

The role specified by the permission.

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

|  |  |
| --- | --- |
| prReader (0) (default) | Read-only permissions. |
| prCommenter (1) | Read-only plus commenting permissions. |
| prWriter (2) | Read, write, and comment permissions. |
| prOwner (3) | Full ownership (personal drives only). |
| prFileOrganizer (4) | Writer permissions, plus the ability to move and trash resources (shared drives only). |
| prOrganizer (5) | File organizer permissions, plus the ability to permanently delete resources from, and rename/delete/alter the membership of, a shared drive (shared drives only). |

The *PermissionIndex* parameter specifies the index of the item in the array. The size of the array is controlled by the [PermissionCount](#permission_count-property-googledrive-struct) property.

## Data Type

i32

# proxy_auth_scheme property ([GoogleDrive](#struct-cloudstoragegoogledrive) Struct)

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

## Syntax

*Rust Syntax*

```text
fn proxy_auth_scheme(&self ) -> Result<i32, CloudStorageError> fn set_proxy_auth_scheme(&self, value : i32) ->  Option<CloudStorageError>
```

## Possible Values

```text
0   // Basic1   // Digest2   // Proprietary3   // None4   // Ntlm5   // Negotiate
```

## Default Value

0

## Remarks

The type of authorization to perform when connecting to the proxy. This is used only when the [proxy_user](#proxy_user-property-googledrive-struct) and [proxy_password](#proxy_password-property-googledrive-struct) properties are set.

[proxy_auth_scheme](#proxy_auth_scheme-property-googledrive-struct) should be set to authNone (3) when no authentication is expected.

By default, [proxy_auth_scheme](#proxy_auth_scheme-property-googledrive-struct) is authBasic (0), and if the [proxy_user](#proxy_user-property-googledrive-struct) and [proxy_password](#proxy_password-property-googledrive-struct) properties are set, the struct will attempt basic authentication.

If [proxy_auth_scheme](#proxy_auth_scheme-property-googledrive-struct) is set to authDigest (1), digest authentication will be attempted instead.

If [proxy_auth_scheme](#proxy_auth_scheme-property-googledrive-struct) is set to authProprietary (2), then the authorization token will not be generated by the struct. Look at the configuration file for the struct being used to find more information about manually setting this token.

If [proxy_auth_scheme](#proxy_auth_scheme-property-googledrive-struct) is set to authNtlm (4), NTLM authentication will be used.

For security reasons, setting this property will clear the values of [proxy_user](#proxy_user-property-googledrive-struct) and [proxy_password](#proxy_password-property-googledrive-struct).

## Data Type

i32

# proxy_auto_detect property ([GoogleDrive](#struct-cloudstoragegoogledrive) Struct)

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

## Syntax

*Rust Syntax*

```text
fn proxy_auto_detect(&self ) -> Result<bool, CloudStorageError> fn set_proxy_auto_detect(&self, value : bool) ->  Option<CloudStorageError>
```

## Default Value

false

## Remarks

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

## Data Type

bool

# proxy_password property ([GoogleDrive](#struct-cloudstoragegoogledrive) Struct)

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

## Syntax

*Rust Syntax*

```text
fn proxy_password(&self ) -> Result<String, CloudStorageError> fn set_proxy_password(&self, value : &str) ->  Option<CloudStorageError>
fn set_proxy_password_ref(&self, value : &String) ->  Option<CloudStorageError>
```

## Default Value

""

## Remarks

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

If [proxy_auth_scheme](#proxy_auth_scheme-property-googledrive-struct) is set to Basic Authentication, the [proxy_user](#proxy_user-property-googledrive-struct) and [proxy_password](#proxy_password-property-googledrive-struct) properties are Base64 encoded and the proxy authentication token will be generated in the form *Basic [encoded-user-password]*.

If [proxy_auth_scheme](#proxy_auth_scheme-property-googledrive-struct) is set to Digest Authentication, the [proxy_user](#proxy_user-property-googledrive-struct) and [proxy_password](#proxy_password-property-googledrive-struct) properties are used to respond to the Digest Authentication challenge from the server.

If [proxy_auth_scheme](#proxy_auth_scheme-property-googledrive-struct) is set to NTLM Authentication, the [proxy_user](#proxy_user-property-googledrive-struct) and [proxy_password](#proxy_password-property-googledrive-struct) properties are used to authenticate through NTLM negotiation.

## Data Type

String

# proxy_port property ([GoogleDrive](#struct-cloudstoragegoogledrive) Struct)

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

## Syntax

*Rust Syntax*

```text
fn proxy_port(&self ) -> Result<i32, CloudStorageError> fn set_proxy_port(&self, value : i32) ->  Option<CloudStorageError>
```

## Default Value

80

## Remarks

The Transmission Control Protocol (TCP) port for the proxy [proxy_server](#proxy_server-property-googledrive-struct) (default 80). See the description of the [proxy_server](#proxy_server-property-googledrive-struct) property for details.

## Data Type

i32

# proxy_server property ([GoogleDrive](#struct-cloudstoragegoogledrive) Struct)

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

## Syntax

*Rust Syntax*

```text
fn proxy_server(&self ) -> Result<String, CloudStorageError> fn set_proxy_server(&self, value : &str) ->  Option<CloudStorageError>
fn set_proxy_server_ref(&self, value : &String) ->  Option<CloudStorageError>
```

## Default Value

""

## Remarks

If a proxy [proxy_server](#proxy_server-property-googledrive-struct) is given, then the HTTP request is sent to the proxy instead of the server otherwise specified.

If the [proxy_server](#proxy_server-property-googledrive-struct) property is set to a domain name, a DNS request is initiated. Upon successful termination of the request, the [proxy_server](#proxy_server-property-googledrive-struct) property is set to the corresponding address. If the search is not successful, an error is returned.

## Data Type

String

# proxy_ssl property ([GoogleDrive](#struct-cloudstoragegoogledrive) Struct)

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

## Syntax

*Rust Syntax*

```text
fn proxy_ssl(&self ) -> Result<i32, CloudStorageError> fn set_proxy_ssl(&self, value : i32) ->  Option<CloudStorageError>
```

## Possible Values

```text
0   // Automatic1   // Always2   // Never3   // Tunnel
```

## Default Value

0

## Remarks

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

|  |  |
| --- | --- |
| psAutomatic (0) | Default setting. If the URL is an https URL, the struct will use the psTunnel option. If the URL is an http URL, the struct will use the psNever option. |
| psAlways (1) | The connection is always SSL-enabled. |
| psNever (2) | The connection is not SSL-enabled. |
| psTunnel (3) | The connection is made through a tunneling (HTTP) proxy. |

## Data Type

i32

# proxy_user property ([GoogleDrive](#struct-cloudstoragegoogledrive) Struct)

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

## Syntax

*Rust Syntax*

```text
fn proxy_user(&self ) -> Result<String, CloudStorageError> fn set_proxy_user(&self, value : &str) ->  Option<CloudStorageError>
fn set_proxy_user_ref(&self, value : &String) ->  Option<CloudStorageError>
```

## Default Value

""

## Remarks

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

If [proxy_auth_scheme](#proxy_auth_scheme-property-googledrive-struct) is set to Basic Authentication, the [proxy_user](#proxy_user-property-googledrive-struct) and [proxy_password](#proxy_password-property-googledrive-struct) properties are Base64 encoded and the proxy authentication token will be generated in the form *Basic [encoded-user-password]*.

If [proxy_auth_scheme](#proxy_auth_scheme-property-googledrive-struct) is set to Digest Authentication, the [proxy_user](#proxy_user-property-googledrive-struct) and [proxy_password](#proxy_password-property-googledrive-struct) properties are used to respond to the Digest Authentication challenge from the server.

If [proxy_auth_scheme](#proxy_auth_scheme-property-googledrive-struct) is set to NTLM Authentication, the [proxy_user](#proxy_user-property-googledrive-struct) and [proxy_password](#proxy_password-property-googledrive-struct) properties are used to authenticate through NTLM negotiation.

## Data Type

String

# query_param_count property ([GoogleDrive](#struct-cloudstoragegoogledrive) Struct)

The number of records in the QueryParam arrays.

## Syntax

*Rust Syntax*

```text
fn query_param_count(&self ) -> Result<i32, CloudStorageError> fn set_query_param_count(&self, value : i32) ->  Option<CloudStorageError>
```

## Default Value

0

## Remarks

This property controls the size of the following arrays:

- [query_param_name](#query_param_name-property-googledrive-struct)
- [query_param_value](#query_param_value-property-googledrive-struct)

The array indices start at *0* and end at *query_param_count - 1*.

## Data Type

i32

# query_param_name property ([GoogleDrive](#struct-cloudstoragegoogledrive) Struct)

The name of the query parameter.

## Syntax

*Rust Syntax*

```text
fn query_param_name(&self , QueryParamIndex : i32) -> Result<String, CloudStorageError> fn set_query_param_name(&self, QueryParamIndex : i32, value : &str) ->  Option<CloudStorageError>
fn set_query_param_name_ref(&self, QueryParamIndex : i32, value : &String) ->  Option<CloudStorageError>
```

## 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](#query_param_count-property-googledrive-struct) property.

## Data Type

String

# query_param_value property ([GoogleDrive](#struct-cloudstoragegoogledrive) Struct)

The value of the query parameter.

## Syntax

*Rust Syntax*

```text
fn query_param_value(&self , QueryParamIndex : i32) -> Result<String, CloudStorageError> fn set_query_param_value(&self, QueryParamIndex : i32, value : &str) ->  Option<CloudStorageError>
fn set_query_param_value_ref(&self, QueryParamIndex : i32, value : &String) ->  Option<CloudStorageError>
```

## Default Value

""

## Remarks

The value of the query parameter.

This property specifies the value of the query parameter. The struct 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](#query_param_count-property-googledrive-struct) property.

## Data Type

String

# resource_data property ([GoogleDrive](#struct-cloudstoragegoogledrive) Struct)

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

## Syntax

*Rust Syntax*

```text
fn resource_data(&self ) -> Result<Vec<u8>, CloudStorageError> fn set_resource_data(&self, value : Vec<u8>) ->  Option<CloudStorageError>
fn set_resource_data_ref(&self, value : &[u8]) ->  Option<CloudStorageError>
```

## Default Value

""

## Remarks

This property is populated with file data after calling [download_file](#download_file-method-googledrive-struct) if [local_file](#local_file-property-googledrive-struct) is not set.

This property can also be set before calling [upload_file](#upload_file-method-googledrive-struct); its data will be uploaded if [local_file](#local_file-property-googledrive-struct) is not set.

## Data Type

Vec

# resource_marker property ([GoogleDrive](#struct-cloudstoragegoogledrive) Struct)

A marker indicating what page of resources to return next.

## Syntax

*Rust Syntax*

```text
fn resource_marker(&self ) -> Result<String, CloudStorageError> fn set_resource_marker(&self, value : &str) ->  Option<CloudStorageError>
fn set_resource_marker_ref(&self, value : &String) ->  Option<CloudStorageError>
```

## Default Value

""

## Remarks

This property will be populated when [list_resources](#list_resources-method-googledrive-struct) is called if the results are paged and there are more pages. To list all resources, continue to call [list_resources](#list_resources-method-googledrive-struct) until this property returns empty string.

Refer to [list_resources](#list_resources-method-googledrive-struct) for more information.

Note that resources are never paged when calling [list_parents](#list_parents-method-googledrive-struct) or [get_resource_info](#get_resource_info-method-googledrive-struct).

## Data Type

String

# resource_count property ([GoogleDrive](#struct-cloudstoragegoogledrive) Struct)

The number of records in the Resource arrays.

## Syntax

*Rust Syntax*

```text
fn resource_count(&self ) -> Result<i32, CloudStorageError> fn set_resource_count(&self, value : i32) ->  Option<CloudStorageError>
```

## Default Value

0

## Remarks

This property controls the size of the following arrays:

- [resource_content_accessible](#resource_content_accessible-property-googledrive-struct)
- [resource_created_time](#resource_created_time-property-googledrive-struct)
- [resource_description](#resource_description-property-googledrive-struct)
- [resource_extension](#resource_extension-property-googledrive-struct)
- [resource_id](#resource_id-property-googledrive-struct)
- [resource_md5_checksum](#resource_md5_checksum-property-googledrive-struct)
- [resource_mime_type](#resource_mime_type-property-googledrive-struct)
- [resource_modified_time](#resource_modified_time-property-googledrive-struct)
- [resource_name](#resource_name-property-googledrive-struct)
- [resource_original_name](#resource_original_name-property-googledrive-struct)
- [resource_owner](#resource_owner-property-googledrive-struct)
- [resource_owner_email](#resource_owner_email-property-googledrive-struct)
- [resource_parent_ids](#resource_parent_ids-property-googledrive-struct)
- [resource_shared_drive_id](#resource_shared_drive_id-property-googledrive-struct)
- [resource_size](#resource_size-property-googledrive-struct)
- [resource_starred](#resource_starred-property-googledrive-struct)
- [resource_trashed](#resource_trashed-property-googledrive-struct)
- [resource_type](#resource_type-property-googledrive-struct)
- [resource_viewed](#resource_viewed-property-googledrive-struct)
- [resource_view_link](#resource_view_link-property-googledrive-struct)

The array indices start at *0* and end at *resource_count - 1*.

## Data Type

i32

# resource_content_accessible property ([GoogleDrive](#struct-cloudstoragegoogledrive) Struct)

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

## Syntax

*Rust Syntax*

```text
fn resource_content_accessible(&self , ResourceIndex : i32) -> Result<bool, CloudStorageError> fn set_resource_content_accessible(&self, ResourceIndex : i32, value : bool) ->  Option<CloudStorageError>
```

## 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](#resource_count-property-googledrive-struct) property.

## Data Type

bool

# resource_created_time property ([GoogleDrive](#struct-cloudstoragegoogledrive) Struct)

The creation date of the resource.

## Syntax

*Rust Syntax*

```text
fn resource_created_time(&self , ResourceIndex : i32) -> Result<String, CloudStorageError> fn set_resource_created_time(&self, ResourceIndex : i32, value : &str) ->  Option<CloudStorageError>
fn set_resource_created_time_ref(&self, ResourceIndex : i32, value : &String) ->  Option<CloudStorageError>
```

## 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 struct only uses it as input when [upload_file](#upload_file-method-googledrive-struct) is called; it is ignored when calling [update_resource](#update_resource-method-googledrive-struct).

The *ResourceIndex* parameter specifies the index of the item in the array. The size of the array is controlled by the [ResourceCount](#resource_count-property-googledrive-struct) property.

## Data Type

String

# resource_description property ([GoogleDrive](#struct-cloudstoragegoogledrive) Struct)

A short description of the resource.

## Syntax

*Rust Syntax*

```text
fn resource_description(&self , ResourceIndex : i32) -> Result<String, CloudStorageError> fn set_resource_description(&self, ResourceIndex : i32, value : &str) ->  Option<CloudStorageError>
fn set_resource_description_ref(&self, ResourceIndex : i32, value : &String) ->  Option<CloudStorageError>
```

## 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](#resource_count-property-googledrive-struct) property.

## Data Type

String

# resource_extension property ([GoogleDrive](#struct-cloudstoragegoogledrive) Struct)

The file extension of the resource.

## Syntax

*Rust Syntax*

```text
fn resource_extension(&self , ResourceIndex : i32) -> Result<String, CloudStorageError>
```

## 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 [upload_file](#upload_file-method-googledrive-struct).

The *ResourceIndex* parameter specifies the index of the item in the array. The size of the array is controlled by the [ResourceCount](#resource_count-property-googledrive-struct) property.

This property is read-only.

## Data Type

String

# resource_id property ([GoogleDrive](#struct-cloudstoragegoogledrive) Struct)

The Id of the resource.

## Syntax

*Rust Syntax*

```text
fn resource_id(&self , ResourceIndex : i32) -> Result<String, CloudStorageError> fn set_resource_id(&self, ResourceIndex : i32, value : &str) ->  Option<CloudStorageError>
fn set_resource_id_ref(&self, ResourceIndex : i32, value : &String) ->  Option<CloudStorageError>
```

## Default Value

""

## Remarks

The Id of the resource.

This property holds the Id of the resource.

This property must be set before calling [update_resource](#update_resource-method-googledrive-struct).

The *ResourceIndex* parameter specifies the index of the item in the array. The size of the array is controlled by the [ResourceCount](#resource_count-property-googledrive-struct) property.

## Data Type

String

# resource_md5_checksum property ([GoogleDrive](#struct-cloudstoragegoogledrive) Struct)

The MD5 checksum of the file resource.

## Syntax

*Rust Syntax*

```text
fn resource_md5_checksum(&self , ResourceIndex : i32) -> Result<String, CloudStorageError>
```

## 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](#resource_count-property-googledrive-struct) property.

This property is read-only.

## Data Type

String

# resource_mime_type property ([GoogleDrive](#struct-cloudstoragegoogledrive) Struct)

The MIME type of the resource.

## Syntax

*Rust Syntax*

```text
fn resource_mime_type(&self , ResourceIndex : i32) -> Result<String, CloudStorageError> fn set_resource_mime_type(&self, ResourceIndex : i32, value : &str) ->  Option<CloudStorageError>
fn set_resource_mime_type_ref(&self, ResourceIndex : i32, value : &String) ->  Option<CloudStorageError>
```

## Default Value

""

## Remarks

The MIME type of the resource.

This property specifies the MIME type of the resource.

When calling [upload_file](#upload_file-method-googledrive-struct), this property is ignored in favor of the *MimeType* parameter of [upload_file](#upload_file-method-googledrive-struct).

When calling [update_resource](#update_resource-method-googledrive-struct), this property is only submitted if new file data is being uploaded.

Some Google Drive MIME types:

|  |  |
| --- | --- |
| application/vnd.google-apps.audio |  |
| application/vnd.google-apps.document | Google Docs |
| application/vnd.google-apps.drawing | Google Drawing |
| application/vnd.google-apps.file | Google Drive file |
| application/vnd.google-apps.folder | Google Drive folder |
| application/vnd.google-apps.form | Google Forms |
| application/vnd.google-apps.fusiontable | Google Fusion Tables |
| application/vnd.google-apps.kix | Google Docs |
| application/vnd.google-apps.photo |  |
| application/vnd.google-apps.presentation | Google Slides |
| application/vnd.google-apps.script | Google Apps Scripts |
| application/vnd.google-apps.sites | Google Sites |
| application/vnd.google-apps.spreadsheet | Google Sheets |
| application/vnd.google-apps.unknown |  |
| application/vnd.google-apps.video |  |

The *ResourceIndex* parameter specifies the index of the item in the array. The size of the array is controlled by the [ResourceCount](#resource_count-property-googledrive-struct) property.

## Data Type

String

# resource_modified_time property ([GoogleDrive](#struct-cloudstoragegoogledrive) Struct)

The last modified date of the resource.

## Syntax

*Rust Syntax*

```text
fn resource_modified_time(&self , ResourceIndex : i32) -> Result<String, CloudStorageError> fn set_resource_modified_time(&self, ResourceIndex : i32, value : &str) ->  Option<CloudStorageError>
fn set_resource_modified_time_ref(&self, ResourceIndex : i32, value : &String) ->  Option<CloudStorageError>
```

## 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](#resource_count-property-googledrive-struct) property.

## Data Type

String

# resource_name property ([GoogleDrive](#struct-cloudstoragegoogledrive) Struct)

The name of the resource.

## Syntax

*Rust Syntax*

```text
fn resource_name(&self , ResourceIndex : i32) -> Result<String, CloudStorageError> fn set_resource_name(&self, ResourceIndex : i32, value : &str) ->  Option<CloudStorageError>
fn set_resource_name_ref(&self, ResourceIndex : i32, value : &String) ->  Option<CloudStorageError>
```

## 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](#resource_count-property-googledrive-struct) property.

## Data Type

String

# resource_original_name property ([GoogleDrive](#struct-cloudstoragegoogledrive) Struct)

The original name of the file resource.

## Syntax

*Rust Syntax*

```text
fn resource_original_name(&self , ResourceIndex : i32) -> Result<String, CloudStorageError>
```

## 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 [resource_name](#resource_name-property-googledrive-struct) 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](#resource_count-property-googledrive-struct) property.

This property is read-only.

## Data Type

String

# resource_owner property ([GoogleDrive](#struct-cloudstoragegoogledrive) Struct)

The name of the resource's owner.

## Syntax

*Rust Syntax*

```text
fn resource_owner(&self , ResourceIndex : i32) -> Result<String, CloudStorageError>
```

## 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](#resource_count-property-googledrive-struct) property.

This property is read-only.

## Data Type

String

# resource_owner_email property ([GoogleDrive](#struct-cloudstoragegoogledrive) Struct)

The email address of the resource's owner.

## Syntax

*Rust Syntax*

```text
fn resource_owner_email(&self , ResourceIndex : i32) -> Result<String, CloudStorageError>
```

## 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](#resource_count-property-googledrive-struct) property.

This property is read-only.

## Data Type

String

# resource_parent_ids property ([GoogleDrive](#struct-cloudstoragegoogledrive) Struct)

The Ids of the resource's parent folders.

## Syntax

*Rust Syntax*

```text
fn resource_parent_ids(&self , ResourceIndex : i32) -> Result<String, CloudStorageError> fn set_resource_parent_ids(&self, ResourceIndex : i32, value : &str) ->  Option<CloudStorageError>
fn set_resource_parent_ids_ref(&self, ResourceIndex : i32, value : &String) ->  Option<CloudStorageError>
```

## 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 struct only uses it as input when [upload_file](#upload_file-method-googledrive-struct) is called. To modify a resource's parents in any other case, use the [add_parents](#add_parents-method-googledrive-struct), [remove_parents](#remove_parents-method-googledrive-struct), and [move_resource](#move_resource-method-googledrive-struct) methods.

The *ResourceIndex* parameter specifies the index of the item in the array. The size of the array is controlled by the [ResourceCount](#resource_count-property-googledrive-struct) property.

## Data Type

String

# resource_type property ([GoogleDrive](#struct-cloudstoragegoogledrive) Struct)

The resource's type.

## Syntax

*Rust Syntax*

```text
fn resource_type(&self , ResourceIndex : i32) -> Result<i32, CloudStorageError>
```

## Possible Values

```text
0   // File1   // Folder
```

## Default Value

0

## Remarks

The resource's type.

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

|  |  |
| --- | --- |
| 0 (gdrtFile) | A file. |
| 1 (gdrtFolder) | A folder. |
| 2 (gdrtRevision) | A revision. |

Google treats files and folders in the same way, and folders are included when listing resources. The [resource_access_type](#Dropbox_p_ResourceAccessType) 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 [list_resources](#list_resources-method-googledrive-struct), [delete_resource](#delete_resource-method-googledrive-struct), and [update_resource](#update_resource-method-googledrive-struct) methods.

The *ResourceIndex* parameter specifies the index of the item in the array. The size of the array is controlled by the [ResourceCount](#resource_count-property-googledrive-struct) property.

This property is read-only.

## Data Type

i32

# resource_shared_drive_id property ([GoogleDrive](#struct-cloudstoragegoogledrive) Struct)

The Id of the shared drive the resource is in.

## Syntax

*Rust Syntax*

```text
fn resource_shared_drive_id(&self , ResourceIndex : i32) -> Result<String, CloudStorageError>
```

## 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](#resource_count-property-googledrive-struct) property.

This property is read-only.

## Data Type

String

# resource_size property ([GoogleDrive](#struct-cloudstoragegoogledrive) Struct)

The size of the file resource in bytes.

## Syntax

*Rust Syntax*

```text
fn resource_size(&self , ResourceIndex : i32) -> Result<i64, CloudStorageError>
```

## 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](#resource_count-property-googledrive-struct) property.

This property is read-only.

## Data Type

i64

# resource_starred property ([GoogleDrive](#struct-cloudstoragegoogledrive) Struct)

Whether the resource is starred.

## Syntax

*Rust Syntax*

```text
fn resource_starred(&self , ResourceIndex : i32) -> Result<bool, CloudStorageError> fn set_resource_starred(&self, ResourceIndex : i32, value : bool) ->  Option<CloudStorageError>
```

## 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](#resource_count-property-googledrive-struct) property.

## Data Type

bool

# resource_trashed property ([GoogleDrive](#struct-cloudstoragegoogledrive) Struct)

Whether the resource is in the trash.

## Syntax

*Rust Syntax*

```text
fn resource_trashed(&self , ResourceIndex : i32) -> Result<bool, CloudStorageError> fn set_resource_trashed(&self, ResourceIndex : i32, value : bool) ->  Option<CloudStorageError>
```

## 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 struct only uses it as input when [update_resource](#update_resource-method-googledrive-struct) is called; it is ignored when calling [upload_file](#upload_file-method-googledrive-struct).

The *ResourceIndex* parameter specifies the index of the item in the array. The size of the array is controlled by the [ResourceCount](#resource_count-property-googledrive-struct) property.

## Data Type

bool

# resource_viewed property ([GoogleDrive](#struct-cloudstoragegoogledrive) Struct)

Whether the resource has been viewed.

## Syntax

*Rust Syntax*

```text
fn resource_viewed(&self , ResourceIndex : i32) -> Result<bool, CloudStorageError>
```

## 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](#resource_count-property-googledrive-struct) property.

This property is read-only.

## Data Type

bool

# resource_view_link property ([GoogleDrive](#struct-cloudstoragegoogledrive) Struct)

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

## Syntax

*Rust Syntax*

```text
fn resource_view_link(&self , ResourceIndex : i32) -> Result<String, CloudStorageError>
```

## 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](#resource_count-property-googledrive-struct) property.

This property is read-only.

## Data Type

String

# resume_url property ([GoogleDrive](#struct-cloudstoragegoogledrive) Struct)

The resumable upload URL.

## Syntax

*Rust Syntax*

```text
fn resume_url(&self ) -> Result<String, CloudStorageError> fn set_resume_url(&self, value : &str) ->  Option<CloudStorageError>
fn set_resume_url_ref(&self, value : &String) ->  Option<CloudStorageError>
```

## Default Value

""

## Remarks

This property holds the URL of the resumable upload session. This is populated by the struct automatically when [use_resumable_upload](#use_resumable_upload-property-googledrive-struct) is set to *true* and [upload_file](#upload_file-method-googledrive-struct) is called to initiate a new upload.

This must be set in order to resume an interrupted upload. See [upload_file](#upload_file-method-googledrive-struct) for details.

## Data Type

String

# shared_drive property ([GoogleDrive](#struct-cloudstoragegoogledrive) Struct)

The shared drive to list file and folder resources for.

## Syntax

*Rust Syntax*

```text
fn shared_drive(&self ) -> Result<String, CloudStorageError> fn set_shared_drive(&self, value : &str) ->  Option<CloudStorageError>
fn set_shared_drive_ref(&self, value : &String) ->  Option<CloudStorageError>
```

## Default Value

""

## Remarks

When [list_resources_scope](#list_resources_scope-property-googledrive-struct) is set to *lrsSharedDrive (2)*, this property must be set to a shared drive resource Id before calling [list_resources](#list_resources-method-googledrive-struct) or [list_children](#list_children-method-googledrive-struct).

This property may also be set to a shared drive resource Id before calling [get_current_change_marker](#get_current_change_marker-method-googledrive-struct) or [list_changes](#list_changes-method-googledrive-struct) in order to list changes to the specified shared drive and its contents.

Refer to [list_resources](#list_resources-method-googledrive-struct) or [list_changes](#list_changes-method-googledrive-struct) for more information.

## Data Type

String

# shared_drive_marker property ([GoogleDrive](#struct-cloudstoragegoogledrive) Struct)

A marker when shared drives are paged.

## Syntax

*Rust Syntax*

```text
fn shared_drive_marker(&self ) -> Result<String, CloudStorageError> fn set_shared_drive_marker(&self, value : &str) ->  Option<CloudStorageError>
fn set_shared_drive_marker_ref(&self, value : &String) ->  Option<CloudStorageError>
```

## Default Value

""

## Remarks

This property returns a marker used to iterate over pages of shared drives; it's populated when [list_shared_drives](#list_shared_drives-method-googledrive-struct) is called if the results are paged.

Continue to call [list_shared_drives](#list_shared_drives-method-googledrive-struct) until this property returns empty string in order to list all shared drives.

## Data Type

String

# shared_drive_count property ([GoogleDrive](#struct-cloudstoragegoogledrive) Struct)

The number of records in the SharedDrive arrays.

## Syntax

*Rust Syntax*

```text
fn shared_drive_count(&self ) -> Result<i32, CloudStorageError>
```

## Default Value

0

## Remarks

This property controls the size of the following arrays:

- [shared_drive_capabilities](#shared_drive_capabilities-property-googledrive-struct)
- [shared_drive_created_time](#shared_drive_created_time-property-googledrive-struct)
- [shared_drive_hidden](#shared_drive_hidden-property-googledrive-struct)
- [shared_drive_id](#shared_drive_id-property-googledrive-struct)
- [shared_drive_name](#shared_drive_name-property-googledrive-struct)
- [shared_drive_restrictions](#shared_drive_restrictions-property-googledrive-struct)

The array indices start at *0* and end at *shared_drive_count - 1*.

This property is read-only.

## Data Type

i32

# shared_drive_capabilities property ([GoogleDrive](#struct-cloudstoragegoogledrive) Struct)

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

## Syntax

*Rust Syntax*

```text
fn shared_drive_capabilities(&self , SharedDriveIndex : i32) -> Result<i32, CloudStorageError>
```

## 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:

| Hex Value | Description |
| --- | --- |
| 0x00001 | User can add children to the shared drive's folders. |
| 0x00002 | User can change the shared drive's copyRequiresWriterPermission restriction. |
| 0x00004 | User can change the shared drive's domainUsersOnly restriction. |
| 0x00008 | User can change the shared drive's background image. |
| 0x00010 | User can change the shared drive's driveMembersOnly restriction. |
| 0x00020 | User can comment on the shared drive's files. |
| 0x00040 | User can copy files in the shared drive. |
| 0x00080 | User can permanently delete children from the shared drive's folders. |
| 0x00100 | User can delete the shared drive. |
| 0x00200 | User can download the shared drive's files. |
| 0x00400 | User can edit the shared drive's files. |
| 0x00800 | User can list children of folders in the shared drive. |
| 0x01000 | User can add, remove, and update shared drive members. |
| 0x02000 | User can read revisions of the shared drive's files. |
| 0x04000 | User can rename the shared drive's files and folders. |
| 0x08000 | User can rename the shared drive. |
| 0x10000 | User can share the shared drive's files and folders. |
| 0x20000 | User can trash children from the shared drive's folders. |

The *SharedDriveIndex* parameter specifies the index of the item in the array. The size of the array is controlled by the [SharedDriveCount](#shared_drive_count-property-googledrive-struct) property.

This property is read-only.

## Data Type

i32

# shared_drive_created_time property ([GoogleDrive](#struct-cloudstoragegoogledrive) Struct)

The creation date of the shared drive.

## Syntax

*Rust Syntax*

```text
fn shared_drive_created_time(&self , SharedDriveIndex : i32) -> Result<String, CloudStorageError>
```

## 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](#shared_drive_count-property-googledrive-struct) property.

This property is read-only.

## Data Type

String

# shared_drive_hidden property ([GoogleDrive](#struct-cloudstoragegoogledrive) Struct)

Whether the shared drive is hidden from default view.

## Syntax

*Rust Syntax*

```text
fn shared_drive_hidden(&self , SharedDriveIndex : i32) -> Result<bool, CloudStorageError>
```

## 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 [toggle_shared_drive_hidden](#toggle_shared_drive_hidden-method-googledrive-struct) 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](#shared_drive_count-property-googledrive-struct) property.

This property is read-only.

## Data Type

bool

# shared_drive_id property ([GoogleDrive](#struct-cloudstoragegoogledrive) Struct)

The Id of the shared drive.

## Syntax

*Rust Syntax*

```text
fn shared_drive_id(&self , SharedDriveIndex : i32) -> Result<String, CloudStorageError>
```

## 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](#shared_drive_count-property-googledrive-struct) property.

This property is read-only.

## Data Type

String

# shared_drive_name property ([GoogleDrive](#struct-cloudstoragegoogledrive) Struct)

The name of the shared drive.

## Syntax

*Rust Syntax*

```text
fn shared_drive_name(&self , SharedDriveIndex : i32) -> Result<String, CloudStorageError>
```

## Default Value

""

## Remarks

The name of the shared drive.

This property reflects the name of the shared drive.

The [update_shared_drive](#update_shared_drive-method-googledrive-struct) method can be used to rename the shared drive if the current user is allowed to do so (i.e., if the [shared_drive_capabilities](#shared_drive_capabilities-property-googledrive-struct) 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](#shared_drive_count-property-googledrive-struct) property.

This property is read-only.

## Data Type

String

# shared_drive_restrictions property ([GoogleDrive](#struct-cloudstoragegoogledrive) Struct)

The restrictions that apply to the shared drive.

## Syntax

*Rust Syntax*

```text
fn shared_drive_restrictions(&self , SharedDriveIndex : i32) -> Result<i32, CloudStorageError>
```

## 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:

| Hex Value | Description |
| --- | --- |
| 0x0001 | Administrative privileges on the shared drive are required to modify restrictions. |
| 0x0002 | Readers and commenters cannot copy, print, or download files in the shared drive. |
| 0x0004 | Access to the shared drive, and its contents, is restricted to users in its domain. |
| 0x0008 | Access to items in the shared drive is restricted to its members. |

The [update_shared_drive](#update_shared_drive-method-googledrive-struct) 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 [shared_drive_capabilities](#shared_drive_capabilities-property-googledrive-struct) property).

The *SharedDriveIndex* parameter specifies the index of the item in the array. The size of the array is controlled by the [SharedDriveCount](#shared_drive_count-property-googledrive-struct) property.

This property is read-only.

## Data Type

i32

# ssl_accept_server_cert_effective_date property ([GoogleDrive](#struct-cloudstoragegoogledrive) Struct)

The date on which this certificate becomes valid.

## Syntax

*Rust Syntax*

```text
fn ssl_accept_server_cert_effective_date(&self ) -> Result<String, CloudStorageError>
```

## 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

# ssl_accept_server_cert_expiration_date property ([GoogleDrive](#struct-cloudstoragegoogledrive) Struct)

The date on which the certificate expires.

## Syntax

*Rust Syntax*

```text
fn ssl_accept_server_cert_expiration_date(&self ) -> Result<String, CloudStorageError>
```

## 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

# ssl_accept_server_cert_extended_key_usage property ([GoogleDrive](#struct-cloudstoragegoogledrive) Struct)

A comma-delimited list of extended key usage identifiers.

## Syntax

*Rust Syntax*

```text
fn ssl_accept_server_cert_extended_key_usage(&self ) -> Result<String, CloudStorageError>
```

## 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

# ssl_accept_server_cert_fingerprint property ([GoogleDrive](#struct-cloudstoragegoogledrive) Struct)

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

## Syntax

*Rust Syntax*

```text
fn ssl_accept_server_cert_fingerprint(&self ) -> Result<String, CloudStorageError>
```

## 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

# ssl_accept_server_cert_fingerprint_sha1 property ([GoogleDrive](#struct-cloudstoragegoogledrive) Struct)

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

## Syntax

*Rust Syntax*

```text
fn ssl_accept_server_cert_fingerprint_sha1(&self ) -> Result<String, CloudStorageError>
```

## 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

# ssl_accept_server_cert_fingerprint_sha256 property ([GoogleDrive](#struct-cloudstoragegoogledrive) Struct)

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

## Syntax

*Rust Syntax*

```text
fn ssl_accept_server_cert_fingerprint_sha256(&self ) -> Result<String, CloudStorageError>
```

## 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

# ssl_accept_server_cert_issuer property ([GoogleDrive](#struct-cloudstoragegoogledrive) Struct)

The issuer of the certificate.

## Syntax

*Rust Syntax*

```text
fn ssl_accept_server_cert_issuer(&self ) -> Result<String, CloudStorageError>
```

## 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

# ssl_accept_server_cert_private_key property ([GoogleDrive](#struct-cloudstoragegoogledrive) Struct)

The private key of the certificate (if available).

## Syntax

*Rust Syntax*

```text
fn ssl_accept_server_cert_private_key(&self ) -> Result<String, CloudStorageError>
```

## Default Value

""

## Remarks

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

NOTE: The [ssl_accept_server_cert_private_key](#ssl_accept_server_cert_private_key-property-googledrive-struct) may be available but not exportable. In this case, [ssl_accept_server_cert_private_key](#ssl_accept_server_cert_private_key-property-googledrive-struct) returns an empty string.

This property is read-only.

## Data Type

String

# ssl_accept_server_cert_private_key_available property ([GoogleDrive](#struct-cloudstoragegoogledrive) Struct)

Whether a PrivateKey is available for the selected certificate.

## Syntax

*Rust Syntax*

```text
fn ssl_accept_server_cert_private_key_available(&self ) -> Result<bool, CloudStorageError>
```

## Default Value

false

## Remarks

Whether a [ssl_accept_server_cert_private_key](#ssl_accept_server_cert_private_key-property-googledrive-struct) is available for the selected certificate. If [ssl_accept_server_cert_private_key_available](#ssl_accept_server_cert_private_key_available-property-googledrive-struct) is True, the certificate may be used for authentication purposes (e.g., server authentication).

This property is read-only.

## Data Type

bool

# ssl_accept_server_cert_private_key_container property ([GoogleDrive](#struct-cloudstoragegoogledrive) Struct)

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

## Syntax

*Rust Syntax*

```text
fn ssl_accept_server_cert_private_key_container(&self ) -> Result<String, CloudStorageError>
```

## Default Value

""

## Remarks

The name of the [ssl_accept_server_cert_private_key](#ssl_accept_server_cert_private_key-property-googledrive-struct) container for the certificate (if available). This functionality is available only on Windows platforms.

This property is read-only.

## Data Type

String

# ssl_accept_server_cert_public_key property ([GoogleDrive](#struct-cloudstoragegoogledrive) Struct)

The public key of the certificate.

## Syntax

*Rust Syntax*

```text
fn ssl_accept_server_cert_public_key(&self ) -> Result<String, CloudStorageError>
```

## 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

# ssl_accept_server_cert_public_key_algorithm property ([GoogleDrive](#struct-cloudstoragegoogledrive) Struct)

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

## Syntax

*Rust Syntax*

```text
fn ssl_accept_server_cert_public_key_algorithm(&self ) -> Result<String, CloudStorageError>
```

## 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

# ssl_accept_server_cert_public_key_length property ([GoogleDrive](#struct-cloudstoragegoogledrive) Struct)

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

## Syntax

*Rust Syntax*

```text
fn ssl_accept_server_cert_public_key_length(&self ) -> Result<i32, CloudStorageError>
```

## 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

i32

# ssl_accept_server_cert_serial_number property ([GoogleDrive](#struct-cloudstoragegoogledrive) Struct)

The serial number of the certificate encoded as a string.

## Syntax

*Rust Syntax*

```text
fn ssl_accept_server_cert_serial_number(&self ) -> Result<String, CloudStorageError>
```

## 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

# ssl_accept_server_cert_signature_algorithm property ([GoogleDrive](#struct-cloudstoragegoogledrive) Struct)

The text description of the certificate's signature algorithm.

## Syntax

*Rust Syntax*

```text
fn ssl_accept_server_cert_signature_algorithm(&self ) -> Result<String, CloudStorageError>
```

## 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

# ssl_accept_server_cert_store property ([GoogleDrive](#struct-cloudstoragegoogledrive) Struct)

The name of the certificate store for the client certificate.

## Syntax

*Rust Syntax*

```text
fn ssl_accept_server_cert_store(&self ) -> Result<Vec<u8>, CloudStorageError> fn set_ssl_accept_server_cert_store(&self, value : Vec<u8>) ->  Option<CloudStorageError>
fn set_ssl_accept_server_cert_store_ref(&self, value : &[u8]) ->  Option<CloudStorageError>
```

## Default Value

"MY"

## Remarks

The name of the certificate store for the client certificate.

The [ssl_accept_server_cert_store_type](#ssl_accept_server_cert_store_type-property-googledrive-struct) property denotes the type of the certificate store specified by [ssl_accept_server_cert_store](#ssl_accept_server_cert_store-property-googledrive-struct). If the store is password-protected, specify the password in [ssl_accept_server_cert_store_password](#ssl_accept_server_cert_store_password-property-googledrive-struct).

[ssl_accept_server_cert_store](#ssl_accept_server_cert_store-property-googledrive-struct) is used in conjunction with the [ssl_accept_server_cert_subject](#ssl_accept_server_cert_subject-property-googledrive-struct) property to specify client certificates. If [ssl_accept_server_cert_store](#ssl_accept_server_cert_store-property-googledrive-struct) has a value, and [ssl_accept_server_cert_subject](#ssl_accept_server_cert_subject-property-googledrive-struct) or [ssl_accept_server_cert_encoded](#ssl_accept_server_cert_encoded-property-googledrive-struct) is set, a search for a certificate is initiated. Please see the [ssl_accept_server_cert_subject](#ssl_accept_server_cert_subject-property-googledrive-struct) property for details.

 Designations of certificate stores are platform dependent.

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

|  |  |
| --- | --- |
| MY | A certificate store holding personal certificates with their associated private keys. |
| CA | Certifying authority certificates. |
| ROOT | Root certificates. |

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).

## Data Type

Vec

# ssl_accept_server_cert_store_password property ([GoogleDrive](#struct-cloudstoragegoogledrive) Struct)

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

## Syntax

*Rust Syntax*

```text
fn ssl_accept_server_cert_store_password(&self ) -> Result<String, CloudStorageError> fn set_ssl_accept_server_cert_store_password(&self, value : &str) ->  Option<CloudStorageError>
fn set_ssl_accept_server_cert_store_password_ref(&self, value : &String) ->  Option<CloudStorageError>
```

## 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

# ssl_accept_server_cert_store_type property ([GoogleDrive](#struct-cloudstoragegoogledrive) Struct)

The type of certificate store for this certificate.

## Syntax

*Rust Syntax*

```text
fn ssl_accept_server_cert_store_type(&self ) -> Result<i32, CloudStorageError> fn set_ssl_accept_server_cert_store_type(&self, value : i32) ->  Option<CloudStorageError>
```

## Possible Values

```text
0   // User1   // Machine2   // PFXFile3   // PFXBlob4   // JKSFile5   // JKSBlob6   // PEMKeyFile7   // PEMKeyBlob8   // PublicKeyFile9   // PublicKeyBlob10   // SSHPublicKeyBlob11   // P7BFile12   // P7BBlob13   // SSHPublicKeyFile14   // PPKFile15   // PPKBlob16   // XMLFile17   // XMLBlob18   // JWKFile19   // JWKBlob20   // SecurityKey21   // BCFKSFile22   // BCFKSBlob23   // PKCS1199   // Auto
```

## Default Value

0

## Remarks

The type of certificate store for this certificate.

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

```csharp
sftp.SSHCert = new Certificate(CertStoreTypes.cstPKCS11,
                               @"C:\Program Files\OpenSC Project\OpenSC\pkcs11\opensc-pkcs11.dll",
                               "123456", // PIN
                               "CN=cert_subject");
sftp.SSHUser = "test";
sftp.SSHLogon("myhost", 22);
```

```csharp
certmgr.CertStoreType = CertStoreTypes.cstPKCS11;
certmgr.OnCertList += (s, e) => {
  secKeyBlob = e.CertEncoded;
};
certmgr.CertStore = @"C:\Program Files\OpenSC Project\OpenSC\pkcs11\opensc-pkcs11.dll";
certmgr.CertStorePassword = "123456"; // PIN
certmgr.ListStoreCertificates();

sftp.SSHCert = new Certificate(CertStoreTypes.cstPKCS11, secKeyBlob, "123456", "*");
sftp.SSHUser = "test";
sftp.SSHLogon("myhost", 22);
```

|  |  |
| --- | --- |
| 0 (cstUser - default) | For Windows, this specifies that the certificate store is a certificate store owned by the current user. NOTE: This store type is not available in Java. |
| 1 (cstMachine) | For Windows, this specifies that the certificate store is a machine store. NOTE: This store type is not available in Java. |
| 2 (cstPFXFile) | The certificate store is the name of a PFX (PKCS#12) file containing certificates. |
| 3 (cstPFXBlob) | The certificate store is a string (binary or Base64-encoded) representing a certificate store in PFX (PKCS#12) format. |
| 4 (cstJKSFile) | The certificate store is the name of a Java Key Store (JKS) file containing certificates. NOTE: This store type is only available in Java. |
| 5 (cstJKSBlob) | The certificate store is a string (binary or Base64-encoded) representing a certificate store in Java Key Store (JKS) format. NOTE: This store type is only available in Java. |
| 6 (cstPEMKeyFile) | The certificate store is the name of a PEM-encoded file that contains a private key and an optional certificate. |
| 7 (cstPEMKeyBlob) | The certificate store is a string (binary or Base64-encoded) that contains a private key and an optional certificate. |
| 8 (cstPublicKeyFile) | The certificate store is the name of a file that contains a PEM- or DER-encoded public key certificate. |
| 9 (cstPublicKeyBlob) | The certificate store is a string (binary or Base64-encoded) that contains a PEM- or DER-encoded public key certificate. |
| 10 (cstSSHPublicKeyBlob) | The certificate store is a string (binary or Base64-encoded) that contains an SSH-style public key. |
| 11 (cstP7BFile) | The certificate store is the name of a PKCS#7 file containing certificates. |
| 12 (cstP7BBlob) | The certificate store is a string (binary) representing a certificate store in PKCS#7 format. |
| 13 (cstSSHPublicKeyFile) | The certificate store is the name of a file that contains an SSH-style public key. |
| 14 (cstPPKFile) | The certificate store is the name of a file that contains a PPK (PuTTY Private Key). |
| 15 (cstPPKBlob) | The certificate store is a string (binary) that contains a PPK (PuTTY Private Key). |
| 16 (cstXMLFile) | The certificate store is the name of a file that contains a certificate in XML format. |
| 17 (cstXMLBlob) | The certificate store is a string that contains a certificate in XML format. |
| 18 (cstJWKFile) | The certificate store is the name of a file that contains a JWK (JSON Web Key). |
| 19 (cstJWKBlob) | The certificate store is a string that contains a JWK (JSON Web Key). |
| 21 (cstBCFKSFile) | The certificate store is the name of a file that contains a BCFKS (Bouncy Castle FIPS Key Store). NOTE: This store type is only available in Java and .NET. |
| 22 (cstBCFKSBlob) | The certificate store is a string (binary or Base64-encoded) representing a certificate store in BCFKS (Bouncy Castle FIPS Key Store) format. NOTE: This store type is only available in Java and .NET. |
| 23 (cstPKCS11) | The certificate is present on a physical security key accessible via a PKCS#11 interface. To use a security key, create a new [Certificate](#Type_Certificate) object and pass cstPKCS11 as the [ssl_accept_server_cert_store_type](#ssl_accept_server_cert_store_type-property-googledrive-struct), the full path of the PKCS#11 DLL as the [ssl_accept_server_cert_store](#ssl_accept_server_cert_store-property-googledrive-struct), and the PIN as the [ssl_accept_server_cert_store_password](#ssl_accept_server_cert_store_password-property-googledrive-struct). Code Example. SSH Authentication with Security Key (without CertMgr): Alternatively, collect the necessary data using the [CertMgr](#CertMgr) struct by calling the [list_store_certificates](#CertMgr_m_ListStoreCertificates) method after setting the corresponding properties accordingly. The certificate information returned in the [on_cert_list](#CertMgr_e_CertList) event's CertEncoded parameter may be saved for later use. When using a certificate obtained with this approach, pass the previously saved security key information as the [ssl_accept_server_cert_store](#ssl_accept_server_cert_store-property-googledrive-struct) and set [ssl_accept_server_cert_store_password](#ssl_accept_server_cert_store_password-property-googledrive-struct) to the PIN. Code Example. SSH Authentication with Security Key (with CertMgr): |
| 99 (cstAuto) | The store type is automatically detected from the input data. This setting may be used with both public and private keys and can detect any of the supported formats automatically. |

## Data Type

i32

# ssl_accept_server_cert_subject_alt_names property ([GoogleDrive](#struct-cloudstoragegoogledrive) Struct)

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

## Syntax

*Rust Syntax*

```text
fn ssl_accept_server_cert_subject_alt_names(&self ) -> Result<String, CloudStorageError>
```

## Default Value

""

## Remarks

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

This property is read-only.

## Data Type

String

# ssl_accept_server_cert_thumbprint_md5 property ([GoogleDrive](#struct-cloudstoragegoogledrive) Struct)

The MD5 hash of the certificate.

## Syntax

*Rust Syntax*

```text
fn ssl_accept_server_cert_thumbprint_md5(&self ) -> Result<String, CloudStorageError>
```

## 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

# ssl_accept_server_cert_thumbprint_sha1 property ([GoogleDrive](#struct-cloudstoragegoogledrive) Struct)

The SHA-1 hash of the certificate.

## Syntax

*Rust Syntax*

```text
fn ssl_accept_server_cert_thumbprint_sha1(&self ) -> Result<String, CloudStorageError>
```

## 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

# ssl_accept_server_cert_thumbprint_sha256 property ([GoogleDrive](#struct-cloudstoragegoogledrive) Struct)

The SHA-256 hash of the certificate.

## Syntax

*Rust Syntax*

```text
fn ssl_accept_server_cert_thumbprint_sha256(&self ) -> Result<String, CloudStorageError>
```

## 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

# ssl_accept_server_cert_usage property ([GoogleDrive](#struct-cloudstoragegoogledrive) Struct)

The text description of UsageFlags .

## Syntax

*Rust Syntax*

```text
fn ssl_accept_server_cert_usage(&self ) -> Result<String, CloudStorageError>
```

## Default Value

""

## Remarks

The text description of [ssl_accept_server_cert_usage_flags](#ssl_accept_server_cert_usage_flags-property-googledrive-struct).

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

# ssl_accept_server_cert_usage_flags property ([GoogleDrive](#struct-cloudstoragegoogledrive) Struct)

The flags that show intended use for the certificate.

## Syntax

*Rust Syntax*

```text
fn ssl_accept_server_cert_usage_flags(&self ) -> Result<i32, CloudStorageError>
```

## Default Value

0

## Remarks

The flags that show intended use for the certificate. The value of [ssl_accept_server_cert_usage_flags](#ssl_accept_server_cert_usage_flags-property-googledrive-struct) is a combination of the following flags:

|  |  |
| --- | --- |
| 0x80 | Digital Signature |
| 0x40 | Non-Repudiation |
| 0x20 | Key Encipherment |
| 0x10 | Data Encipherment |
| 0x08 | Key Agreement |
| 0x04 | Certificate Signing |
| 0x02 | CRL Signing |
| 0x01 | Encipher Only |

Please see the [ssl_accept_server_cert_usage](#ssl_accept_server_cert_usage-property-googledrive-struct) property for a text representation of [ssl_accept_server_cert_usage_flags](#ssl_accept_server_cert_usage_flags-property-googledrive-struct).

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

This property is read-only.

## Data Type

i32

# ssl_accept_server_cert_version property ([GoogleDrive](#struct-cloudstoragegoogledrive) Struct)

The certificate's version number.

## Syntax

*Rust Syntax*

```text
fn ssl_accept_server_cert_version(&self ) -> Result<String, CloudStorageError>
```

## 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

# ssl_accept_server_cert_subject property ([GoogleDrive](#struct-cloudstoragegoogledrive) Struct)

The subject of the certificate used for client authentication.

## Syntax

*Rust Syntax*

```text
fn ssl_accept_server_cert_subject(&self ) -> Result<String, CloudStorageError> fn set_ssl_accept_server_cert_subject(&self, value : &str) ->  Option<CloudStorageError>
fn set_ssl_accept_server_cert_subject_ref(&self, value : &String) ->  Option<CloudStorageError>
```

## 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=example@email.com". Common fields and their meanings are as follows:

| Field | Meaning |
| --- | --- |
| CN | Common Name. This is commonly a hostname like www.server.com. |
| O | Organization |
| OU | Organizational Unit |
| L | Locality |
| S | State |
| C | Country |
| E | Email Address |

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

## Data Type

String

# ssl_accept_server_cert_encoded property ([GoogleDrive](#struct-cloudstoragegoogledrive) Struct)

The certificate (PEM/Base64 encoded).

## Syntax

*Rust Syntax*

```text
fn ssl_accept_server_cert_encoded(&self ) -> Result<Vec<u8>, CloudStorageError> fn set_ssl_accept_server_cert_encoded(&self, value : Vec<u8>) ->  Option<CloudStorageError>
fn set_ssl_accept_server_cert_encoded_ref(&self, value : &[u8]) ->  Option<CloudStorageError>
```

## Default Value

""

## Remarks

The certificate (PEM/Base64 encoded). This property is used to assign a specific certificate. The [ssl_accept_server_cert_store](#ssl_accept_server_cert_store-property-googledrive-struct) and [ssl_accept_server_cert_subject](#ssl_accept_server_cert_subject-property-googledrive-struct) properties also may be used to specify a certificate.

When [ssl_accept_server_cert_encoded](#ssl_accept_server_cert_encoded-property-googledrive-struct) is set, a search is initiated in the current [ssl_accept_server_cert_store](#ssl_accept_server_cert_store-property-googledrive-struct) for the private key of the certificate. If the key is found, [ssl_accept_server_cert_subject](#ssl_accept_server_cert_subject-property-googledrive-struct) is updated to reflect the full subject of the selected certificate; otherwise, [ssl_accept_server_cert_subject](#ssl_accept_server_cert_subject-property-googledrive-struct) is set to an empty string.

## Data Type

Vec

# ssl_cert_effective_date property ([GoogleDrive](#struct-cloudstoragegoogledrive) Struct)

The date on which this certificate becomes valid.

## Syntax

*Rust Syntax*

```text
fn ssl_cert_effective_date(&self ) -> Result<String, CloudStorageError>
```

## 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

# ssl_cert_expiration_date property ([GoogleDrive](#struct-cloudstoragegoogledrive) Struct)

The date on which the certificate expires.

## Syntax

*Rust Syntax*

```text
fn ssl_cert_expiration_date(&self ) -> Result<String, CloudStorageError>
```

## 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

# ssl_cert_extended_key_usage property ([GoogleDrive](#struct-cloudstoragegoogledrive) Struct)

A comma-delimited list of extended key usage identifiers.

## Syntax

*Rust Syntax*

```text
fn ssl_cert_extended_key_usage(&self ) -> Result<String, CloudStorageError>
```

## 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

# ssl_cert_fingerprint property ([GoogleDrive](#struct-cloudstoragegoogledrive) Struct)

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

## Syntax

*Rust Syntax*

```text
fn ssl_cert_fingerprint(&self ) -> Result<String, CloudStorageError>
```

## 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

# ssl_cert_fingerprint_sha1 property ([GoogleDrive](#struct-cloudstoragegoogledrive) Struct)

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

## Syntax

*Rust Syntax*

```text
fn ssl_cert_fingerprint_sha1(&self ) -> Result<String, CloudStorageError>
```

## 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

# ssl_cert_fingerprint_sha256 property ([GoogleDrive](#struct-cloudstoragegoogledrive) Struct)

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

## Syntax

*Rust Syntax*

```text
fn ssl_cert_fingerprint_sha256(&self ) -> Result<String, CloudStorageError>
```

## 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

# ssl_cert_issuer property ([GoogleDrive](#struct-cloudstoragegoogledrive) Struct)

The issuer of the certificate.

## Syntax

*Rust Syntax*

```text
fn ssl_cert_issuer(&self ) -> Result<String, CloudStorageError>
```

## 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

# ssl_cert_private_key property ([GoogleDrive](#struct-cloudstoragegoogledrive) Struct)

The private key of the certificate (if available).

## Syntax

*Rust Syntax*

```text
fn ssl_cert_private_key(&self ) -> Result<String, CloudStorageError>
```

## Default Value

""

## Remarks

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

NOTE: The [ssl_cert_private_key](#ssl_cert_private_key-property-googledrive-struct) may be available but not exportable. In this case, [ssl_cert_private_key](#ssl_cert_private_key-property-googledrive-struct) returns an empty string.

This property is read-only.

## Data Type

String

# ssl_cert_private_key_available property ([GoogleDrive](#struct-cloudstoragegoogledrive) Struct)

Whether a PrivateKey is available for the selected certificate.

## Syntax

*Rust Syntax*

```text
fn ssl_cert_private_key_available(&self ) -> Result<bool, CloudStorageError>
```

## Default Value

false

## Remarks

Whether a [ssl_cert_private_key](#ssl_cert_private_key-property-googledrive-struct) is available for the selected certificate. If [ssl_cert_private_key_available](#ssl_cert_private_key_available-property-googledrive-struct) is True, the certificate may be used for authentication purposes (e.g., server authentication).

This property is read-only.

## Data Type

bool

# ssl_cert_private_key_container property ([GoogleDrive](#struct-cloudstoragegoogledrive) Struct)

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

## Syntax

*Rust Syntax*

```text
fn ssl_cert_private_key_container(&self ) -> Result<String, CloudStorageError>
```

## Default Value

""

## Remarks

The name of the [ssl_cert_private_key](#ssl_cert_private_key-property-googledrive-struct) container for the certificate (if available). This functionality is available only on Windows platforms.

This property is read-only.

## Data Type

String

# ssl_cert_public_key property ([GoogleDrive](#struct-cloudstoragegoogledrive) Struct)

The public key of the certificate.

## Syntax

*Rust Syntax*

```text
fn ssl_cert_public_key(&self ) -> Result<String, CloudStorageError>
```

## 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

# ssl_cert_public_key_algorithm property ([GoogleDrive](#struct-cloudstoragegoogledrive) Struct)

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

## Syntax

*Rust Syntax*

```text
fn ssl_cert_public_key_algorithm(&self ) -> Result<String, CloudStorageError>
```

## 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

# ssl_cert_public_key_length property ([GoogleDrive](#struct-cloudstoragegoogledrive) Struct)

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

## Syntax

*Rust Syntax*

```text
fn ssl_cert_public_key_length(&self ) -> Result<i32, CloudStorageError>
```

## 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

i32

# ssl_cert_serial_number property ([GoogleDrive](#struct-cloudstoragegoogledrive) Struct)

The serial number of the certificate encoded as a string.

## Syntax

*Rust Syntax*

```text
fn ssl_cert_serial_number(&self ) -> Result<String, CloudStorageError>
```

## 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

# ssl_cert_signature_algorithm property ([GoogleDrive](#struct-cloudstoragegoogledrive) Struct)

The text description of the certificate's signature algorithm.

## Syntax

*Rust Syntax*

```text
fn ssl_cert_signature_algorithm(&self ) -> Result<String, CloudStorageError>
```

## 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

# ssl_cert_store property ([GoogleDrive](#struct-cloudstoragegoogledrive) Struct)

The name of the certificate store for the client certificate.

## Syntax

*Rust Syntax*

```text
fn ssl_cert_store(&self ) -> Result<Vec<u8>, CloudStorageError> fn set_ssl_cert_store(&self, value : Vec<u8>) ->  Option<CloudStorageError>
fn set_ssl_cert_store_ref(&self, value : &[u8]) ->  Option<CloudStorageError>
```

## Default Value

"MY"

## Remarks

The name of the certificate store for the client certificate.

The [ssl_cert_store_type](#ssl_cert_store_type-property-googledrive-struct) property denotes the type of the certificate store specified by [ssl_cert_store](#ssl_cert_store-property-googledrive-struct). If the store is password-protected, specify the password in [ssl_cert_store_password](#ssl_cert_store_password-property-googledrive-struct).

[ssl_cert_store](#ssl_cert_store-property-googledrive-struct) is used in conjunction with the [ssl_cert_subject](#ssl_cert_subject-property-googledrive-struct) property to specify client certificates. If [ssl_cert_store](#ssl_cert_store-property-googledrive-struct) has a value, and [ssl_cert_subject](#ssl_cert_subject-property-googledrive-struct) or [ssl_cert_encoded](#ssl_cert_encoded-property-googledrive-struct) is set, a search for a certificate is initiated. Please see the [ssl_cert_subject](#ssl_cert_subject-property-googledrive-struct) property for details.

 Designations of certificate stores are platform dependent.

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

|  |  |
| --- | --- |
| MY | A certificate store holding personal certificates with their associated private keys. |
| CA | Certifying authority certificates. |
| ROOT | Root certificates. |

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).

## Data Type

Vec

# ssl_cert_store_password property ([GoogleDrive](#struct-cloudstoragegoogledrive) Struct)

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

## Syntax

*Rust Syntax*

```text
fn ssl_cert_store_password(&self ) -> Result<String, CloudStorageError> fn set_ssl_cert_store_password(&self, value : &str) ->  Option<CloudStorageError>
fn set_ssl_cert_store_password_ref(&self, value : &String) ->  Option<CloudStorageError>
```

## 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

# ssl_cert_store_type property ([GoogleDrive](#struct-cloudstoragegoogledrive) Struct)

The type of certificate store for this certificate.

## Syntax

*Rust Syntax*

```text
fn ssl_cert_store_type(&self ) -> Result<i32, CloudStorageError> fn set_ssl_cert_store_type(&self, value : i32) ->  Option<CloudStorageError>
```

## Possible Values

```text
0   // User1   // Machine2   // PFXFile3   // PFXBlob4   // JKSFile5   // JKSBlob6   // PEMKeyFile7   // PEMKeyBlob8   // PublicKeyFile9   // PublicKeyBlob10   // SSHPublicKeyBlob11   // P7BFile12   // P7BBlob13   // SSHPublicKeyFile14   // PPKFile15   // PPKBlob16   // XMLFile17   // XMLBlob18   // JWKFile19   // JWKBlob20   // SecurityKey21   // BCFKSFile22   // BCFKSBlob23   // PKCS1199   // Auto
```

## Default Value

0

## Remarks

The type of certificate store for this certificate.

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

```csharp
sftp.SSHCert = new Certificate(CertStoreTypes.cstPKCS11,
                               @"C:\Program Files\OpenSC Project\OpenSC\pkcs11\opensc-pkcs11.dll",
                               "123456", // PIN
                               "CN=cert_subject");
sftp.SSHUser = "test";
sftp.SSHLogon("myhost", 22);
```

```csharp
certmgr.CertStoreType = CertStoreTypes.cstPKCS11;
certmgr.OnCertList += (s, e) => {
  secKeyBlob = e.CertEncoded;
};
certmgr.CertStore = @"C:\Program Files\OpenSC Project\OpenSC\pkcs11\opensc-pkcs11.dll";
certmgr.CertStorePassword = "123456"; // PIN
certmgr.ListStoreCertificates();

sftp.SSHCert = new Certificate(CertStoreTypes.cstPKCS11, secKeyBlob, "123456", "*");
sftp.SSHUser = "test";
sftp.SSHLogon("myhost", 22);
```

|  |  |
| --- | --- |
| 0 (cstUser - default) | For Windows, this specifies that the certificate store is a certificate store owned by the current user. NOTE: This store type is not available in Java. |
| 1 (cstMachine) | For Windows, this specifies that the certificate store is a machine store. NOTE: This store type is not available in Java. |
| 2 (cstPFXFile) | The certificate store is the name of a PFX (PKCS#12) file containing certificates. |
| 3 (cstPFXBlob) | The certificate store is a string (binary or Base64-encoded) representing a certificate store in PFX (PKCS#12) format. |
| 4 (cstJKSFile) | The certificate store is the name of a Java Key Store (JKS) file containing certificates. NOTE: This store type is only available in Java. |
| 5 (cstJKSBlob) | The certificate store is a string (binary or Base64-encoded) representing a certificate store in Java Key Store (JKS) format. NOTE: This store type is only available in Java. |
| 6 (cstPEMKeyFile) | The certificate store is the name of a PEM-encoded file that contains a private key and an optional certificate. |
| 7 (cstPEMKeyBlob) | The certificate store is a string (binary or Base64-encoded) that contains a private key and an optional certificate. |
| 8 (cstPublicKeyFile) | The certificate store is the name of a file that contains a PEM- or DER-encoded public key certificate. |
| 9 (cstPublicKeyBlob) | The certificate store is a string (binary or Base64-encoded) that contains a PEM- or DER-encoded public key certificate. |
| 10 (cstSSHPublicKeyBlob) | The certificate store is a string (binary or Base64-encoded) that contains an SSH-style public key. |
| 11 (cstP7BFile) | The certificate store is the name of a PKCS#7 file containing certificates. |
| 12 (cstP7BBlob) | The certificate store is a string (binary) representing a certificate store in PKCS#7 format. |
| 13 (cstSSHPublicKeyFile) | The certificate store is the name of a file that contains an SSH-style public key. |
| 14 (cstPPKFile) | The certificate store is the name of a file that contains a PPK (PuTTY Private Key). |
| 15 (cstPPKBlob) | The certificate store is a string (binary) that contains a PPK (PuTTY Private Key). |
| 16 (cstXMLFile) | The certificate store is the name of a file that contains a certificate in XML format. |
| 17 (cstXMLBlob) | The certificate store is a string that contains a certificate in XML format. |
| 18 (cstJWKFile) | The certificate store is the name of a file that contains a JWK (JSON Web Key). |
| 19 (cstJWKBlob) | The certificate store is a string that contains a JWK (JSON Web Key). |
| 21 (cstBCFKSFile) | The certificate store is the name of a file that contains a BCFKS (Bouncy Castle FIPS Key Store). NOTE: This store type is only available in Java and .NET. |
| 22 (cstBCFKSBlob) | The certificate store is a string (binary or Base64-encoded) representing a certificate store in BCFKS (Bouncy Castle FIPS Key Store) format. NOTE: This store type is only available in Java and .NET. |
| 23 (cstPKCS11) | The certificate is present on a physical security key accessible via a PKCS#11 interface. To use a security key, create a new [Certificate](#Type_Certificate) object and pass cstPKCS11 as the [ssl_cert_store_type](#ssl_cert_store_type-property-googledrive-struct), the full path of the PKCS#11 DLL as the [ssl_cert_store](#ssl_cert_store-property-googledrive-struct), and the PIN as the [ssl_cert_store_password](#ssl_cert_store_password-property-googledrive-struct). Code Example. SSH Authentication with Security Key (without CertMgr): Alternatively, collect the necessary data using the [CertMgr](#CertMgr) struct by calling the [list_store_certificates](#CertMgr_m_ListStoreCertificates) method after setting the corresponding properties accordingly. The certificate information returned in the [on_cert_list](#CertMgr_e_CertList) event's CertEncoded parameter may be saved for later use. When using a certificate obtained with this approach, pass the previously saved security key information as the [ssl_cert_store](#ssl_cert_store-property-googledrive-struct) and set [ssl_cert_store_password](#ssl_cert_store_password-property-googledrive-struct) to the PIN. Code Example. SSH Authentication with Security Key (with CertMgr): |
| 99 (cstAuto) | The store type is automatically detected from the input data. This setting may be used with both public and private keys and can detect any of the supported formats automatically. |

## Data Type

i32

# ssl_cert_subject_alt_names property ([GoogleDrive](#struct-cloudstoragegoogledrive) Struct)

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

## Syntax

*Rust Syntax*

```text
fn ssl_cert_subject_alt_names(&self ) -> Result<String, CloudStorageError>
```

## Default Value

""

## Remarks

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

This property is read-only.

## Data Type

String

# ssl_cert_thumbprint_md5 property ([GoogleDrive](#struct-cloudstoragegoogledrive) Struct)

The MD5 hash of the certificate.

## Syntax

*Rust Syntax*

```text
fn ssl_cert_thumbprint_md5(&self ) -> Result<String, CloudStorageError>
```

## 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

# ssl_cert_thumbprint_sha1 property ([GoogleDrive](#struct-cloudstoragegoogledrive) Struct)

The SHA-1 hash of the certificate.

## Syntax

*Rust Syntax*

```text
fn ssl_cert_thumbprint_sha1(&self ) -> Result<String, CloudStorageError>
```

## 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

# ssl_cert_thumbprint_sha256 property ([GoogleDrive](#struct-cloudstoragegoogledrive) Struct)

The SHA-256 hash of the certificate.

## Syntax

*Rust Syntax*

```text
fn ssl_cert_thumbprint_sha256(&self ) -> Result<String, CloudStorageError>
```

## 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

# ssl_cert_usage property ([GoogleDrive](#struct-cloudstoragegoogledrive) Struct)

The text description of UsageFlags .

## Syntax

*Rust Syntax*

```text
fn ssl_cert_usage(&self ) -> Result<String, CloudStorageError>
```

## Default Value

""

## Remarks

The text description of [ssl_cert_usage_flags](#ssl_cert_usage_flags-property-googledrive-struct).

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

# ssl_cert_usage_flags property ([GoogleDrive](#struct-cloudstoragegoogledrive) Struct)

The flags that show intended use for the certificate.

## Syntax

*Rust Syntax*

```text
fn ssl_cert_usage_flags(&self ) -> Result<i32, CloudStorageError>
```

## Default Value

0

## Remarks

The flags that show intended use for the certificate. The value of [ssl_cert_usage_flags](#ssl_cert_usage_flags-property-googledrive-struct) is a combination of the following flags:

|  |  |
| --- | --- |
| 0x80 | Digital Signature |
| 0x40 | Non-Repudiation |
| 0x20 | Key Encipherment |
| 0x10 | Data Encipherment |
| 0x08 | Key Agreement |
| 0x04 | Certificate Signing |
| 0x02 | CRL Signing |
| 0x01 | Encipher Only |

Please see the [ssl_cert_usage](#ssl_cert_usage-property-googledrive-struct) property for a text representation of [ssl_cert_usage_flags](#ssl_cert_usage_flags-property-googledrive-struct).

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

This property is read-only.

## Data Type

i32

# ssl_cert_version property ([GoogleDrive](#struct-cloudstoragegoogledrive) Struct)

The certificate's version number.

## Syntax

*Rust Syntax*

```text
fn ssl_cert_version(&self ) -> Result<String, CloudStorageError>
```

## 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

# ssl_cert_subject property ([GoogleDrive](#struct-cloudstoragegoogledrive) Struct)

The subject of the certificate used for client authentication.

## Syntax

*Rust Syntax*

```text
fn ssl_cert_subject(&self ) -> Result<String, CloudStorageError> fn set_ssl_cert_subject(&self, value : &str) ->  Option<CloudStorageError>
fn set_ssl_cert_subject_ref(&self, value : &String) ->  Option<CloudStorageError>
```

## 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=example@email.com". Common fields and their meanings are as follows:

| Field | Meaning |
| --- | --- |
| CN | Common Name. This is commonly a hostname like www.server.com. |
| O | Organization |
| OU | Organizational Unit |
| L | Locality |
| S | State |
| C | Country |
| E | Email Address |

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

## Data Type

String

# ssl_cert_encoded property ([GoogleDrive](#struct-cloudstoragegoogledrive) Struct)

The certificate (PEM/Base64 encoded).

## Syntax

*Rust Syntax*

```text
fn ssl_cert_encoded(&self ) -> Result<Vec<u8>, CloudStorageError> fn set_ssl_cert_encoded(&self, value : Vec<u8>) ->  Option<CloudStorageError>
fn set_ssl_cert_encoded_ref(&self, value : &[u8]) ->  Option<CloudStorageError>
```

## Default Value

""

## Remarks

The certificate (PEM/Base64 encoded). This property is used to assign a specific certificate. The [ssl_cert_store](#ssl_cert_store-property-googledrive-struct) and [ssl_cert_subject](#ssl_cert_subject-property-googledrive-struct) properties also may be used to specify a certificate.

When [ssl_cert_encoded](#ssl_cert_encoded-property-googledrive-struct) is set, a search is initiated in the current [ssl_cert_store](#ssl_cert_store-property-googledrive-struct) for the private key of the certificate. If the key is found, [ssl_cert_subject](#ssl_cert_subject-property-googledrive-struct) is updated to reflect the full subject of the selected certificate; otherwise, [ssl_cert_subject](#ssl_cert_subject-property-googledrive-struct) is set to an empty string.

## Data Type

Vec

# ssl_provider property ([GoogleDrive](#struct-cloudstoragegoogledrive) Struct)

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

## Syntax

*Rust Syntax*

```text
fn ssl_provider(&self ) -> Result<i32, CloudStorageError> fn set_ssl_provider(&self, value : i32) ->  Option<CloudStorageError>
```

## Possible Values

```text
0   // Automatic1   // Platform2   // Internal
```

## 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 struct 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:

|  |  |
| --- | --- |
| 0 (sslpAutomatic - default) | Automatically selects the appropriate implementation. |
| 1 (sslpPlatform) | Uses the platform/system implementation. |
| 2 (sslpInternal) | Uses the internal implementation. |

 **Additional Notes**

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

When Automatic is selected, on Windows, the struct will use the platform implementation. On Linux/macOS, the struct will use the internal implementation. When TLS 1.3 is enabled via [SSLEnabledProtocols](#SSLEnabledProtocols), the struct will always try and use the platform implementation. If the platform TLS 1.3 implementation is not available, the internal implementation will be used.

## Data Type

i32

# ssl_server_cert_effective_date property ([GoogleDrive](#struct-cloudstoragegoogledrive) Struct)

The date on which this certificate becomes valid.

## Syntax

*Rust Syntax*

```text
fn ssl_server_cert_effective_date(&self ) -> Result<String, CloudStorageError>
```

## 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

# ssl_server_cert_expiration_date property ([GoogleDrive](#struct-cloudstoragegoogledrive) Struct)

The date on which the certificate expires.

## Syntax

*Rust Syntax*

```text
fn ssl_server_cert_expiration_date(&self ) -> Result<String, CloudStorageError>
```

## 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

# ssl_server_cert_extended_key_usage property ([GoogleDrive](#struct-cloudstoragegoogledrive) Struct)

A comma-delimited list of extended key usage identifiers.

## Syntax

*Rust Syntax*

```text
fn ssl_server_cert_extended_key_usage(&self ) -> Result<String, CloudStorageError>
```

## 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

# ssl_server_cert_fingerprint property ([GoogleDrive](#struct-cloudstoragegoogledrive) Struct)

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

## Syntax

*Rust Syntax*

```text
fn ssl_server_cert_fingerprint(&self ) -> Result<String, CloudStorageError>
```

## 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

# ssl_server_cert_fingerprint_sha1 property ([GoogleDrive](#struct-cloudstoragegoogledrive) Struct)

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

## Syntax

*Rust Syntax*

```text
fn ssl_server_cert_fingerprint_sha1(&self ) -> Result<String, CloudStorageError>
```

## 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

# ssl_server_cert_fingerprint_sha256 property ([GoogleDrive](#struct-cloudstoragegoogledrive) Struct)

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

## Syntax

*Rust Syntax*

```text
fn ssl_server_cert_fingerprint_sha256(&self ) -> Result<String, CloudStorageError>
```

## 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

# ssl_server_cert_issuer property ([GoogleDrive](#struct-cloudstoragegoogledrive) Struct)

The issuer of the certificate.

## Syntax

*Rust Syntax*

```text
fn ssl_server_cert_issuer(&self ) -> Result<String, CloudStorageError>
```

## 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

# ssl_server_cert_private_key property ([GoogleDrive](#struct-cloudstoragegoogledrive) Struct)

The private key of the certificate (if available).

## Syntax

*Rust Syntax*

```text
fn ssl_server_cert_private_key(&self ) -> Result<String, CloudStorageError>
```

## Default Value

""

## Remarks

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

NOTE: The [ssl_server_cert_private_key](#ssl_server_cert_private_key-property-googledrive-struct) may be available but not exportable. In this case, [ssl_server_cert_private_key](#ssl_server_cert_private_key-property-googledrive-struct) returns an empty string.

This property is read-only.

## Data Type

String

# ssl_server_cert_private_key_available property ([GoogleDrive](#struct-cloudstoragegoogledrive) Struct)

Whether a PrivateKey is available for the selected certificate.

## Syntax

*Rust Syntax*

```text
fn ssl_server_cert_private_key_available(&self ) -> Result<bool, CloudStorageError>
```

## Default Value

false

## Remarks

Whether a [ssl_server_cert_private_key](#ssl_server_cert_private_key-property-googledrive-struct) is available for the selected certificate. If [ssl_server_cert_private_key_available](#ssl_server_cert_private_key_available-property-googledrive-struct) is True, the certificate may be used for authentication purposes (e.g., server authentication).

This property is read-only.

## Data Type

bool

# ssl_server_cert_private_key_container property ([GoogleDrive](#struct-cloudstoragegoogledrive) Struct)

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

## Syntax

*Rust Syntax*

```text
fn ssl_server_cert_private_key_container(&self ) -> Result<String, CloudStorageError>
```

## Default Value

""

## Remarks

The name of the [ssl_server_cert_private_key](#ssl_server_cert_private_key-property-googledrive-struct) container for the certificate (if available). This functionality is available only on Windows platforms.

This property is read-only.

## Data Type

String

# ssl_server_cert_public_key property ([GoogleDrive](#struct-cloudstoragegoogledrive) Struct)

The public key of the certificate.

## Syntax

*Rust Syntax*

```text
fn ssl_server_cert_public_key(&self ) -> Result<String, CloudStorageError>
```

## 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

# ssl_server_cert_public_key_algorithm property ([GoogleDrive](#struct-cloudstoragegoogledrive) Struct)

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

## Syntax

*Rust Syntax*

```text
fn ssl_server_cert_public_key_algorithm(&self ) -> Result<String, CloudStorageError>
```

## 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

# ssl_server_cert_public_key_length property ([GoogleDrive](#struct-cloudstoragegoogledrive) Struct)

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

## Syntax

*Rust Syntax*

```text
fn ssl_server_cert_public_key_length(&self ) -> Result<i32, CloudStorageError>
```

## 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

i32

# ssl_server_cert_serial_number property ([GoogleDrive](#struct-cloudstoragegoogledrive) Struct)

The serial number of the certificate encoded as a string.

## Syntax

*Rust Syntax*

```text
fn ssl_server_cert_serial_number(&self ) -> Result<String, CloudStorageError>
```

## 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

# ssl_server_cert_signature_algorithm property ([GoogleDrive](#struct-cloudstoragegoogledrive) Struct)

The text description of the certificate's signature algorithm.

## Syntax

*Rust Syntax*

```text
fn ssl_server_cert_signature_algorithm(&self ) -> Result<String, CloudStorageError>
```

## 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

# ssl_server_cert_store property ([GoogleDrive](#struct-cloudstoragegoogledrive) Struct)

The name of the certificate store for the client certificate.

## Syntax

*Rust Syntax*

```text
fn ssl_server_cert_store(&self ) -> Result<Vec<u8>, CloudStorageError>
```

## Default Value

"MY"

## Remarks

The name of the certificate store for the client certificate.

The [ssl_server_cert_store_type](#ssl_server_cert_store_type-property-googledrive-struct) property denotes the type of the certificate store specified by [ssl_server_cert_store](#ssl_server_cert_store-property-googledrive-struct). If the store is password-protected, specify the password in [ssl_server_cert_store_password](#ssl_server_cert_store_password-property-googledrive-struct).

[ssl_server_cert_store](#ssl_server_cert_store-property-googledrive-struct) is used in conjunction with the [ssl_server_cert_subject](#ssl_server_cert_subject-property-googledrive-struct) property to specify client certificates. If [ssl_server_cert_store](#ssl_server_cert_store-property-googledrive-struct) has a value, and [ssl_server_cert_subject](#ssl_server_cert_subject-property-googledrive-struct) or [ssl_server_cert_encoded](#ssl_server_cert_encoded-property-googledrive-struct) is set, a search for a certificate is initiated. Please see the [ssl_server_cert_subject](#ssl_server_cert_subject-property-googledrive-struct) property for details.

 Designations of certificate stores are platform dependent.

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

|  |  |
| --- | --- |
| MY | A certificate store holding personal certificates with their associated private keys. |
| CA | Certifying authority certificates. |
| ROOT | Root certificates. |

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).

This property is read-only.

## Data Type

Vec

# ssl_server_cert_store_password property ([GoogleDrive](#struct-cloudstoragegoogledrive) Struct)

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

## Syntax

*Rust Syntax*

```text
fn ssl_server_cert_store_password(&self ) -> Result<String, CloudStorageError>
```

## 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

# ssl_server_cert_store_type property ([GoogleDrive](#struct-cloudstoragegoogledrive) Struct)

The type of certificate store for this certificate.

## Syntax

*Rust Syntax*

```text
fn ssl_server_cert_store_type(&self ) -> Result<i32, CloudStorageError>
```

## Possible Values

```text
0   // User1   // Machine2   // PFXFile3   // PFXBlob4   // JKSFile5   // JKSBlob6   // PEMKeyFile7   // PEMKeyBlob8   // PublicKeyFile9   // PublicKeyBlob10   // SSHPublicKeyBlob11   // P7BFile12   // P7BBlob13   // SSHPublicKeyFile14   // PPKFile15   // PPKBlob16   // XMLFile17   // XMLBlob18   // JWKFile19   // JWKBlob20   // SecurityKey21   // BCFKSFile22   // BCFKSBlob23   // PKCS1199   // Auto
```

## Default Value

0

## Remarks

The type of certificate store for this certificate.

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

```csharp
sftp.SSHCert = new Certificate(CertStoreTypes.cstPKCS11,
                               @"C:\Program Files\OpenSC Project\OpenSC\pkcs11\opensc-pkcs11.dll",
                               "123456", // PIN
                               "CN=cert_subject");
sftp.SSHUser = "test";
sftp.SSHLogon("myhost", 22);
```

```csharp
certmgr.CertStoreType = CertStoreTypes.cstPKCS11;
certmgr.OnCertList += (s, e) => {
  secKeyBlob = e.CertEncoded;
};
certmgr.CertStore = @"C:\Program Files\OpenSC Project\OpenSC\pkcs11\opensc-pkcs11.dll";
certmgr.CertStorePassword = "123456"; // PIN
certmgr.ListStoreCertificates();

sftp.SSHCert = new Certificate(CertStoreTypes.cstPKCS11, secKeyBlob, "123456", "*");
sftp.SSHUser = "test";
sftp.SSHLogon("myhost", 22);
```

|  |  |
| --- | --- |
| 0 (cstUser - default) | For Windows, this specifies that the certificate store is a certificate store owned by the current user. NOTE: This store type is not available in Java. |
| 1 (cstMachine) | For Windows, this specifies that the certificate store is a machine store. NOTE: This store type is not available in Java. |
| 2 (cstPFXFile) | The certificate store is the name of a PFX (PKCS#12) file containing certificates. |
| 3 (cstPFXBlob) | The certificate store is a string (binary or Base64-encoded) representing a certificate store in PFX (PKCS#12) format. |
| 4 (cstJKSFile) | The certificate store is the name of a Java Key Store (JKS) file containing certificates. NOTE: This store type is only available in Java. |
| 5 (cstJKSBlob) | The certificate store is a string (binary or Base64-encoded) representing a certificate store in Java Key Store (JKS) format. NOTE: This store type is only available in Java. |
| 6 (cstPEMKeyFile) | The certificate store is the name of a PEM-encoded file that contains a private key and an optional certificate. |
| 7 (cstPEMKeyBlob) | The certificate store is a string (binary or Base64-encoded) that contains a private key and an optional certificate. |
| 8 (cstPublicKeyFile) | The certificate store is the name of a file that contains a PEM- or DER-encoded public key certificate. |
| 9 (cstPublicKeyBlob) | The certificate store is a string (binary or Base64-encoded) that contains a PEM- or DER-encoded public key certificate. |
| 10 (cstSSHPublicKeyBlob) | The certificate store is a string (binary or Base64-encoded) that contains an SSH-style public key. |
| 11 (cstP7BFile) | The certificate store is the name of a PKCS#7 file containing certificates. |
| 12 (cstP7BBlob) | The certificate store is a string (binary) representing a certificate store in PKCS#7 format. |
| 13 (cstSSHPublicKeyFile) | The certificate store is the name of a file that contains an SSH-style public key. |
| 14 (cstPPKFile) | The certificate store is the name of a file that contains a PPK (PuTTY Private Key). |
| 15 (cstPPKBlob) | The certificate store is a string (binary) that contains a PPK (PuTTY Private Key). |
| 16 (cstXMLFile) | The certificate store is the name of a file that contains a certificate in XML format. |
| 17 (cstXMLBlob) | The certificate store is a string that contains a certificate in XML format. |
| 18 (cstJWKFile) | The certificate store is the name of a file that contains a JWK (JSON Web Key). |
| 19 (cstJWKBlob) | The certificate store is a string that contains a JWK (JSON Web Key). |
| 21 (cstBCFKSFile) | The certificate store is the name of a file that contains a BCFKS (Bouncy Castle FIPS Key Store). NOTE: This store type is only available in Java and .NET. |
| 22 (cstBCFKSBlob) | The certificate store is a string (binary or Base64-encoded) representing a certificate store in BCFKS (Bouncy Castle FIPS Key Store) format. NOTE: This store type is only available in Java and .NET. |
| 23 (cstPKCS11) | The certificate is present on a physical security key accessible via a PKCS#11 interface. To use a security key, create a new [Certificate](#Type_Certificate) object and pass cstPKCS11 as the [ssl_server_cert_store_type](#ssl_server_cert_store_type-property-googledrive-struct), the full path of the PKCS#11 DLL as the [ssl_server_cert_store](#ssl_server_cert_store-property-googledrive-struct), and the PIN as the [ssl_server_cert_store_password](#ssl_server_cert_store_password-property-googledrive-struct). Code Example. SSH Authentication with Security Key (without CertMgr): Alternatively, collect the necessary data using the [CertMgr](#CertMgr) struct by calling the [list_store_certificates](#CertMgr_m_ListStoreCertificates) method after setting the corresponding properties accordingly. The certificate information returned in the [on_cert_list](#CertMgr_e_CertList) event's CertEncoded parameter may be saved for later use. When using a certificate obtained with this approach, pass the previously saved security key information as the [ssl_server_cert_store](#ssl_server_cert_store-property-googledrive-struct) and set [ssl_server_cert_store_password](#ssl_server_cert_store_password-property-googledrive-struct) to the PIN. Code Example. SSH Authentication with Security Key (with CertMgr): |
| 99 (cstAuto) | The store type is automatically detected from the input data. This setting may be used with both public and private keys and can detect any of the supported formats automatically. |

This property is read-only.

## Data Type

i32

# ssl_server_cert_subject_alt_names property ([GoogleDrive](#struct-cloudstoragegoogledrive) Struct)

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

## Syntax

*Rust Syntax*

```text
fn ssl_server_cert_subject_alt_names(&self ) -> Result<String, CloudStorageError>
```

## Default Value

""

## Remarks

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

This property is read-only.

## Data Type

String

# ssl_server_cert_thumbprint_md5 property ([GoogleDrive](#struct-cloudstoragegoogledrive) Struct)

The MD5 hash of the certificate.

## Syntax

*Rust Syntax*

```text
fn ssl_server_cert_thumbprint_md5(&self ) -> Result<String, CloudStorageError>
```

## 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

# ssl_server_cert_thumbprint_sha1 property ([GoogleDrive](#struct-cloudstoragegoogledrive) Struct)

The SHA-1 hash of the certificate.

## Syntax

*Rust Syntax*

```text
fn ssl_server_cert_thumbprint_sha1(&self ) -> Result<String, CloudStorageError>
```

## 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

# ssl_server_cert_thumbprint_sha256 property ([GoogleDrive](#struct-cloudstoragegoogledrive) Struct)

The SHA-256 hash of the certificate.

## Syntax

*Rust Syntax*

```text
fn ssl_server_cert_thumbprint_sha256(&self ) -> Result<String, CloudStorageError>
```

## 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

# ssl_server_cert_usage property ([GoogleDrive](#struct-cloudstoragegoogledrive) Struct)

The text description of UsageFlags .

## Syntax

*Rust Syntax*

```text
fn ssl_server_cert_usage(&self ) -> Result<String, CloudStorageError>
```

## Default Value

""

## Remarks

The text description of [ssl_server_cert_usage_flags](#ssl_server_cert_usage_flags-property-googledrive-struct).

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

# ssl_server_cert_usage_flags property ([GoogleDrive](#struct-cloudstoragegoogledrive) Struct)

The flags that show intended use for the certificate.

## Syntax

*Rust Syntax*

```text
fn ssl_server_cert_usage_flags(&self ) -> Result<i32, CloudStorageError>
```

## Default Value

0

## Remarks

The flags that show intended use for the certificate. The value of [ssl_server_cert_usage_flags](#ssl_server_cert_usage_flags-property-googledrive-struct) is a combination of the following flags:

|  |  |
| --- | --- |
| 0x80 | Digital Signature |
| 0x40 | Non-Repudiation |
| 0x20 | Key Encipherment |
| 0x10 | Data Encipherment |
| 0x08 | Key Agreement |
| 0x04 | Certificate Signing |
| 0x02 | CRL Signing |
| 0x01 | Encipher Only |

Please see the [ssl_server_cert_usage](#ssl_server_cert_usage-property-googledrive-struct) property for a text representation of [ssl_server_cert_usage_flags](#ssl_server_cert_usage_flags-property-googledrive-struct).

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

This property is read-only.

## Data Type

i32

# ssl_server_cert_version property ([GoogleDrive](#struct-cloudstoragegoogledrive) Struct)

The certificate's version number.

## Syntax

*Rust Syntax*

```text
fn ssl_server_cert_version(&self ) -> Result<String, CloudStorageError>
```

## 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

# ssl_server_cert_subject property ([GoogleDrive](#struct-cloudstoragegoogledrive) Struct)

The subject of the certificate used for client authentication.

## Syntax

*Rust Syntax*

```text
fn ssl_server_cert_subject(&self ) -> Result<String, CloudStorageError>
```

## 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=example@email.com". Common fields and their meanings are as follows:

| Field | Meaning |
| --- | --- |
| CN | Common Name. This is commonly a hostname like www.server.com. |
| O | Organization |
| OU | Organizational Unit |
| L | Locality |
| S | State |
| C | Country |
| E | Email Address |

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

This property is read-only.

## Data Type

String

# ssl_server_cert_encoded property ([GoogleDrive](#struct-cloudstoragegoogledrive) Struct)

The certificate (PEM/Base64 encoded).

## Syntax

*Rust Syntax*

```text
fn ssl_server_cert_encoded(&self ) -> Result<Vec<u8>, CloudStorageError>
```

## Default Value

""

## Remarks

The certificate (PEM/Base64 encoded). This property is used to assign a specific certificate. The [ssl_server_cert_store](#ssl_server_cert_store-property-googledrive-struct) and [ssl_server_cert_subject](#ssl_server_cert_subject-property-googledrive-struct) properties also may be used to specify a certificate.

When [ssl_server_cert_encoded](#ssl_server_cert_encoded-property-googledrive-struct) is set, a search is initiated in the current [ssl_server_cert_store](#ssl_server_cert_store-property-googledrive-struct) for the private key of the certificate. If the key is found, [ssl_server_cert_subject](#ssl_server_cert_subject-property-googledrive-struct) is updated to reflect the full subject of the selected certificate; otherwise, [ssl_server_cert_subject](#ssl_server_cert_subject-property-googledrive-struct) is set to an empty string.

This property is read-only.

## Data Type

Vec

# start_byte property ([GoogleDrive](#struct-cloudstoragegoogledrive) Struct)

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

## Syntax

*Rust Syntax*

```text
fn start_byte(&self ) -> Result<i64, CloudStorageError> fn set_start_byte(&self, value : i64) ->  Option<CloudStorageError>
```

## 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 [upload_file](#upload_file-method-googledrive-struct) and [download_file](#download_file-method-googledrive-struct) for details about resuming uploads and downloads.

## Data Type

i64

# timeout property ([GoogleDrive](#struct-cloudstoragegoogledrive) Struct)

The timeout for the struct.

## Syntax

*Rust Syntax*

```text
fn timeout(&self ) -> Result<i32, CloudStorageError> fn set_timeout(&self, value : i32) ->  Option<CloudStorageError>
```

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

The struct will use do_events 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 struct 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

i32

# use_resumable_upload property ([GoogleDrive](#struct-cloudstoragegoogledrive) Struct)

Whether to use resumable uploads.

## Syntax

*Rust Syntax*

```text
fn use_resumable_upload(&self ) -> Result<bool, CloudStorageError> fn set_use_resumable_upload(&self, value : bool) ->  Option<CloudStorageError>
```

## Default Value

false

## Remarks

This property controls whether simple or resumable uploads are used when [upload_file](#upload_file-method-googledrive-struct) is called. The default value is *false* (simple uploads are used).

Refer to [upload_file](#upload_file-method-googledrive-struct) for more information.

## Data Type

bool

# add_parents method ([GoogleDrive](#struct-cloudstoragegoogledrive) Struct)

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

## Syntax

*Rust Syntax*

```text
fn add_parents(&self, resource_id : &str, parent_ids : &str) -> Result<(), CloudStorageError>
```

## 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.

# add_query_param method ([GoogleDrive](#struct-cloudstoragegoogledrive) Struct)

Adds a query parameter to the QueryParams properties.

## Syntax

*Rust Syntax*

```text
fn add_query_param(&self, name : &str, value : &str) -> Result<(), CloudStorageError>
```

## Remarks

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

All specified *Value*s will be URL encoded by the struct automatically. Consult the service documentation for details on the available parameters.

# add_shared_drive_member method ([GoogleDrive](#struct-cloudstoragegoogledrive) Struct)

Creates a new shared drive member.

## Syntax

*Rust Syntax*

```text
fn add_shared_drive_member(&self, shared_drive_id : &str, role : i32, permission_type : i32, email : &str) ->  Result<String, CloudStorageError>
```

## 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:

|  |  |
| --- | --- |
| prReader (0) | Read-only permissions. |
| prCommenter (1) | Read-only plus commenting permissions. |
| prWriter (2) | Read, write, and comment permissions. |
| prFileOrganizer (4) | Writer permissions, plus the ability to move and trash resources. |
| prOrganizer (5) | File organizer permissions, plus the ability to permanently delete resources from, and rename/delete/alter the membership of, a shared drive. |

*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 [update_permissions](#update_permissions-method-googledrive-struct) for more information about how permissions work in general, how permissions relate to shared drive members, and how to manipulate multiple members at once.

```text
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](#struct-cloudstoragegoogledrive) Struct)

Get the authorization string required to access the protected resource.

## Syntax

*Rust Syntax*

```text
fn authorize(&self) -> Result<(), CloudStorageError>
```

## 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 [o_auth_client_profile](#o_auth_client_profile-property-googledrive-struct) property and the [o_auth_grant_type](#o_auth_grant_type-property-googledrive-struct) property. This method is **not** to be used in conjunction with the [authorization](#authorization-property-googledrive-struct) property. It should instead be used when setting the o_auth property.

For more information, see the introduction section.

# config method ([GoogleDrive](#struct-cloudstoragegoogledrive) Struct)

Sets or retrieves a configuration setting.

## Syntax

*Rust Syntax*

```text
fn config(&self, configuration_string : &str) ->  Result<String, CloudStorageError>
```

## Remarks

config is a generic method available in every struct. It is used to set and retrieve [configuration settings](#config-settings-googledrive-struct) for the struct.

These settings are similar in functionality to properties, but they are rarely used. In order to avoid "polluting" the property namespace of the struct, 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](#config-settings-googledrive-struct), you must call *Config("PROPERTY")*. The value will be returned as a string.

# copy_resource method ([GoogleDrive](#struct-cloudstoragegoogledrive) Struct)

Copies a file.

## Syntax

*Rust Syntax*

```text
fn copy_resource(&self, resource_id : &str, new_name : &str, parent_ids : &str) ->  Result<String, CloudStorageError>
```

## 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.

# create_folder method ([GoogleDrive](#struct-cloudstoragegoogledrive) Struct)

Creates a new folder.

## Syntax

*Rust Syntax*

```text
fn create_folder(&self, name : &str, parent_ids : &str) ->  Result<String, CloudStorageError>
```

## 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](#IncludeFolderProperties) configuration setting is *true* when this method is called, the struct 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 [resource_access_type](#GoogleDrive_p_ResourceAccessType) 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 [list_resources](#list_resources-method-googledrive-struct), [delete_resource](#delete_resource-method-googledrive-struct), and [update_resource](#update_resource-method-googledrive-struct) methods.

# create_shared_drive method ([GoogleDrive](#struct-cloudstoragegoogledrive) Struct)

Creates a new shared drive.

## Syntax

*Rust Syntax*

```text
fn create_shared_drive(&self, name : &str, request_id : &str) ->  Result<String, CloudStorageError>
```

## 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*.)

# delete_resource method ([GoogleDrive](#struct-cloudstoragegoogledrive) Struct)

Deletes the specified file or folder permanently.

## Syntax

*Rust Syntax*

```text
fn delete_resource(&self, resource_id : &str) -> Result<(), CloudStorageError>
```

## 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 [trash_resource](#trash_resource-method-googledrive-struct) to move files or folders to the trash.

# delete_shared_drive method ([GoogleDrive](#struct-cloudstoragegoogledrive) Struct)

Deletes a shared drive.

## Syntax

*Rust Syntax*

```text
fn delete_shared_drive(&self, shared_drive_id : &str) -> Result<(), CloudStorageError>
```

## 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).

# download_file method ([GoogleDrive](#struct-cloudstoragegoogledrive) Struct)

Downloads, and optionally converts, a file.

## Syntax

*Rust Syntax*

```text
fn download_file(&self, resource_id : &str, mime_type : &str) -> Result<(), CloudStorageError>
```

## Remarks

This method downloads the file specified by *ResourceId*.

 If [local_file](#local_file-property-googledrive-struct) is set, the file will be saved to the specified location; otherwise, the file data will be held by [resource_data](#resource_data-property-googledrive-struct).

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.

| Google Format | Download Format | MIME Type |
| --- | --- | --- |
| Google Docs | HTML | text/html |
|  | Plain text | text/plain |
|  | Rich text | application/rtf |
|  | Open Office document | application/vnd.oasis.opendocument.text |
|  | PDF | application/pdf |
|  | MS Word | application/vnd.openxmlformats-officedocument.wordprocessingml.document |
| Google Sheets | MS Excel | application/vnd.openxmlformats-officedocument.spreadsheetml.sheet |
|  | Open Office sheet | application/x-vnd.oasis.opendocument.spreadsheet |
|  | PDF | application/pdf |
|  | CSV (first sheet only) | text/csv |
| Google Drawing | JPEG | image/jpeg |
|  | PNG | image/png |
|  | SVG | image/svg+xml |
|  | PDF | image/pdf |
| Google Slides | MS Powerpoint | application/vnd.openxmlformats-officedocument.presentationml.presentation |
|  | PDF | application/pdf |
|  | Plain text | text/plain |
| Google App Scripts | JSON | application/vnd.google-apps.script+json |

### Download Notes

 **Downloading an Encrypted File**

To decrypt an encrypted file set [encryption_algorithm](#encryption_algorithm-property-googledrive-struct) and [encryption_password](#encryption_password-property-googledrive-struct) before calling this method.

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

**Resuming Downloads**

The struct also supports resuming failed downloads by using the [start_byte](#start_byte-property-googledrive-struct) property. If a download is interrupted, set [start_byte](#start_byte-property-googledrive-struct) to the appropriate offset before calling this method to resume the download.

```text
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 [local_file](#local_file-property-googledrive-struct) was set in the initial download attempt.

If [local_file](#local_file-property-googledrive-struct) is set when beginning an encrypted download, the struct creates a temporary file in [TempPath](#TempPath) to hold the encrypted data until the download is complete. If the download is interrupted, [DownloadTempFile](#DownloadTempFile) will be populated with the path of the temporary file that holds the partial data.

To resume, [DownloadTempFile](#DownloadTempFile) must be populated, along with [start_byte](#start_byte-property-googledrive-struct), to allow the remainder of the encrypted data to be downloaded. Once the encrypted data is downloaded it will be decrypted and written to [local_file](#local_file-property-googledrive-struct).

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

# empty_trash method ([GoogleDrive](#struct-cloudstoragegoogledrive) Struct)

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

## Syntax

*Rust Syntax*

```text
fn empty_trash(&self) -> Result<(), CloudStorageError>
```

## 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!**

# get_account_info method ([GoogleDrive](#struct-cloudstoragegoogledrive) Struct)

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

## Syntax

*Rust Syntax*

```text
fn get_account_info(&self) -> Result<(), CloudStorageError>
```

## Remarks

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

# get_current_change_marker method ([GoogleDrive](#struct-cloudstoragegoogledrive) Struct)

Gets the most current change marker.

## Syntax

*Rust Syntax*

```text
fn get_current_change_marker(&self) -> Result<(), CloudStorageError>
```

## Remarks

This method populates [next_change_marker](#next_change_marker-property-googledrive-struct) with the most current change marker available.

Refer to [list_changes](#list_changes-method-googledrive-struct) for more information.

If [shared_drive](#shared_drive-property-googledrive-struct) is set, this method will get the most current change marker available for that shared drive's changes.

# get_permission_info method ([GoogleDrive](#struct-cloudstoragegoogledrive) Struct)

Gets information about a specific permission.

## Syntax

*Rust Syntax*

```text
fn get_permission_info(&self, resource_id : &str, permission_id : &str) -> Result<(), CloudStorageError>
```

## 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 [on_permission_list](#on_permission_list-event-googledrive-struct) event, and will populate the permissions properties (clearing any previously-held items in the process).

### Shared Drive Members

 Refer to [update_permissions](#update_permissions-method-googledrive-struct) for more information about how permissions work in general, how permissions relate to shared drive members, and how to manipulate multiple members at once.

# get_resource_info method ([GoogleDrive](#struct-cloudstoragegoogledrive) Struct)

Gets information about specific files and folders.

## Syntax

*Rust Syntax*

```text
fn get_resource_info(&self, resource_ids : &str) -> Result<(), CloudStorageError>
```

## 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 [on_resource_list](#on_resource_list-event-googledrive-struct) event once for each resource, and will populate the resources properties (clearing any previously-held items in the process).

Note that, unlike the [list_resources](#list_resources-method-googledrive-struct) and [list_children](#list_children-method-googledrive-struct) 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.

# get_shared_drive_info method ([GoogleDrive](#struct-cloudstoragegoogledrive) Struct)

Gets information about a specific shared drive.

## Syntax

*Rust Syntax*

```text
fn get_shared_drive_info(&self, shared_drive_id : &str) -> Result<(), CloudStorageError>
```

## Remarks

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

Calling this method will fire the [on_shared_drive_list](#on_shared_drive_list-event-googledrive-struct) event, and will populate the shared_drives properties (clearing any previously-held items in the process).

# get_upload_status method ([GoogleDrive](#struct-cloudstoragegoogledrive) Struct)

Gets the status of a resumable upload session.

## Syntax

*Rust Syntax*

```text
fn get_upload_status(&self) -> Result<(), CloudStorageError>
```

## Remarks

This method gets the status of a resumable upload session. Set [resume_url](#resume_url-property-googledrive-struct) before calling this method. After calling this method [start_byte](#start_byte-property-googledrive-struct) will be populated.

# interrupt method ([GoogleDrive](#struct-cloudstoragegoogledrive) Struct)

This method interrupts the current method.

## Syntax

*Rust Syntax*

```text
fn interrupt(&self) -> Result<(), CloudStorageError>
```

## Remarks

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

# list_changes method ([GoogleDrive](#struct-cloudstoragegoogledrive) Struct)

Lists changes to resources and shared drives.

## Syntax

*Rust Syntax*

```text
fn list_changes(&self) -> Result<(), CloudStorageError>
```

## 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 [change_marker](#change_marker-property-googledrive-struct) or [next_change_marker](#next_change_marker-property-googledrive-struct) (only one can be populated at a time) to request the next page of changes. This method causes the [on_change_list](#on_change_list-event-googledrive-struct) 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 [change_marker](#change_marker-property-googledrive-struct) property will be populated. Continue to call this method until [change_marker](#change_marker-property-googledrive-struct) is empty to accumulate all pages of results in the changes properties. (Once there aren't any more changes available to list, the [next_change_marker](#next_change_marker-property-googledrive-struct) property will be populated instead.) Alternatively, the [AccumulatePages](#AccumulatePages) configuration setting can be disabled to clear the changes properties every time a page of results is returned.

Calling [get_current_change_marker](#get_current_change_marker-method-googledrive-struct) will immediately populate [next_change_marker](#next_change_marker-property-googledrive-struct). Regardless of whether it is populated because of a call to [get_current_change_marker](#get_current_change_marker-method-googledrive-struct) or to list_changes, [next_change_marker](#next_change_marker-property-googledrive-struct) 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 list_changes immediately after [next_change_marker](#next_change_marker-property-googledrive-struct) is populated will not return any further changes.)

Setting [change_marker](#change_marker-property-googledrive-struct) to "1" will cause list_changes to list changes beginning with the very first change available.

**Example of Listing Changes**

```csharp
// 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 [shared_drive](#shared_drive-property-googledrive-struct) 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 [shared_drive](#shared_drive-property-googledrive-struct) 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 [change_type](#change_type-property-googledrive-struct) will reflect whether it is associated with a file or folder (0), or a shared drive itself (1).

# list_children method ([GoogleDrive](#struct-cloudstoragegoogledrive) Struct)

Lists the child resources of one or more folders.

## Syntax

*Rust Syntax*

```text
fn list_children(&self, folder_ids : &str) -> Result<(), CloudStorageError>
```

## Remarks

This is a convenience method that works the same way as [list_resources](#list_resources-method-googledrive-struct), 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 [on_resource_list](#on_resource_list-event-googledrive-struct) 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 [child_marker](#child_marker-property-googledrive-struct) property will be populated. Continue to call this method until [child_marker](#child_marker-property-googledrive-struct) is empty to accumulate all pages of results in the children properties. Alternatively, the [AccumulatePages](#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 [list_resources](#list_resources-method-googledrive-struct) for more information about how listing resources works in general, everything there applies to this method too.

```text
// 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));
```

# list_parents method ([GoogleDrive](#struct-cloudstoragegoogledrive) Struct)

Lists the parent folders of a file or folder.

## Syntax

*Rust Syntax*

```text
fn list_parents(&self, resource_id : &str) -> Result<(), CloudStorageError>
```

## Remarks

This is a convenience method that simply retrieves the parent Ids of the file or folder specified by *ResourceId* and passes them to [get_resource_info](#get_resource_info-method-googledrive-struct).

Refer to [get_resource_info](#get_resource_info-method-googledrive-struct) for more information.

# list_permissions method ([GoogleDrive](#struct-cloudstoragegoogledrive) Struct)

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

## Syntax

*Rust Syntax*

```text
fn list_permissions(&self, resource_id : &str) -> Result<(), CloudStorageError>
```

## Remarks

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

Calling this method will fire the [on_permission_list](#on_permission_list-event-googledrive-struct) 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 [permission_marker](#permission_marker-property-googledrive-struct) property will be populated. Continue to call this method until [permission_marker](#permission_marker-property-googledrive-struct) is empty to accumulate all pages of results in the permissions properties. Alternatively, the [AccumulatePages](#AccumulatePages) configuration setting can be disabled to clear the permissions properties every time a page of results is returned.

```text
// 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 [update_permissions](#update_permissions-method-googledrive-struct) 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 [list_shared_drives](#list_shared_drives-method-googledrive-struct) instead and inspect the [shared_drive_capabilities](#shared_drive_capabilities-property-googledrive-struct) property of the returned items.

# list_resources method ([GoogleDrive](#struct-cloudstoragegoogledrive) Struct)

Lists files and folders.

## Syntax

*Rust Syntax*

```text
fn list_resources(&self) -> Result<(), CloudStorageError>
```

## Remarks

This method is used to list file and folders. Calling this method will fire the [on_resource_list](#on_resource_list-event-googledrive-struct) 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 [resource_marker](#resource_marker-property-googledrive-struct) property will be populated. Continue to call this method until [resource_marker](#resource_marker-property-googledrive-struct) is empty to accumulate all pages of results in the resources properties. Alternatively, the [AccumulatePages](#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 [list_resources_scope](#list_resources_scope-property-googledrive-struct) property will be returned. The [ListResourcesMode](#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 [list_children](#list_children-method-googledrive-struct) or [list_parents](#list_parents-method-googledrive-struct). To retrieve information about specific resources, use [get_resource_info](#get_resource_info-method-googledrive-struct).

For more complex queries, refer to the Google Drive API documentation for information on how to construct a search query, then use the [add_query_param](#add_query_param-method-googledrive-struct) method to add a query parameter named *"q"* to the query_params 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 list_resources is called with [list_resources_scope](#list_resources_scope-property-googledrive-struct) 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 [list_resources_scope](#list_resources_scope-property-googledrive-struct) 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 [list_resources_scope](#list_resources_scope-property-googledrive-struct) is set to *lrsUser (0)*, but *would* show up when it is set to *lrsDomain (1)*.)

When [list_resources_scope](#list_resources_scope-property-googledrive-struct) is set to *lrsSharedDrive (2)*, the [shared_drive](#shared_drive-property-googledrive-struct) 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 [list_resources_scope](#list_resources_scope-property-googledrive-struct) 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](#SearchIncomplete) configuration setting after calling list_resources; 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 [update_permissions](#update_permissions-method-googledrive-struct), [add_shared_drive_member](#add_shared_drive_member-method-googledrive-struct), [update_shared_drive_member](#update_shared_drive_member-method-googledrive-struct), and [remove_shared_drive_member](#remove_shared_drive_member-method-googledrive-struct) for more information.

```text
// 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));
```

# list_revisions method ([GoogleDrive](#struct-cloudstoragegoogledrive) Struct)

List the revisions of a file.

## Syntax

*Rust Syntax*

```text
fn list_revisions(&self, file_id : &str) -> Result<(), CloudStorageError>
```

## Remarks

This method will list the revisions of the specified file. Calling this method will fire the [on_resource_list](#on_resource_list-event-googledrive-struct) 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](#RevisionId) configuration setting, the following methods can be used to interact with the specific revision:

- [delete_resource](#delete_resource-method-googledrive-struct)
- [download_file](#download_file-method-googledrive-struct)
- [get_resource_info](#get_resource_info-method-googledrive-struct)
- [update_resource](#update_resource-method-googledrive-struct)

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

# list_shared_drives method ([GoogleDrive](#struct-cloudstoragegoogledrive) Struct)

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

## Syntax

*Rust Syntax*

```text
fn list_shared_drives(&self) -> Result<(), CloudStorageError>
```

## Remarks

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

Calling this method will fire the [on_shared_drive_list](#on_shared_drive_list-event-googledrive-struct) event once for each shared drive, and will also populate the shared_drives properties.

If there are still more shared drives available to list when this method returns, the [shared_drive_marker](#shared_drive_marker-property-googledrive-struct) property will be populated. Continue to call this method until [shared_drive_marker](#shared_drive_marker-property-googledrive-struct) is empty to accumulate all pages of results in the shared_drives properties. Alternatively, the [AccumulatePages](#AccumulatePages) configuration setting can be disabled to clear the shared_drives properties every time a page of results is returned.

```text
// 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));
```

# move_resource method ([GoogleDrive](#struct-cloudstoragegoogledrive) Struct)

Moves a file or folder.

## Syntax

*Rust Syntax*

```text
fn move_resource(&self, resource_id : &str, new_parent_ids : &str) -> Result<(), CloudStorageError>
```

## 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 [add_parents](#add_parents-method-googledrive-struct) 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.

# remove_parents method ([GoogleDrive](#struct-cloudstoragegoogledrive) Struct)

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

## Syntax

*Rust Syntax*

```text
fn remove_parents(&self, resource_id : &str, parent_ids : &str) -> Result<(), CloudStorageError>
```

## 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.

# remove_shared_drive_member method ([GoogleDrive](#struct-cloudstoragegoogledrive) Struct)

Removes an existing shared drive member.

## Syntax

*Rust Syntax*

```text
fn remove_shared_drive_member(&self, shared_drive_id : &str, permission_id : &str) -> Result<(), CloudStorageError>
```

## 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 [update_permissions](#update_permissions-method-googledrive-struct) for more information about how permissions work in general, how permissions relate to shared drive members, and how to manipulate multiple members at once.

```text
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](#struct-cloudstoragegoogledrive) Struct)

Resets the struct to its initial state.

## Syntax

*Rust Syntax*

```text
fn reset(&self) -> Result<(), CloudStorageError>
```

## Remarks

This method resets the struct to its initial state.

# restore_resource method ([GoogleDrive](#struct-cloudstoragegoogledrive) Struct)

Restores a file or folder from the trash.

## Syntax

*Rust Syntax*

```text
fn restore_resource(&self, resource_id : &str) -> Result<(), CloudStorageError>
```

## Remarks

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

# send_custom_request method ([GoogleDrive](#struct-cloudstoragegoogledrive) Struct)

Sends a custom request to the Google Drive API.

## Syntax

*Rust Syntax*

```text
fn send_custom_request(&self, http_method : &str, request_path : &str, request_body : &str) -> Result<(), CloudStorageError>
```

## 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 struct 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 query_params 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](#authorization-property-googledrive-struct) and [other_headers](#other_headers-property-googledrive-struct), and the given *RequestBody* (if non-empty).
3. Stores the response headers in the parsed_headers properties, and the response body in the specified [local_file](#local_file-property-googledrive-struct), or [resource_data](#resource_data-property-googledrive-struct) (using the same logic as [download_file](#download_file-method-googledrive-struct)).

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

# toggle_shared_drive_hidden method ([GoogleDrive](#struct-cloudstoragegoogledrive) Struct)

Hides or unhides a shared drive.

## Syntax

*Rust Syntax*

```text
fn toggle_shared_drive_hidden(&self, shared_drive_id : &str, hidden : bool) -> Result<(), CloudStorageError>
```

## 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.

# trash_resource method ([GoogleDrive](#struct-cloudstoragegoogledrive) Struct)

Moves the specified file or folder to the trash.

## Syntax

*Rust Syntax*

```text
fn trash_resource(&self, resource_id : &str) -> Result<(), CloudStorageError>
```

## Remarks

This method moves the file or folder specified by *ResourceId* to the trash. The resource may be restored from the trash by calling [restore_resource](#restore_resource-method-googledrive-struct).

To permanently delete a resource, call [delete_resource](#delete_resource-method-googledrive-struct). To empty the trash (thus permanently deleting all trashed items), call [empty_trash](#empty_trash-method-googledrive-struct).

# update_permissions method ([GoogleDrive](#struct-cloudstoragegoogledrive) Struct)

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

## Syntax

*Rust Syntax*

```text
fn update_permissions(&self, resource_id : &str) -> Result<(), CloudStorageError>
```

## 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 [permission_mod_op](#permission_mod_op-property-googledrive-struct) property which can be set to one of the following values:

|  |  |
| --- | --- |
| moNone (0) (default) | No-Op (the struct skips the permission). |
| moCreate (1) | The permission will be created. |
| moUpdate (2) | The permission will be updated. |
| moDelete (3) | The permission will be deleted. |

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

For each permission operation which completes successfully, the struct will change its [permission_mod_op](#permission_mod_op-property-googledrive-struct) property back to *moNone (0)*.

**Important:** The struct executes permission operations one-by-one due to how the Google Drive API works. If the struct 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

 [list_permissions](#list_permissions-method-googledrive-struct) 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 [list_permissions](#list_permissions-method-googledrive-struct) first is optional, but still recommended to ensure that the struct 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 [permission_mod_op](#permission_mod_op-property-googledrive-struct) 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.

```text
// 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 struct.
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](#TransferOwnership) configuration setting must be set to "True" before calling update_permissions 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 [add_shared_drive_member](#add_shared_drive_member-method-googledrive-struct), [update_shared_drive_member](#update_shared_drive_member-method-googledrive-struct), and [remove_shared_drive_member](#remove_shared_drive_member-method-googledrive-struct) 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).

# update_resource method ([GoogleDrive](#struct-cloudstoragegoogledrive) Struct)

Updates a file or folder.

## Syntax

*Rust Syntax*

```text
fn update_resource(&self, resource_id : &str) -> Result<(), CloudStorageError>
```

## 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 [resource_id](#resource_id-property-googledrive-struct) property matches the specified *ResourceId* value before this method is called.

1. If necessary, call [get_resource_info](#get_resource_info-method-googledrive-struct) or [list_resources](#list_resources-method-googledrive-struct) 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:

  - [resource_content_accessible](#resource_content_accessible-property-googledrive-struct)
  - [resource_description](#resource_description-property-googledrive-struct)
  - [resource_mime_type](#resource_mime_type-property-googledrive-struct) (only updated for files, if not empty and new file data is uploaded)
  - [resource_modified_time](#resource_modified_time-property-googledrive-struct) (only updated if not empty)
  - [resource_name](#resource_name-property-googledrive-struct)
  - [resource_starred](#resource_starred-property-googledrive-struct)
  - [resource_trashed](#resource_trashed-property-googledrive-struct)

3. For file resources, you may set [local_file](#local_file-property-googledrive-struct) or [resource_data](#resource_data-property-googledrive-struct) if you wish to update the file data on the server. (Refer to [upload_file](#upload_file-method-googledrive-struct) for more information about simple vs. resumable uploads and encrypting the file data before uploading.)
4. Finally, call this method to update the resource.

```text
// 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);
```

# update_shared_drive method ([GoogleDrive](#struct-cloudstoragegoogledrive) Struct)

Updates a shared drive.

## Syntax

*Rust Syntax*

```text
fn update_shared_drive(&self, shared_drive_id : &str, new_name : &str, set_restrictions : i32, unset_restrictions : i32) -> Result<(), CloudStorageError>
```

## 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 [shared_drive_capabilities](#shared_drive_capabilities-property-googledrive-struct) 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 [shared_drive_restrictions](#shared_drive_restrictions-property-googledrive-struct) (i.e., if the [shared_drive_capabilities](#shared_drive_capabilities-property-googledrive-struct) 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.

| Hex Value | Description |
| --- | --- |
| 0x0001 | Administrative privileges on the shared drive are required to modify restrictions. |
| 0x0002 | Readers and commenters cannot copy, print, or download files in the shared drive. |
| 0x0004 | Access to the shared drive, and its contents, is restricted to users in its domain. |
| 0x0008 | Access to items in the shared drive is restricted to its members. |

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.

# update_shared_drive_member method ([GoogleDrive](#struct-cloudstoragegoogledrive) Struct)

Updates an existing shared drive member's role.

## Syntax

*Rust Syntax*

```text
fn update_shared_drive_member(&self, shared_drive_id : &str, permission_id : &str, role : i32) -> Result<(), CloudStorageError>
```

## 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:

|  |  |
| --- | --- |
| prReader (0) | Read-only permissions. |
| prCommenter (1) | Read-only plus commenting permissions. |
| prWriter (2) | Read, write, and comment permissions. |
| prFileOrganizer (4) | Writer permissions, plus the ability to move and trash resources. |
| prOrganizer (5) | File organizer permissions, plus the ability to permanently delete resources from, and rename/delete/alter the membership of, a shared drive. |

Refer to [update_permissions](#update_permissions-method-googledrive-struct) for more information about how permissions work in general, how permissions relate to shared drive members, and how to manipulate multiple members at once.

```text
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);
```

# upload_file method ([GoogleDrive](#struct-cloudstoragegoogledrive) Struct)

Uploads, and optionally converts, a new file.

## Syntax

*Rust Syntax*

```text
fn upload_file(&self, file_name : &str, mime_type : &str) ->  Result<String, CloudStorageError>
```

## Remarks

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

 If [local_file](#local_file-property-googledrive-struct) is set the file will be uploaded from the specified path. If [local_file](#local_file-property-googledrive-struct) is not set the data in [resource_data](#resource_data-property-googledrive-struct) 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 [encryption_algorithm](#encryption_algorithm-property-googledrive-struct) and [encryption_password](#encryption_password-property-googledrive-struct).

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

| Original File Format | Google Format | MIME Type |
| --- | --- | --- |
| MS Word, OpenDocument Text, HTML, RTF, Plain Text | Google Docs | application/vnd.google-apps.document |
| MS Excel, OpenDocument Spreadsheet, CSV, TSV, Plain Text | Google Sheets | application/vnd.google-apps.spreadsheet |
| MS Powerpoint, OpenDocument Presentation | Google Slides | application/vnd.google-apps.presentation |
| PDF, JPEG, PNG, GIF, BMP (images are embedded in a Doc) | Google Docs | application/vnd.google-apps.document |
| Plain Text, JSON | Google Apps Script | application/vnd.google-apps.script |

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

```text
googledrive.LocalFile = "../MyFile.zip";
googledrive.UploadFile("MyFile.zip", "");
```

**Resumable**

To enable resumable uploads set [use_resumable_upload](#use_resumable_upload-property-googledrive-struct) to *true*. This is recommended for large files. The struct will automatically fragment the specified file into smaller pieces and upload each individually. [FragmentSize](#FragmentSize) may be set to specify the size of the fragment if desired. The default fragment size is 10 MB.

When [use_resumable_upload](#use_resumable_upload-property-googledrive-struct) is set to *true* and upload_file is called, a resumable upload session is started by the struct. [resume_url](#resume_url-property-googledrive-struct) is populated with a URL identifying the session (this value may be needed for additional operations if the upload does not complete normally).

During a resumable upload, the [on_fragment_complete](#on_fragment_complete-event-googledrive-struct) event fires after each fragment is uploaded to indicate overall progress. The struct also updates [start_byte](#start_byte-property-googledrive-struct) as necessary to indicate the current offset in the file.

If the upload is interrupted for any reason, resuming it is easy. First, verify that [resume_url](#resume_url-property-googledrive-struct) and [start_byte](#start_byte-property-googledrive-struct) are populated (if the same instance of the struct is used, they should already be populated, and no special action should be needed). Then call upload_file again to resume the upload at the specified [start_byte](#start_byte-property-googledrive-struct) offset.

Note that if the upload is not resumed after some time the upload session will expire. [get_upload_status](#get_upload_status-method-googledrive-struct) may be used to check the status of a resumable upload.

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

# on_change_list event ([GoogleDrive](#struct-cloudstoragegoogledrive) Struct)

Fires once for each change when ListChanges is called.

## Syntax

*Rust Syntax*

```text
// GoogleDriveChangeListEventArgs carries the GoogleDrive ChangeList event's parameters.
pub struct GoogleDriveChangeListEventArgs {
  fn resource_id(&self) -> &String
  fn shared_drive_id(&self) -> &String
  fn removed(&self) -> bool
  fn time(&self) -> &String
  fn change_type(&self) -> i32
}

// GoogleDriveChangeListEvent defines the signature of the GoogleDrive ChangeList event's handler function.
pub trait GoogleDriveChangeListEvent {
  fn on_change_list(&self, sender : GoogleDrive, e : &mut GoogleDriveChangeListEventArgs);
}

impl <'a> GoogleDrive<'a> {
  pub fn on_change_list(&self) -> &'a dyn GoogleDriveChangeListEvent;
  pub fn set_on_change_list(&mut self, value : &'a dyn GoogleDriveChangeListEvent);
  ...
}
```

## Remarks

This event fires once for each change returned when [list_changes](#list_changes-method-googledrive-struct) 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 *true* (it would still return *false* 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 [list_changes](#list_changes-method-googledrive-struct) for more information.

# on_end_transfer event ([GoogleDrive](#struct-cloudstoragegoogledrive) Struct)

Fired when a document finishes transferring.

## Syntax

*Rust Syntax*

```text
// GoogleDriveEndTransferEventArgs carries the GoogleDrive EndTransfer event's parameters.
pub struct GoogleDriveEndTransferEventArgs {
  fn direction(&self) -> i32
}

// GoogleDriveEndTransferEvent defines the signature of the GoogleDrive EndTransfer event's handler function.
pub trait GoogleDriveEndTransferEvent {
  fn on_end_transfer(&self, sender : GoogleDrive, e : &mut GoogleDriveEndTransferEventArgs);
}

impl <'a> GoogleDrive<'a> {
  pub fn on_end_transfer(&self) -> &'a dyn GoogleDriveEndTransferEvent;
  pub fn set_on_end_transfer(&mut self, value : &'a dyn GoogleDriveEndTransferEvent);
  ...
}
```

## Remarks

This event is fired first when the client finishes sending data to the server (in a *POST* or *PUT* request) and then 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.

# on_error event ([GoogleDrive](#struct-cloudstoragegoogledrive) Struct)

Fired when information is available about errors during data delivery.

## Syntax

*Rust Syntax*

```text
// GoogleDriveErrorEventArgs carries the GoogleDrive Error event's parameters.
pub struct GoogleDriveErrorEventArgs {
  fn error_code(&self) -> i32
  fn description(&self) -> &String
}

// GoogleDriveErrorEvent defines the signature of the GoogleDrive Error event's handler function.
pub trait GoogleDriveErrorEvent {
  fn on_error(&self, sender : GoogleDrive, e : &mut GoogleDriveErrorEventArgs);
}

impl <'a> GoogleDrive<'a> {
  pub fn on_error(&self) -> &'a dyn GoogleDriveErrorEvent;
  pub fn set_on_error(&mut self, value : &'a dyn GoogleDriveErrorEvent);
  ...
}
```

## Remarks

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

The *error_code* 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](#trappable-errors-googledrive-struct) section.

# on_fragment_complete event ([GoogleDrive](#struct-cloudstoragegoogledrive) Struct)

Fires after each fragment of a resumable upload is completed.

## Syntax

*Rust Syntax*

```text
// GoogleDriveFragmentCompleteEventArgs carries the GoogleDrive FragmentComplete event's parameters.
pub struct GoogleDriveFragmentCompleteEventArgs {
  fn fragment_number(&self) -> i32
  fn fragment_count(&self) -> i32
  fn interrupt(&self) -> bool
  fn set_interrupt(&self, value : bool)
}

// GoogleDriveFragmentCompleteEvent defines the signature of the GoogleDrive FragmentComplete event's handler function.
pub trait GoogleDriveFragmentCompleteEvent {
  fn on_fragment_complete(&self, sender : GoogleDrive, e : &mut GoogleDriveFragmentCompleteEventArgs);
}

impl <'a> GoogleDrive<'a> {
  pub fn on_fragment_complete(&self) -> &'a dyn GoogleDriveFragmentCompleteEvent;
  pub fn set_on_fragment_complete(&mut self, value : &'a dyn GoogleDriveFragmentCompleteEvent);
  ...
}
```

## Remarks

When [use_resumable_upload](#use_resumable_upload-property-googledrive-struct) is *true* and [upload_file](#upload_file-method-googledrive-struct) is called, this event will fire after each fragment is uploaded, providing an indication of overall upload progress.

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

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

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

# on_header event ([GoogleDrive](#struct-cloudstoragegoogledrive) Struct)

Fired every time a header line comes in.

## Syntax

*Rust Syntax*

```text
// GoogleDriveHeaderEventArgs carries the GoogleDrive Header event's parameters.
pub struct GoogleDriveHeaderEventArgs {
  fn field(&self) -> &String
  fn value(&self) -> &String
}

// GoogleDriveHeaderEvent defines the signature of the GoogleDrive Header event's handler function.
pub trait GoogleDriveHeaderEvent {
  fn on_header(&self, sender : GoogleDrive, e : &mut GoogleDriveHeaderEventArgs);
}

impl <'a> GoogleDrive<'a> {
  pub fn on_header(&self) -> &'a dyn GoogleDriveHeaderEvent;
  pub fn set_on_header(&mut self, value : &'a dyn GoogleDriveHeaderEvent);
  ...
}
```

## 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).

# on_log event ([GoogleDrive](#struct-cloudstoragegoogledrive) Struct)

Fired once for each log message.

## Syntax

*Rust Syntax*

```text
// GoogleDriveLogEventArgs carries the GoogleDrive Log event's parameters.
pub struct GoogleDriveLogEventArgs {
  fn log_level(&self) -> i32
  fn message(&self) -> &String
  fn log_type(&self) -> &String
}

// GoogleDriveLogEvent defines the signature of the GoogleDrive Log event's handler function.
pub trait GoogleDriveLogEvent {
  fn on_log(&self, sender : GoogleDrive, e : &mut GoogleDriveLogEventArgs);
}

impl <'a> GoogleDrive<'a> {
  pub fn on_log(&self) -> &'a dyn GoogleDriveLogEvent;
  pub fn set_on_log(&mut self, value : &'a dyn GoogleDriveLogEvent);
  ...
}
```

## Remarks

This event is fired once for each log message generated by the struct. The verbosity is controlled by the [LogLevel](#LogLevel) setting.

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

|  |  |
| --- | --- |
| 0 (None) | No events are logged. |
| 1 (Info - default) | Informational events are logged. |
| 2 (Verbose) | Detailed data are logged. |
| 3 (Debug) | Debug data are logged. |

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.

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

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

# on_permission_list event ([GoogleDrive](#struct-cloudstoragegoogledrive) Struct)

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

## Syntax

*Rust Syntax*

```text
// GoogleDrivePermissionListEventArgs carries the GoogleDrive PermissionList event's parameters.
pub struct GoogleDrivePermissionListEventArgs {
  fn id(&self) -> &String
  fn role(&self) -> i32
  fn permission_type(&self) -> i32
  fn email(&self) -> &String
  fn domain(&self) -> &String
  fn allow_file_discovery(&self) -> bool
}

// GoogleDrivePermissionListEvent defines the signature of the GoogleDrive PermissionList event's handler function.
pub trait GoogleDrivePermissionListEvent {
  fn on_permission_list(&self, sender : GoogleDrive, e : &mut GoogleDrivePermissionListEventArgs);
}

impl <'a> GoogleDrive<'a> {
  pub fn on_permission_list(&self) -> &'a dyn GoogleDrivePermissionListEvent;
  pub fn set_on_permission_list(&mut self, value : &'a dyn GoogleDrivePermissionListEvent);
  ...
}
```

## Remarks

When calling [list_permissions](#list_permissions-method-googledrive-struct) 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:

|  |  |
| --- | --- |
| prReader (0) | Read-only permissions. |
| prCommenter (1) | Read-only plus commenting permissions. |
| prWriter (2) | Read, write, and comment permissions. |
| prOwner (3) | Full ownership (personal drives only). |
| prFileOrganizer (4) | Writer permissions, plus the ability to move and trash resources (shared drives only). |
| prOrganizer (5) | File organizer permissions, plus the ability to permanently delete resources from, and rename/delete/alter the membership of, a shared drive (shared drives only). |

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

|  |  |
| --- | --- |
| 0 (ptUser) | A single user. |
| 1 (ptGroup) | A group. |
| 2 (ptDomain) | A domain. |
| 3 (ptAnyone) | Anyone, authenticated or not. |

*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.

# on_progress event ([GoogleDrive](#struct-cloudstoragegoogledrive) Struct)

Fires during an upload or download to indicate transfer progress.

## Syntax

*Rust Syntax*

```text
// GoogleDriveProgressEventArgs carries the GoogleDrive Progress event's parameters.
pub struct GoogleDriveProgressEventArgs {
  fn direction(&self) -> i32
  fn bytes_transferred(&self) -> i64
  fn total_bytes(&self) -> i64
  fn percent_done(&self) -> i32
}

// GoogleDriveProgressEvent defines the signature of the GoogleDrive Progress event's handler function.
pub trait GoogleDriveProgressEvent {
  fn on_progress(&self, sender : GoogleDrive, e : &mut GoogleDriveProgressEventArgs);
}

impl <'a> GoogleDrive<'a> {
  pub fn on_progress(&self) -> &'a dyn GoogleDriveProgressEvent;
  pub fn set_on_progress(&mut self, value : &'a dyn GoogleDriveProgressEvent);
  ...
}
```

## 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](#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 struct 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](#ProgressAbsolute) configuration setting, in which case the struct 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.

# on_resource_list event ([GoogleDrive](#struct-cloudstoragegoogledrive) Struct)

Fires once for each resource returned when listing resources.

## Syntax

*Rust Syntax*

```text
// GoogleDriveResourceListEventArgs carries the GoogleDrive ResourceList event's parameters.
pub struct GoogleDriveResourceListEventArgs {
  fn id(&self) -> &String
  fn name(&self) -> &String
  fn extension(&self) -> &String
  fn description(&self) -> &String
  fn resource_type(&self) -> i32
  fn shared_drive_id(&self) -> &String
  fn created_time(&self) -> &String
  fn modified_time(&self) -> &String
  fn size(&self) -> i64
  fn trashed(&self) -> bool
}

// GoogleDriveResourceListEvent defines the signature of the GoogleDrive ResourceList event's handler function.
pub trait GoogleDriveResourceListEvent {
  fn on_resource_list(&self, sender : GoogleDrive, e : &mut GoogleDriveResourceListEventArgs);
}

impl <'a> GoogleDrive<'a> {
  pub fn on_resource_list(&self) -> &'a dyn GoogleDriveResourceListEvent;
  pub fn set_on_resource_list(&mut self, value : &'a dyn GoogleDriveResourceListEvent);
  ...
}
```

## Remarks

This event fires once for each resource returned when [list_resources](#list_resources-method-googledrive-struct), [list_children](#list_children-method-googledrive-struct), [list_parents](#list_parents-method-googledrive-struct), or [get_resource_info](#get_resource_info-method-googledrive-struct) 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:

|  |  |
| --- | --- |
| 0 (gdrtFile) | A file. |
| 1 (gdrtFolder) | A folder. |
| 2 (gdrtRevision) | A revision. |

*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.

# on_shared_drive_list event ([GoogleDrive](#struct-cloudstoragegoogledrive) Struct)

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

## Syntax

*Rust Syntax*

```text
// GoogleDriveSharedDriveListEventArgs carries the GoogleDrive SharedDriveList event's parameters.
pub struct GoogleDriveSharedDriveListEventArgs {
  fn id(&self) -> &String
  fn name(&self) -> &String
  fn created_time(&self) -> &String
  fn hidden(&self) -> bool
  fn capabilities(&self) -> i32
  fn restrictions(&self) -> i32
}

// GoogleDriveSharedDriveListEvent defines the signature of the GoogleDrive SharedDriveList event's handler function.
pub trait GoogleDriveSharedDriveListEvent {
  fn on_shared_drive_list(&self, sender : GoogleDrive, e : &mut GoogleDriveSharedDriveListEventArgs);
}

impl <'a> GoogleDrive<'a> {
  pub fn on_shared_drive_list(&self) -> &'a dyn GoogleDriveSharedDriveListEvent;
  pub fn set_on_shared_drive_list(&mut self, value : &'a dyn GoogleDriveSharedDriveListEvent);
  ...
}
```

## Remarks

This event fires once for each shared drive returned when [list_shared_drives](#list_shared_drives-method-googledrive-struct) 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:

| Hex Value | Description |
| --- | --- |
| 0x00001 | User can add children to the shared drive's folders. |
| 0x00002 | User can change the shared drive's copyRequiresWriterPermission restriction. |
| 0x00004 | User can change the shared drive's domainUsersOnly restriction. |
| 0x00008 | User can change the shared drive's background image. |
| 0x00010 | User can change the shared drive's driveMembersOnly restriction. |
| 0x00020 | User can comment on the shared drive's files. |
| 0x00040 | User can copy files in the shared drive. |
| 0x00080 | User can permanently delete children from the shared drive's folders. |
| 0x00100 | User can delete the shared drive. |
| 0x00200 | User can download the shared drive's files. |
| 0x00400 | User can edit the shared drive's files. |
| 0x00800 | User can list children of folders in the shared drive. |
| 0x01000 | User can add, remove, and update shared drive members. |
| 0x02000 | User can read revisions of the shared drive's files. |
| 0x04000 | User can rename the shared drive's files and folders. |
| 0x08000 | User can rename the shared drive. |
| 0x10000 | User can share the shared drive's files and folders. |
| 0x20000 | User can trash children from the shared drive's folders. |

*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:

| Hex Value | Description |
| --- | --- |
| 0x0001 | Administrative privileges on the shared drive are required to modify restrictions. |
| 0x0002 | Readers and commenters cannot copy, print, or download files in the shared drive. |
| 0x0004 | Access to the shared drive, and its contents, is restricted to users in its domain. |
| 0x0008 | Access to items in the shared drive is restricted to its members. |

# on_ssl_server_authentication event ([GoogleDrive](#struct-cloudstoragegoogledrive) Struct)

Fired after the server presents its certificate to the client.

## Syntax

*Rust Syntax*

```text
// GoogleDriveSSLServerAuthenticationEventArgs carries the GoogleDrive SSLServerAuthentication event's parameters.
pub struct GoogleDriveSSLServerAuthenticationEventArgs {
  fn cert_encoded(&self) -> &[u8]
  fn cert_subject(&self) -> &String
  fn cert_issuer(&self) -> &String
  fn status(&self) -> &String
  fn accept(&self) -> bool
  fn set_accept(&self, value : bool)
}

// GoogleDriveSSLServerAuthenticationEvent defines the signature of the GoogleDrive SSLServerAuthentication event's handler function.
pub trait GoogleDriveSSLServerAuthenticationEvent {
  fn on_ssl_server_authentication(&self, sender : GoogleDrive, e : &mut GoogleDriveSSLServerAuthenticationEventArgs);
}

impl <'a> GoogleDrive<'a> {
  pub fn on_ssl_server_authentication(&self) -> &'a dyn GoogleDriveSSLServerAuthenticationEvent;
  pub fn set_on_ssl_server_authentication(&mut self, value : &'a dyn GoogleDriveSSLServerAuthenticationEvent);
  ...
}
```

## 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.

# on_ssl_status event ([GoogleDrive](#struct-cloudstoragegoogledrive) Struct)

Fired when secure connection progress messages are available.

## Syntax

*Rust Syntax*

```text
// GoogleDriveSSLStatusEventArgs carries the GoogleDrive SSLStatus event's parameters.
pub struct GoogleDriveSSLStatusEventArgs {
  fn message(&self) -> &String
}

// GoogleDriveSSLStatusEvent defines the signature of the GoogleDrive SSLStatus event's handler function.
pub trait GoogleDriveSSLStatusEvent {
  fn on_ssl_status(&self, sender : GoogleDrive, e : &mut GoogleDriveSSLStatusEventArgs);
}

impl <'a> GoogleDrive<'a> {
  pub fn on_ssl_status(&self) -> &'a dyn GoogleDriveSSLStatusEvent;
  pub fn set_on_ssl_status(&mut self, value : &'a dyn GoogleDriveSSLStatusEvent);
  ...
}
```

## Remarks

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

# on_start_transfer event ([GoogleDrive](#struct-cloudstoragegoogledrive) Struct)

Fired when a document starts transferring (after the headers).

## Syntax

*Rust Syntax*

```text
// GoogleDriveStartTransferEventArgs carries the GoogleDrive StartTransfer event's parameters.
pub struct GoogleDriveStartTransferEventArgs {
  fn direction(&self) -> i32
}

// GoogleDriveStartTransferEvent defines the signature of the GoogleDrive StartTransfer event's handler function.
pub trait GoogleDriveStartTransferEvent {
  fn on_start_transfer(&self, sender : GoogleDrive, e : &mut GoogleDriveStartTransferEventArgs);
}

impl <'a> GoogleDrive<'a> {
  pub fn on_start_transfer(&self) -> &'a dyn GoogleDriveStartTransferEvent;
  pub fn set_on_start_transfer(&mut self, value : &'a dyn GoogleDriveStartTransferEvent);
  ...
}
```

## Remarks

This event is fired first when the client starts sending data to the server (in a *POST* or *PUT* request) and then 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.

# on_transfer event ([GoogleDrive](#struct-cloudstoragegoogledrive) Struct)

Fired while a document transfers (delivers document).

## Syntax

*Rust Syntax*

```text
// GoogleDriveTransferEventArgs carries the GoogleDrive Transfer event's parameters.
pub struct GoogleDriveTransferEventArgs {
  fn direction(&self) -> i32
  fn bytes_transferred(&self) -> i64
  fn percent_done(&self) -> i32
  fn text(&self) -> &[u8]
}

// GoogleDriveTransferEvent defines the signature of the GoogleDrive Transfer event's handler function.
pub trait GoogleDriveTransferEvent {
  fn on_transfer(&self, sender : GoogleDrive, e : &mut GoogleDriveTransferEventArgs);
}

impl <'a> GoogleDrive<'a> {
  pub fn on_transfer(&self) -> &'a dyn GoogleDriveTransferEvent;
  pub fn set_on_transfer(&mut self, value : &'a dyn GoogleDriveTransferEvent);
  ...
}
```

## 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 *bytes_transferred* 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](#struct-cloudstoragegoogledrive) Struct)

 The struct 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 struct, access to these *internal properties* is provided through the [config](#config-method-googledrive-struct) method.

### GoogleDrive Config Settings

**AccumulatePages**: Whether the struct should accumulate subsequent pages of results when listing them.This setting controls how the struct behaves when listing multiple pages of results. If this setting is enabled, each successive page of results will be appended to the appropriate collection properties until the last page of results has been listed (at which point the next list call will cause said collection to be cleared first). If this setting is disabled, the collection will be cleared every time a page of results is returned.

By default, this setting is enabled, allowing all pages of results to be accumulated in the appropriate collection properties.

**DocsExportFormat**: The file format to export Google Docs files as when downloading.This setting specifies what file format to export Google Docs as when downloading; it takes a file extension, which will be applied to the downloaded filename if necessary. Valid values (and their associated MIME types) are:

- *docx* (default) - application/vnd.openxmlformats-officedocument.wordprocessingml.document
- *epub* - application/epub+zip
- *htm* or *html* - text/html
- *odt* - application/vnd.oasis.opendocument.text
- *pdf* - application/pdf
- *rtf* - application/rtf
- *txt* - text/plain
- *zip* - application/zip

 You may also specify a string like *[extension],[MIME type]* instead of one of the file extensions above if you wish to customize the MIME type to export the file as and/or the file extension to apply to the downloaded file.

Note that this setting is ignored if a MIME type is explicitly passed to the [download_file](#download_file-method-googledrive-struct) method.

**DownloadTempFile**: The temporary file used when downloading encrypted data.This setting specifies the temporary file used when downloading encrypted data.

When downloading encrypted data with [local_file](#local_file-property-googledrive-struct) set, the struct will automatically create a temporary file at [TempPath](#TempPath) to hold the encrypted file contents. When the download is complete, the data is decrypted to [local_file](#local_file-property-googledrive-struct).

If the download is interrupted, the specified file will hold the partially downloaded encrypted file contents. Before resuming the download, this setting must be set to a valid file containing the partially encrypted file contents. See [download_file](#download_file-method-googledrive-struct) for details.

**DrawingsExportFormat**: The file format to export Google Drawings files as when downloading.This setting specifies what file format to export Google Drawings as when downloading; it takes a file extension, which will be applied to the downloaded filename if necessary. Valid values (and their associated MIME types) are:

- *jpg* or *jpeg* - image/jpeg
- *pdf* - application/pdf
- *png* (default) - image/png
- *svg* - image/svg+xml

 You may also specify a string like *[extension],[MIME type]* instead of one of the file extensions above if you wish to customize the MIME type to export the file as and/or the file extension to apply to the downloaded file.

Note that this setting is ignored if a MIME type is explicitly passed to the [download_file](#download_file-method-googledrive-struct) method.

**EncryptionIV**: The initialization vector to be used for encryption/decryption.When encrypting or decrypting a file, this setting may be set to specify the initialization vector. Normally the struct will derive this value automatically from [encryption_password](#encryption_password-property-googledrive-struct).

This setting accepts a hex encoded value.

**EncryptionKey**: The key to use during encryption/decryption.When encrypting or decrypting a file, this setting may be set to specify the key to use. Normally the struct will derive this value automatically from [encryption_password](#encryption_password-property-googledrive-struct).

This setting accepts a hex encoded value.

**EncryptionPasswordKDF**: The KDF algorithm to use during password based encryption and decryption.This setting specified the Key Derivation Function (KDF) used to derive a key from the specified [encryption_password](#encryption_password-property-googledrive-struct). Possible values are:

- 0 (default) - PBKDF1
- 1 - PBKDF2

 Note: PBKDF1 is not FIPS compliant. When operating in FIPS mode PBKDF2 should be used.

**FragmentSize**: The fragment size.This setting controls the fragment size, in bytes, to use while uploading files when [use_resumable_upload](#use_resumable_upload-property-googledrive-struct) is *true*. When [upload_file](#upload_file-method-googledrive-struct) is called the file will be fragmented into pieces of this size.

The default value is *10485760* (10MB).

**IconLink[i]**: A static, unauthenticated link to the file icon for the specified resource.This setting can be queried to return a static, unauthenticated link to the file icon for the resource at index *i*.

Valid values for *i* are from *0* to *(ResourceCount - 1)*.

**IncludeAllFields**: Whether to request all fields when listing resources.This setting specifies whether the struct requests all fields be returned when calling [list_resources](#list_resources-method-googledrive-struct).

When set to *false* (default), the [RequestedFields](#RequestedFields) configuration setting is set added to the request is set to "default". When set to *true*, the [RequestedFields](#RequestedFields) configuration setting is set to "*" which will return all the fields. Further specifications can be made in the [RequestedFields](#RequestedFields) configuration setting.

**IncludeFolderProperties**: Whether resource properties apply when calling CreateFolder.This setting specifies whether the resources properties are applicable when calling [create_folder](#create_folder-method-googledrive-struct).

When *false* (default), the properties are ignored and the folder is simply created with the name specified. When set to *true*, the properties may be used to specify additional information about the folder.

**ListResourcesMode**: What items to include when listing resources.This setting specifies what items to include when listing resources with [list_resources](#list_resources-method-googledrive-struct) and [list_children](#list_children-method-googledrive-struct). Valid values are:

- *0* (default) - Files and folders
- *1* - Files only
- *2* - Folders only

**MaxPermissionResults**: Limits the number of permissions results.This setting specifies the maximum number of results to be returned each time [list_permissions](#list_permissions-method-googledrive-struct) is called. If there are more items than can be returned, the results will be paged and the [permission_marker](#permission_marker-property-googledrive-struct) property populated.

Acceptable values are from 1 to 100, inclusive. The default is -1, which causes the server's default (100 for shared drives and their contents, unlimited otherwise) to be used.

**MaxResults**: Limits the number of resource and change results.This setting specifies the maximum number of results to be returned each time [list_resources](#list_resources-method-googledrive-struct), [list_children](#list_children-method-googledrive-struct), or [list_changes](#list_changes-method-googledrive-struct) is called. If there are more items than can be returned, the results will be paged and the appropriate "Marker" property populated.

Acceptable values are from 1 to 1000 inclusive. The default is -1, which causes the server's default (100) to be used.

**MaxSharedDriveResults**: Limits the number of shared drive results.This setting specifies the maximum number of results to be returned each time [list_shared_drives](#list_shared_drives-method-googledrive-struct) is called. If there are more items than can be returned, the results will be paged and the [shared_drive_marker](#shared_drive_marker-property-googledrive-struct) property populated.

Acceptable values are from 1 to 100, inclusive. The default is -1, which causes the server's default (10) to be used.

**NormalizedFileName[i]**: File name constructed using the specified resource's information.This setting can be queried to return a normalized file name for the resource at index *i*. The normalized file name will be the resource's name, plus an appropriate file extension based on the resource's MIME type.

Note that the extension is only appended if the resource has one of the Google Apps MIME types, and if the resource's name doesn't already end with the applicable extension.

Valid values for *i* are from *0* to *(ResourceCount - 1)*.

**ProgressAbsolute**: Whether the struct should track transfer progress absolutely.This setting controls whether the struct tracks upload and download progress absolutely or relatively, with regards to the values reported via the [on_progress](#on_progress-event-googledrive-struct) event when an interrupted transfer is resumed.

If this setting is enabled (default), then when a transfer is interrupted and later resumed, the values reported by the [on_progress](#on_progress-event-googledrive-struct) event will account for the data that was successfully transferred before the interruption.

If this setting is disabled, then the struct will treat resumed transfers as "new" transfers, and the values reported by the [on_progress](#on_progress-event-googledrive-struct) event will start at *0* rather than from the number of bytes already transferred.

Refer to the [on_progress](#on_progress-event-googledrive-struct) event for more information.

**ProgressStep**: How often the progress event should be fired, in terms of percentage.This setting controls how often the struct will fire the [on_progress](#on_progress-event-googledrive-struct) event during an upload or download, in terms of percentage. Valid values are *0* to *99*, inclusive.

The default value, *1*, will cause the [on_progress](#on_progress-event-googledrive-struct) event to fire each time the event's *PercentDone* parameter value increases by one percent. Setting this setting to *0* will cause the [on_progress](#on_progress-event-googledrive-struct) event to fire *every* time data is transferred.

Note that the [on_progress](#on_progress-event-googledrive-struct) event will *always* fire once at the beginning and end of a transfer, regardless of this setting's value. Also, if *PercentDone* cannot be calculated for a particular transfer (e.g., for downloads that use chunked transfer encoding), then the struct will behave as if this setting were *0* for the duration of the transfer.

**RawRequest**: Returns the data that was sent to the server.This setting may be queried after calling any method that sends data to the server to obtain the request data that was transmitted. Such data may be useful for troubleshooting purposes.

**RawResponse**: Returns the data that was received from the server.This setting may be queried after calling any method that sends data to the server to obtain the response data that was received. Such data may be useful for troubleshooting purposes.

**RequestedFields**: What fields to request when listing or getting objects.This setting specifies whether the struct requests all fields be returned when calling [get_account_info](#get_account_info-method-googledrive-struct), [get_resource_info](#get_resource_info-method-googledrive-struct), [get_permission_info](#get_permission_info-method-googledrive-struct), [get_shared_drive_info](#get_shared_drive_info-method-googledrive-struct), [list_children](#list_children-method-googledrive-struct), [list_resources](#list_resources-method-googledrive-struct), [list_permissions](#list_permissions-method-googledrive-struct), and [list_shared_drives](#list_shared_drives-method-googledrive-struct).

By default, the rcfgIncludeAllFields; configuration setting will be set to the special keyword "default" which will tell the struct to get the default fields for the component. It can be set to a specific value for the fields parameter (e.g. "files(id, mimeType)") to restrict or expand what is provided. The special keyword "*" can be used to request all of the fields however, for performance reasons. this is only recommended for development.

If the [IncludeAllFields](#IncludeAllFields) is changed, then the value of the [RequestedFields](#RequestedFields) setting will be changed as well. More information can be found in the description of the [IncludeAllFields](#IncludeAllFields) setting. Additionally, if the "fields" parameter is set using the [add_query_param](#add_query_param-method-googledrive-struct) then the values in the query_params properties will take precedent.

**ResourceKey[i]**: The resource key used to access a file.This setting can be queried to return the resource key for the resource at index *i*, if that resource has one.

Valid values for *i* are from *0* to *(ResourceCount - 1)*.

**RevisionId**: The ID of the revision to make request against.This setting can set to a revision ID of a resource to modify the requests made from the below methods. To list Revision IDs for a particular file, see [list_revisions](#list_revisions-method-googledrive-struct).

**Modified Methods**

- [delete_resource](#delete_resource-method-googledrive-struct)
- [download_file](#download_file-method-googledrive-struct)
- [get_resource_info](#get_resource_info-method-googledrive-struct)
- [update_resource](#update_resource-method-googledrive-struct)

NOTE: Only have this setting set when it is required. Once it is no longer needed, be sure to set clear this setting.

**SearchIncomplete**: Indicates whether the server declined to search all possible locations when listing resources.Due to how the Google Drive API works, when [list_resources_scope](#list_resources_scope-property-googledrive-struct) is set to *lrsAllDrives (3)*, the server may choose not to include all possible locations in the results (even if the results are paged).

When [list_resources_scope](#list_resources_scope-property-googledrive-struct) is set to *lrsAllDrives (3)*, this setting will return "True" after calling [list_resources](#list_resources-method-googledrive-struct) or [list_children](#list_children-method-googledrive-struct) if the server chose not to include all possible locations in the result set. If this occurs, narrow your search scope by using another value for [list_resources_scope](#list_resources_scope-property-googledrive-struct) or by specifying a search query.

**SheetsExportFormat**: The file format to export Google Sheets files as when downloading.This setting specifies what file format to export Google Sheets as when downloading; it takes a file extension, which will be applied to the downloaded filename if necessary. Valid values (and their associated MIME types) are:

- *csv* - text/csv
- *ods* - application/vnd.oasis.opendocument.spreadsheet
- *pdf* - application/pdf
- *tsv* - text/tab-separated-values
- *xlsx* (default) - application/vnd.openxmlformats-officedocument.spreadsheetml.sheet
- *zip* - application/zip

 You may also specify a string like *[extension],[MIME type]* instead of one of the file extensions above if you wish to customize the MIME type to export the file as and/or the file extension to apply to the downloaded file.

Note that this setting is ignored if a MIME type is explicitly passed to the [download_file](#download_file-method-googledrive-struct) method.

**SlidesExportFormat**: The file format to export Google Slides files as when downloading.This setting specifies what file format to export Google Slides as when downloading; it takes a file extension, which will be applied to the downloaded filename if necessary. Valid values (and their associated MIME types) are:

- *odp* - application/vnd.oasis.opendocument.presentation
- *pdf* - application/pdf
- *pptx* (default) - application/vnd.openxmlformats-officedocument.presentationml.presentation
- *txt* - text/plain

 You may also specify a string like *[extension],[MIME type]* instead of one of the file extensions above if you wish to customize the MIME type to export the file as and/or the file extension to apply to the downloaded file.

Note that this setting is ignored if a MIME type is explicitly passed to the [download_file](#download_file-method-googledrive-struct) method.

**TempPath**: The path to the directory where temporary files are created.This setting specifies the path where temporary files are created when downloading encrypted files. If not specified, the system's temporary directory is used. Refer to [DownloadTempFile](#DownloadTempFile) and [download_file](#download_file-method-googledrive-struct) for more information.

**TransferOwnership**: Must be set to True before modifying permissions in a manner that causes the owner of a resource to change.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](#TransferOwnership) configuration setting must be set to "True" before calling [update_permissions](#update_permissions-method-googledrive-struct) 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.

**UseDomainAdminAccess**: Whether to make requests using domain administrator permissions.If the current user happens to have domain administrator permissions, this setting can be enabled to have the struct instruct the server to treat requests as having been made by a domain administrator. The following methods are affected by this configuration setting:

- [get_permission_info](#get_permission_info-method-googledrive-struct)
- [list_permissions](#list_permissions-method-googledrive-struct)
- [update_permissions](#update_permissions-method-googledrive-struct)
- [add_shared_drive_member](#add_shared_drive_member-method-googledrive-struct)
- [update_shared_drive_member](#update_shared_drive_member-method-googledrive-struct)
- [remove_shared_drive_member](#remove_shared_drive_member-method-googledrive-struct)
- [get_shared_drive_info](#get_shared_drive_info-method-googledrive-struct)
- [list_shared_drives](#list_shared_drives-method-googledrive-struct)
- [update_shared_drive](#update_shared_drive-method-googledrive-struct) (both for renaming and changing restrictions)

**XChildCount**: The number of child elements of the current element.This configuration settings specifies the number of child attributes of the current element. The XChild configuration settings will be indexed from 0 to ([XChildCount](#XChildCount) - 1).

The current element is specified through the [XPath](#XPath) configuration setting. This configuration setting is read-only.

**XChildName[i]**: The name of the child element.This configuration setting provides the name of the i-th child element of the current element.

The current element is specified through the [XPath](#XPath) configuration setting. This configuration setting is read-only.

**XChildXText[i]**: The inner text of the child element.This configuration setting provides the inner text of the i-th child element of the current element.

The current element is specified through the [XPath](#XPath) configuration setting. This configuration setting is read-only.

**XElement**: The name of the current element.This configuration setting provides the name of the current element.

The current element is specified through the [XPath](#XPath) configuration setting. This configuration setting is read-only.

**XParent**: The parent of the current element.This configuration setting provides the parent of the current element.

The current element is specified through the [XPath](#XPath) configuration setting. This configuration setting is read-only.

**XPath**: Provides a way to point to a specific element in the returned XML or JSON response.The [XPath](#XPath) setting allows you to point to specific elements in the XML or JSON response.

When [XPath](#XPath) is set to a valid path, [XElement](#XElement) points to the name of the element, with [XText](#XText), [XParent](#XParent), [XSubTree](#XSubTree), [XChildCount](#XChildCount), [XChildName\[i\]](#XChildName[i]), and [XChildXText\[i\]](#XChildXText[i]) providing other properties of the element.

XPath syntax is available for both XML and JSON documents. An XPath is a series of one or more element accessors separated by the */* character, for example, */A/B/C/D*. An XPath can be absolute (i.e., it starts with */*), or it can be relative to the current [XPath](#XPath) location.

The following are possible values for an element accessor, which operates relative to the current location specified by the XPath accessors, which proceed it in the overall XPath string:

| Accessor | Description |
| --- | --- |
| name | The first element with a particular name. Can be *. |
| [i] | The i-th element. |
| name[i] | The i-th element with a particular name. |
| [last()] | The last element. |
| [last()-i] | The element i before the last element. |
| name[@attrname="attrvalue"] | The first element with a particular name that contains the specified attribute-value pair. Supports single and double quotes. (XML Only) |
| . | The current element. |
| .. | The parent element. |

 NOTE: XPath indices are *1-based*.

For example, assume the following XML and JSON responses.

XML:

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

JSON:

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

The following are examples of valid XPaths for these responses:

| Description | XML XPath | JSON XPath |
| --- | --- | --- |
| Document root | / | /json |
| Specific element | /firstlevel/one | /json/firstlevel/one |
| i-th child | /firstlevel/two/item[2] | /json/firstlevel/two/[2] |

This list is not exhaustive, but it provides a general idea of the possibilities.

**XSubTree**: A snapshot of the current element in the document.This configuration setting provides the entirety of the current element (including its subelements).

The current element is specified through the [XPath](#XPath) configuration setting. This configuration setting is read-only.

**XText**: The text of the current element.This configuration setting provides the inner text of the current element.

The current element is specified in the [XPath](#XPath) configuration setting. This configuration setting is read-only.

### OAuth Config Settings

**OAuthAccessTokenExpiration**: The lifetime of the access token.This setting holds the lifetime of the access token in seconds. For instance the value *3600* indicates that the token will expire in one hour from the time it was generated.

**OAuthAuthorizationTokenType**: The type of access token returned.The applicable values include the following:

|  |  |
| --- | --- |
| Bearer (default) | When the access token returned by the server is a Bearer type, the authorization string returned by [authorize](#authorize-method-googledrive-struct) will be in the format "Bearer access_token". This can be supplied as the value of the HTTP Authorization header. |

**OAuthAutomaticRefresh**: Whether or not to refresh an expired access token automatically.When this setting is set to *true* and the [authorization](#authorization-property-googledrive-struct) property is not set, the struct will automatically get a new access token if it has the necessary properties to do so without user interaction.

For example, when using the Authorization Code grant type, the [o_auth_refresh_token](#o_auth_refresh_token-property-googledrive-struct) property should be set to a valid refresh token. When using the Client Credential grant type however, the struct does not need any additional properties set as it can already get a new access token without user interaction.

**OAuthBrowserResponseTimeout**: Specifies the amount of time to wait for a response from the browser.This setting specifies the amount of time (in seconds) the struct will wait for a response from the browser when requesting user authentication. The default value is *0*, meaning that the struct will wait indefinitely.

**OAuthIncludeEmptyRedirectURI**: Whether an empty redirect_uri parameter is included in requests.This setting specifies whether *redirect_uri* is included in the request made by [authorize](#authorize-method-googledrive-struct) if it is empty.

If set to *true* (default) the *redirect_uri* will be sent in all cases. If set to *false* the *redirect_uri* will only be sent if it has a value.

**OAuthJWTPayload**: The payload of the JWT access token if present.This configuration setting provides the payload section of a JWT access token if the access token is a JWT and the struct is able to parse out the payload section. This setting only applies to **access tokens** that are returned from a service provider after successfully authorizing and authenticating with the service.

To parse the payload for specific claims, see [OAuthJWTXPath](#OAuthJWTXPath).

**OAuthJWTXChildCount**: The number of child elements of the current element.The number of child attributes of the current element. The OAuthJWTXChildCount configuration settings will be indexed from 0 to ([OAuthJWTXChildCount](#OAuthJWTXChildCount) - 1).

The current element is specified in the [OAuthJWTXPath](#OAuthJWTXPath) configuration setting. This configuration setting is read-only.

**OauthJWTXChildName[i]**: The name of the child element.Provides the name of the i'th child element of the current element.

The current element is specified in the [OAuthJWTXPath](#OAuthJWTXPath) configuration setting. This configuration setting is read-only.

**OAuthJWTXChildXText[i]**: The inner text of the child element.Provides the inner text of the i'th child element of the current element.

The current element is specified in the [OAuthJWTXPath](#OAuthJWTXPath) configuration setting. This configuration setting is read-only.

**OAuthJWTXElement**: The name of the current element.Provides the name of the current element.

The current element is specified in the [OAuthJWTXPath](#OAuthJWTXPath) configuration setting. This configuration setting is read-only.

**OauthJWTXParent**: The parent of the current element.Provides the parent of the current element.

The current element is specified in the [OAuthJWTXPath](#OAuthJWTXPath) configuration setting. This configuration setting is read-only.

**OAuthJWTXPath**: Provides a way to point to a specific element in the returned payload of a JWT based access token.The [OAuthJWTXPath](#OAuthJWTXPath) setting allows you to point to specific claims within the payload of a JWT based access token.

XPath syntax is available for the payload of JWT based access tokens if available. An XPath is a series of one or more element accessors separated by the */* character, for example: */A/B/C/D*.

The following are possible values for an element accessor, which operates relative to the current location specified by the XPath accessors which proceed it in the overall XPath string:

| Accessor | Description |
| --- | --- |
| name | The first element with a particular name. Can be *. |
| [i] | The i-th element. |
| name[i] | The i-th element with a particular name. |
| [last()] | The last element. |
| [last()-i] | The element i before the last element. |

 Here are some examples of valid XPaths and some common claims:

| Description | JSON XPath |
| --- | --- |
| Document root | /json |
| Specific element | /json/element_one |
| Username Claim (Microsoft Specific) | /json/preferred_username |
| Registered Application Name Claim (Microsoft Specific) | /json/app_displayname |

This is not an exhaustive list by any means, but should provide a general idea of the possibilities. To get the text of the specified element, see [OAuthJWTXText](#OAuthJWTXText).

**OAuthJWTXSubTree**: A snapshot of the current element in the document.Provides the entirety of the current element (including its sub-elements).

The current element is specified in the [OAuthJWTXPath](#OAuthJWTXPath) configuration setting. This configuration setting is read-only.

**OAuthJWTXText**: The text of the current element.Provides the inner text of the current element.

The current element is specified in the [OAuthJWTXPath](#OAuthJWTXPath) configuration setting. This configuration setting is read-only.

**OAuthParamCount**: Specifies the number of additional parameters variables to include in the request.This setting can be used to add query string parameters to the outgoing request. One common use for this method would be to add the "state" parameter to the request, which can be used when the [o_auth_client_profile](#o_auth_client_profile-property-googledrive-struct) is cocpWeb to add user defined data. The authorization server will include the "state" parameter in the response and will be available in the post back to your server which will allow you to maintain state in your application. This is used in conjunction with OAuthParamName[i] and OAuthParamValue[i]. For instance:

```text
component.Config("OAuthParamCount=2");
component.Config("OAuthParamName[0]=myvar");
component.Config("OAuthParamValue[0]=myvalue");
component.Config("OAuthParamName[1]=testname");
component.Config("OAuthParamValue[1]=testvalue");
```

Additionally, this will also be updated to hold the parameters returned in the response.

```text
for (int i = 0; i < int.Parse(component.Config("OAuthParamCount")); i++)
{
  string name = component.Config("OAuthParamName[" + i + "]");
  string value = component.Config("OAuthParamValue[" + i + "]");
}
```

**OAuthParamName[i]**: Specifies the parameter name at the specified index.This setting can be used to retrieve or specify the parameter variable name at the index specified. See [OAuthParamCount](#OAuthParamCount) for details.

**OAuthParamValue[i]**: Specifies the parameter value at the specified index.This setting can be used to retrieve or specify the parameter variable value at the index specified. See [OAuthParamCount](#OAuthParamCount) for details.

**OAuthPasswordGrantUsername**: Used in the Resource Owner Password grant type.Used to set the username property when the [o_auth_grant_type](#o_auth_grant_type-property-googledrive-struct) is set to the password grant type and [authorize](#authorize-method-googledrive-struct) is called.

**OAuthPKCEChallengeEncoding**: The PKCE code challenge method to use.This setting controls the PKCE code challenge method used when [OAuthUsePKCE](#OAuthUsePKCE) is set to *true*. Possible values are:

- 1 (Plain)
- 2 (S256/SHA256 - default)

**OAuthPKCEVerifier**: The PKCE verifier used to generate the challenge.This configuration setting when queried provides the PKCE verifier that is used to generate the PKCE challenge for the [authorize](#authorize-method-googledrive-struct) method and the [o_auth_web_auth_url](#o_auth_web_auth_url-property-googledrive-struct) field when [OAuthUsePKCE](#OAuthUsePKCE) is set to true. When using the cocpWeb [o_auth_client_profile](#o_auth_client_profile-property-googledrive-struct), the configuration setting can be set instead to allow the authorization request to be made from a different instance than the authentication (token) request.

**OAuthResetData**: Determines if the Reset method applies to the OAuth settings.If set to *true* (default), the [reset](#reset-method-googledrive-struct) method will reset the OAuth settings including any authorization fields like [o_auth_access_token](#o_auth_access_token-property-googledrive-struct) and [o_auth_refresh_token](#o_auth_refresh_token-property-googledrive-struct). This means the [authorize](#authorize-method-googledrive-struct) method must be called again to get new authorization information. When set to *false*, the [reset](#reset-method-googledrive-struct) method will **not** reset the o_auth property and the OAuth* configuration settings. This allows for the struct to be reset without having to get authorization again.

**OAuthReUseWebServer**: Determines if the same server instance is used between requests.If set to *true* (default), the same embedded web server instance will be used for multiple requests. If set to *false* the embedded web server will be created and destroyed on each call to [authorize](#authorize-method-googledrive-struct)

**OAuthTransferredRequest**: The full OAuth request last sent by the client.This configuration setting returns the full OAuth request last sent by the client. For performance reasons, the request is not normally saved. Set this configuration setting to ON before making a request to enable it. Following are examples of this request:

.NET

```text
Gmail gmail = new Gmail();
gmail.Config("OAuthTransferredRequest=on");
gmail.Authorize();
Console.WriteLine(gmail.Config("OAuthTransferredRequest"));
```

 C++

```text
Gmail gmail;
gmail.Config("OAuthTransferredRequest=on");
gmail.Authorize();
printf("%s\r\n", gmail.Config("OAuthTransferredRequest"));
```

**OAuthUsePKCE**: Specifies if PKCE should be used.If set to *true* (default), Proof Key for Code Exchange (PKCE) defined by RFC 7636 will be used when performing authorization. This setting applies when using the Authorization Code [o_auth_grant_type](#o_auth_grant_type-property-googledrive-struct). The [OAuthPKCEChallengeEncoding](#OAuthPKCEChallengeEncoding) configuration setting can be used to control the code challenge method that will be used.

**OAuthWebServerActive**: Specifies and controls whether the embedded web server is active.The setting when queried will return the current state of the web server. If the webserver is active, it will return *"true"* and if it is inactive it will return *"false"*.

This setting can also be set to activate or deactivate the web server. Under normal circumstances, this would not be required as the struct will automatically start and stop the web server when [authorize](#authorize-method-googledrive-struct) is called. In certain cases, it is required to start the webserver before calling [authorize](#authorize-method-googledrive-struct). For example, if the [o_auth_return_url](#o_auth_return_url-property-googledrive-struct) needs to be set to a relay server, then you will need to start the web server manually. Another example would be when the [OAuthReUseWebServer](#OAuthReUseWebServer) is set to true, the server will not be automatically stopped, and this configuration setting must be set to *"false"* to stop the embedded web server.

**OAuthWebServerCertStore**: The certificate with private key to use when SSL is enabled.The name of the certificate store used for the embedded web server's SSL.

The [OAuthWebServerCertStoreType](#OAuthWebServerCertStoreType) property specifies the type of the certificate store specified by [OAuthWebServerCertStore](#OAuthWebServerCertStore). If the store is password protected, specify the password in [OAuthWebServerCertStorePassword](#OAuthWebServerCertStorePassword).

[OAuthWebServerCertStore](#OAuthWebServerCertStore) is used in conjunction with the [OAuthWebServerCertSubject](#OAuthWebServerCertSubject) property in order to specify the certificate to be used during SSL.

 Designations of certificate stores are platform dependent.

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

|  |  |
| --- | --- |
| MY | A certificate store holding personal certificates with their associated private keys. |
| CA | Certifying authority certificates. |
| ROOT | Root certificates. |

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).

Note: This is required when [OAuthWebServerSSLEnabled](#OAuthWebServerSSLEnabled) is set to *true*.

**OAuthWebServerCertStorePassword**: The certificate with private key to use when SSL is enabled.If the certificate store is of a type that requires a password, this property is used to specify that password in order to open the certificate store.

Note: This is only applicable when [OAuthWebServerSSLEnabled](#OAuthWebServerSSLEnabled) is set to *true*.

**OAuthWebServerCertStoreType**: The certificate with private key to use when SSL is enabled.This specifies the type of certificate store. Possible values are:

|  |  |
| --- | --- |
| 0 | User - This is the default for Windows. This specifies that the certificate store is a certificate store owned by the current user. NOTE: This store type is not available in Java. |
| 1 | Machine - For Windows, this specifies that the certificate store is a machine store. NOTE: This store type is not available in Java. |
| 2 | PFXFile - The certificate store is the name of a PFX (PKCS12) file containing certificates. |
| 3 | PFXBlob - The certificate store is a string (binary or Base64-encoded) representing a certificate store in PFX (PKCS12) format. |
| 4 | JKSFile - The certificate store is the name of a Java Key Store (JKS) file containing certificates. NOTE: This store type is available only in Java. |
| 5 | JKSBlob - The certificate store is a string (binary or Base64-encoded) representing a certificate store in Java Key Store (JKS) format. NOTE: This store type is available only in Java. |
| 6 | PEMKeyFile - The certificate store is the name of a PEM-encoded file that contains a private key and an optional certificate. |
| 7 | PEMKeyBlob - The certificate store is a string (binary or Base64-encoded) that contains a private key and an optional certificate. |
| 14 | PPKFile - The certificate store is the name of a file that contains a PPK (PuTTY Private Key). |
| 15 | PPKBlob - The certificate store is a string (binary) that contains a PPK (PuTTY Private Key). |
| 16 | XMLFile - The certificate store is the name of a file that contains a certificate in XML format. |
| 17 | XMLBlob - The certificate store is a string that contains a certificate in XML format. |

 Note: This is required when [OAuthWebServerSSLEnabled](#OAuthWebServerSSLEnabled) is set to *true*.

**OAuthWebServerCertSubject**: The certificate with private key to use when SSL is enabled.The subject of the SSL certificate.

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=example@email.com". Common fields and their meanings are as follows:

| Field | Meaning |
| --- | --- |
| CN | Common Name. This is commonly a hostname like www.server.com. |
| O | Organization |
| OU | Organizational Unit |
| L | Locality |
| S | State |
| C | Country |
| E | Email Address |

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

Note: This is required when [OAuthWebServerSSLEnabled](#OAuthWebServerSSLEnabled) is set to *true*.

**OAuthWebServerFailedResponse**: The custom response that will be displayed to the user if authentication failed.When [authorize](#authorize-method-googledrive-struct) is called the user will be redirected to the embedded web server upon completing authentication with the authorization server. If authentication failed, the HTML specified here will be sent to the user's browser.

**OAuthWebServerHost**: The hostname used by the embedded web server displayed in the ReturnURL.This setting specifies the hostname used by the embedded web server when [o_auth_client_profile](#o_auth_client_profile-property-googledrive-struct) is set to cocpApplication. This specifies the interface on which the embedded web server listens, and also the value displayed in the [o_auth_return_url](#o_auth_return_url-property-googledrive-struct). This should be set to the hostname only, not the full URL.

The default value is *localhost*.

**OAuthWebServerPort**: The local port on which the embedded web server listens.This property specifies the port on which the embedded web server listens. Setting this to *0* (default) enables the system to choose a port at random. The chosen port will be returned when this setting is queried after the server has started listening.This is only applicable when using the embedded web server.

**OAuthWebServerResponse**: The custom response that will be displayed to the user.When [authorize](#authorize-method-googledrive-struct) is called the user will be redirected to the embedded web server upon completing authentication with the authorization server. This setting allows you to specify the HTML that will be sent to the user's browser.

**OAuthWebServerSSLEnabled**: Whether the web server requires SSL connections.This setting specifies whether the embedded web server will use SSL. If set to *True* OAuthWebServerCert* configs are required and the server will only accept SSL connections. If set to *False* only plaintext connects are supported.

### HTTP Config Settings

**AcceptEncoding**: Used to tell the server which types of content encodings the client supports.When [AllowHTTPCompression](#AllowHTTPCompression) is True, the struct adds an *Accept-Encoding* header to the request being sent to the server. By default, this header's value is "gzip, deflate". This configuration setting allows you to change the value of the *Accept-Encoding* header. NOTE: The struct only supports gzip and deflate decompression algorithms.

**AllowHTTPCompression**: This property enables HTTP compression for receiving data.This configuration setting enables HTTP compression for receiving data. When set to True (default), the struct will accept compressed data. It then will uncompress the data it has received. The struct will handle data compressed by both gzip and deflate compression algorithms.

When True, the struct adds an *Accept-Encoding* header to the outgoing request. The value for this header can be controlled by the [AcceptEncoding](#AcceptEncoding) configuration setting. The default value for this header is "gzip, deflate".

The default value is True.

**AllowHTTPFallback**: Whether HTTP/2 connections are permitted to fallback to HTTP/1.1.This configuration setting controls whether HTTP/2 connections are permitted to fall back to HTTP/1.1 when the server does not support HTTP/2. This setting is applicable only when http_version is set to "2.0".

If set to True (default), the struct will automatically use HTTP/1.1 if the server does not support HTTP/2. If set to False, the struct fails with an error if the server does not support HTTP/2.

The default value is True.

**Append**: Whether to append data to LocalFile.This configuration setting determines whether data will be appended when writing to [local_file](#local_file-property-googledrive-struct). When set to True, downloaded data will be appended to [local_file](#local_file-property-googledrive-struct). This may be used in conjunction with range to resume a failed download. This is applicable only when [local_file](#local_file-property-googledrive-struct) is set. The default value is False.

**Authorization**: The Authorization string to be sent to the server.If the [Authorization](#Authorization) property contains a nonempty string, an *Authorization* HTTP request header is added to the request. This header conveys Authorization information to the server.

This property is provided so that the HTTP struct can be extended with other security schemes in addition to the authorization schemes already implemented by the struct.

The auth_scheme property defines the authentication scheme used. In the case of HTTP Basic Authentication (default), every time user and password are set, they are Base64 encoded, and the result is put in the [authorization](#authorization-property-googledrive-struct) property in the form "Basic [encoded-user-password]".

**BytesTransferred**: Contains the number of bytes transferred in the response data.This configuration setting returns the raw number of bytes from the HTTP response data, before the component processes the data, whether it is chunked or compressed. This returns the same value as the [on_transfer](#on_transfer-event-googledrive-struct) event, by [BytesTransferred](#BytesTransferred).

**ChunkSize**: Specifies the chunk size in bytes when using chunked encoding.This is applicable only when [UseChunkedEncoding](#UseChunkedEncoding) is True. This setting specifies the chunk size in bytes to be used when posting data. The default value is 16384.

**CompressHTTPRequest**: Set to true to compress the body of a PUT or POST request.If set to True, the body of a *PUT* or *POST* request will be compressed into gzip format before sending the request. The "Content-Encoding" header is also added to the outgoing request.

The default value is False.

**EncodeURL**: If set to True the URL will be encoded by the struct.If set to True, the URL passed to the struct will be URL encoded. The default value is False.

**FollowRedirects**: Determines what happens when the server issues a redirect.This option determines what happens when the server issues a redirect. Normally, the struct returns an error if the server responds with an "Object Moved" message. If this property is set to 1 (always), the new url for the object is retrieved automatically every time.

If this property is set to 2 (Same Scheme), the new url is retrieved automatically only if the URL Scheme is the same; otherwise, the struct fails with an error.

**Note:** Following the HTTP specification, unless this option is set to 1 (Always), automatic redirects will be performed only for *GET* or *HEAD* requests. Other methods potentially could change the conditions of the initial request and create security vulnerabilities.

Furthermore, if either the new URL server or port are different from the existing one, user and password are also reset to empty, unless this property is set to 1 (Always), in which case the same credentials are used to connect to the new server.

A on_redirect event is fired for every URL the product is redirected to. In the case of automatic redirections, the on_redirect event is a good place to set properties related to the new connection (e.g., new authentication parameters).

The default value is 0 (Never). In this case, redirects are never followed, and the struct fails with an error instead.

Following are the valid options:

- 0 - Never
- 1 - Always
- 2 - Same Scheme

**GetOn302Redirect**: If set to True the struct will perform a GET on the new location.The default value is False. If set to True, the struct will perform a *GET* on the new location. Otherwise, it will use the same HTTP method again.

**HTTP2HeadersWithoutIndexing**: HTTP2 headers that should not update the dynamic header table with incremental indexing.HTTP/2 servers maintain a dynamic table of headers and values seen over the course of a connection. Typically, these headers are inserted into the table through incremental indexing (also known as HPACK, defined in RFC 7541). To tell the component not to use incremental indexing for certain headers, and thus not update the dynamic table, set this configuration option to a comma-delimited list of the header names.

**HTTPVersion**: The version of HTTP used by the struct.This property specifies the HTTP version used by the struct. Possible values are as follows:

- "1.0"
- "1.1" (default)
- "2.0"
- "3.0"

When using HTTP/2 ("2.0") or HTTP/3 ("3.0"), additional restrictions apply. Please see the following notes for details.

**HTTP/2 Notes**

When using HTTP/2, a secure Secure Sockets Layer/Transport Layer Security (TLS/SSL) connection is required. Attempting to use a plaintext URL with HTTP/2 will result in an error.

If the server does not support HTTP/2, the struct will automatically use HTTP/1.1 instead. This is done to provide compatibility without the need for any additional settings. To see which version was used, check [NegotiatedHTTPVersion](#NegotiatedHTTPVersion) after calling a method. The [AllowHTTPFallback](#AllowHTTPFallback) setting controls whether this behavior is allowed (default) or disallowed.

**HTTP/3 Notes**

HTTP/3 is supported only in .NET and Java.

When using HTTP/3, a secure (TLS/SSL) connection is required. Attempting to use a plaintext URL with HTTP/3 will result in an error.

**IfModifiedSince**: A date determining the maximum age of the desired document.If this setting contains a nonempty string, an If-Modified-Since HTTP header is added to the request. The value of this header is used to make the HTTP request conditional: if the requested documented has not been modified since the time specified in the field, a copy of the document will not be returned from the server; instead, a 304 (not modified) response will be returned by the server and the component throws an exception

The format of the date value for IfModifiedSince is detailed in the HTTP specs. For example:

```text
Sat, 29 Oct 2017 19:43:31 GMT.
```

**KeepAlive**: Determines whether the HTTP connection is closed after completion of the request.If *true*, the component will not send the *Connection: Close* header. The absence of the Connection header indicates to the server that HTTP persistent connections should be used if supported. NOTE: Not all servers support persistent connections. If *false*, the connection will be closed immediately after the server response is received.

 The default value for [KeepAlive](#KeepAlive) is *false*.

**KerberosSPN**: The Service Principal Name for the Kerberos Domain Controller.If the Service Principal Name on the Kerberos Domain Controller is not the same as the URL that you are authenticating to, the Service Principal Name should be set here.

**LogLevel**: The level of detail that is logged.This configuration setting controls the level of detail that is logged through the [on_log](#on_log-event-googledrive-struct) event. Possible values are as follows:

|  |  |
| --- | --- |
| 0 (None) | No events are logged. |
| 1 (Info - default) | Informational events are logged. |
| 2 (Verbose) | Detailed data are logged. |
| 3 (Debug) | Debug data are logged. |

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).

**MaxRedirectAttempts**: Limits the number of redirects that are followed in a request.When follow_redirects is set to any value other than frNever, the struct will follow redirects until this maximum number of redirect attempts are made. The default value is 20.

**NegotiatedHTTPVersion**: The negotiated HTTP version.This configuration setting may be queried after the request is complete to indicate the HTTP version used. When http_version is set to "2.0" (if the server does not support "2.0"), then the struct will fall back to using "1.1" automatically. This setting will indicate which version was used.

**OtherHeaders**: Other headers as determined by the user (optional).This configuration setting can be set to a string of headers to be appended to the HTTP request headers.

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

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

This configuration setting is useful for extending the functionality of the struct beyond what is provided.

**ProxyAuthorization**: The authorization string to be sent to the proxy server.This is similar to the [Authorization](#Authorization) configuration setting, but is used for proxy authorization. If this configuration setting contains a nonempty string, a *Proxy-Authorization* HTTP request header is added to the request. This header conveys proxy Authorization information to the server. If [proxy_user](#proxy_user-property-googledrive-struct) and [proxy_password](#proxy_password-property-googledrive-struct) are specified, this value is calculated using the algorithm specified by [proxy_auth_scheme](#proxy_auth_scheme-property-googledrive-struct).

**ProxyAuthScheme**: The authorization scheme to be used for the proxy.This configuration setting is provided for use by structs that do not directly expose Proxy properties.

**ProxyPassword**: A password if authentication is to be used for the proxy.This configuration setting is provided for use by structs that do not directly expose Proxy properties.

**ProxyPort**: Port for the proxy server (default 80).This configuration setting is provided for use by structs that do not directly expose Proxy properties.

**ProxyServer**: Name or IP address of a proxy server (optional).This configuration setting is provided for use by structs that do not directly expose Proxy properties.

**ProxyUser**: A user name if authentication is to be used for the proxy.This configuration setting is provided for use by structs that do not directly expose Proxy properties.

**SentHeaders**: The full set of headers as sent by the client.This configuration setting returns the complete set of raw headers as sent by the client.

**StatusCode**: The status code of the last response from the server.This configuration setting contains the result code of the last response from the server.

**StatusLine**: The first line of the last response from the server.This setting contains the first line of the last response from the server. The format of the line will be *[HTTP version] [Result Code] [Description]*.

**TransferredData**: The contents of the last response from the server.This configuration setting contains the contents of the last response from the server.

**TransferredDataLimit**: The maximum number of incoming bytes to be stored by the struct.If [TransferredDataLimit](#TransferredDataLimit) is set to 0 (default), no limits are imposed. Otherwise, this reflects the maximum number of incoming bytes that can be stored by the struct.

**TransferredHeaders**: The full set of headers as received from the server.This configuration setting returns the complete set of raw headers as received from the server.

**TransferredRequest**: The full request as sent by the client.This configuration setting returns the full request as sent by the client. For performance reasons, the request is not normally saved. Set this configuration setting to ON before making a request to enable it. Following are examples of this request:

 .NET

```text
Http http = new Http();
http.Config("TransferredRequest=on");
http.PostData = "body";
http.Post("http://someserver.com");
Console.WriteLine(http.Config("TransferredRequest"));
```

 C++

```text
HTTP http;
http.Config("TransferredRequest=on");
http.SetPostData("body", 5);
http.Post("http://someserver.com");
printf("%s\r\n", http.Config("TransferredRequest"));
```

**UseChunkedEncoding**: Enables or Disables HTTP chunked encoding for transfers.If [UseChunkedEncoding](#UseChunkedEncoding) is set to True, the struct will use HTTP-chunked encoding when posting, if possible. HTTP-chunked encoding allows large files to be sent in chunks instead of all at once. If set to False, the struct will not use HTTP-chunked encoding. The default value is False.

NOTE: Some servers (such as the ASP.NET Development Server) may not support chunked encoding.

**UseIDNs**: Whether to encode hostnames to internationalized domain names.This configuration setting specifies whether hostnames containing non-ASCII characters are encoded to internationalized domain names. When set to True, if a hostname contains non-ASCII characters, it is encoded using Punycode to an IDN (internationalized domain name).

The default value is False and the hostname will always be used exactly as specified. NOTE: The [CodePage](#CodePage) setting must be set to a value capable of interpreting the specified host name. For instance, to specify UTF-8, set [CodePage](#CodePage) to *65001*. In the C++ Edition for Windows, the *W version of the class must be used. For instance, *DNSW* or *HTTPW*.

**UseProxyAutoConfigURL**: Whether to use a Proxy auto-config file when attempting a connection.This configuration specifies whether the struct will attempt to use the Proxy auto-config URL when establishing a connection and [proxy_auto_detect](#proxy_auto_detect-property-googledrive-struct) is set to *True*.

When *True* (default), the struct will check for the existence of a Proxy auto-config URL, and if found, will determine the appropriate proxy to use.

**UserAgent**: Information about the user agent (browser).This is the value supplied in the HTTP User-Agent header. The default setting is "IPWorks HTTP Component - www.nsoftware.com".

Override the default with the name and version of your software.

### TCPClient Config Settings

**ConnectionTimeout**: Sets a separate timeout value for establishing a connection.When set, this configuration setting allows you to specify a different timeout value for establishing a connection. Otherwise, the struct will use [timeout](#timeout-property-googledrive-struct) for establishing a connection and transmitting/receiving data.

**FirewallAutoDetect**: Tells the struct whether or not to automatically detect and use firewall system settings, if available.This configuration setting is provided for use by structs that do not directly expose Firewall properties.

**FirewallHost**: Name or IP address of firewall (optional).If a [FirewallHost](#FirewallHost) is given, requested connections will be authenticated through the specified firewall when connecting.

If the [FirewallHost](#FirewallHost) setting is set to a Domain Name, a DNS request is initiated. Upon successful termination of the request, the [FirewallHost](#FirewallHost) setting is set to the corresponding address. If the search is not successful, an error is returned.

NOTE: This setting is provided for use by structs that do not directly expose Firewall properties.

**FirewallHTTPVersion**: The HTTP version to be used when connecting through a tunneling proxy.When [FirewallType](#FirewallType) is set to a tunneling proxy, this setting dictates which HTTP version is used when connecting.

**FirewallPassword**: Password to be used if authentication is to be used when connecting through the firewall.If [FirewallHost](#FirewallHost) is specified, the [FirewallUser](#FirewallUser) and [FirewallPassword](#FirewallPassword) settings are used to connect and authenticate to the given firewall. If the authentication fails, the struct fails with an error.

NOTE: This setting is provided for use by structs that do not directly expose Firewall properties.

**FirewallPort**: The TCP port for the FirewallHost;.The [FirewallPort](#FirewallPort) is set automatically when [FirewallType](#FirewallType) is set to a valid value.

NOTE: This configuration setting is provided for use by structs that do not directly expose Firewall properties.

**FirewallType**: Determines the type of firewall to connect through.Possible values are as follows:

|  |  |
| --- | --- |
| 0 | No firewall (default setting). |
| 1 | Connect through a tunneling proxy. [FirewallPort](#FirewallPort) is set to 80. |
| 2 | Connect through a SOCKS4 Proxy. [FirewallPort](#FirewallPort) is set to 1080. |
| 3 | Connect through a SOCKS5 Proxy. [FirewallPort](#FirewallPort) is set to 1080. |
| 10 | Connect through a SOCKS4A Proxy. [FirewallPort](#FirewallPort) is set to 1080. |

NOTE: This setting is provided for use by structs that do not directly expose Firewall properties.

**FirewallUser**: A user name if authentication is to be used connecting through a firewall.If the [FirewallHost](#FirewallHost) is specified, the [FirewallUser](#FirewallUser) and [FirewallPassword](#FirewallPassword) settings are used to connect and authenticate to the Firewall. If the authentication fails, the struct fails with an error.

NOTE: This setting is provided for use by structs that do not directly expose Firewall properties.

**KeepAliveInterval**: The retry interval, in milliseconds, to be used when a TCP keep-alive packet is sent and no response is received.When set, [TCPKeepAlive](#TCPKeepAlive) will automatically be set to True. A TCP keep-alive packet will be sent after a period of inactivity as defined by [KeepAliveTime](#KeepAliveTime). If no acknowledgment is received from the remote host, the keep-alive packet will be sent again. This configuration setting specifies the interval at which the successive keep-alive packets are sent in milliseconds. This system default if this value is not specified here is 1 second.

NOTE: This value is not applicable in macOS.

**KeepAliveTime**: The inactivity time in milliseconds before a TCP keep-alive packet is sent.When set, [TCPKeepAlive](#TCPKeepAlive) will automatically be set to True. By default, the operating system will determine the time a connection is idle before a Transmission Control Protocol (TCP) keep-alive packet is sent. This system default if this value is not specified here is 2 hours. In many cases, a shorter interval is more useful. Set this value to the desired interval in milliseconds.

**Linger**: When set to True, connections are terminated gracefully.This property controls how a connection is closed. The default is True.

In the case that Linger is True (default), two scenarios determine how long the connection will linger. In the first, if [LingerTime](#LingerTime) is 0 (default), the system will attempt to send pending data for a connection until the default IP timeout expires.

In the second scenario, if [LingerTime](#LingerTime) is a positive value, the system will attempt to send pending data until the specified [LingerTime](#LingerTime) is reached. If this attempt fails, then the system will reset the connection.

The default behavior (which is also the default mode for stream sockets) might result in a long delay in closing the connection. Although the struct returns control immediately, the system could hold system resources until all pending data are sent (even after your application closes).

Setting this property to False forces an immediate disconnection. If you know that the other side has received all the data you sent (e.g., by a client acknowledgment), setting this property to False might be the appropriate course of action.

**LingerTime**: Time in seconds to have the connection linger. LingerTime is the time, in seconds, the socket connection will linger. This value is 0 by default, which means it will use the default IP timeout.

**LocalHost**: The name of the local host through which connections are initiated or accepted. The [local_host](#local_host-property-googledrive-struct) setting 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 value of an interface will make the struct initiate connections (or accept in the case of server structs) only through that interface.

If the struct is connected, the [local_host](#local_host-property-googledrive-struct) setting 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).

**LocalPort**: The port in the local host where the struct binds. This configuration setting must be set before a connection is attempted. It instructs the struct to bind to a specific port (or communication endpoint) in the local machine.

Setting this to 0 (default) enables the system to choose a port at random. The chosen port will be shown by local_port after the connection is established.

local_port cannot be changed once a connection is made. Any attempt to set this when a connection is active will generate an error.

This configuration setting is useful when trying to connect to services that require a trusted port on the client side. An example is the remote shell (rsh) service in UNIX systems.

**MaxLineLength**: The maximum amount of data to accumulate when no EOL is found.[MaxLineLength](#MaxLineLength) is the size of an internal buffer, which holds received data while waiting for an eol string.

If an eol string is found in the input stream before [MaxLineLength](#MaxLineLength) bytes are received, the on_data_in event is fired with the *EOL* parameter set to True, and the buffer is reset.

If no eol is found, and [MaxLineLength](#MaxLineLength) bytes are accumulated in the buffer, the on_data_in event is fired with the *EOL* parameter set to False, and the buffer is reset.

The minimum value for [MaxLineLength](#MaxLineLength) is 256 bytes. The default value is 2048 bytes.

**MaxTransferRate**: The transfer rate limit in bytes per second.This configuration setting can be used to throttle outbound TCP traffic. Set this to the number of bytes to be sent per second. By default, this is not set and there is no limit.

**ProxyExceptionsList**: A semicolon separated list of hosts and IPs to bypass when using a proxy.This configuration setting optionally specifies a semicolon-separated list of hostnames or IP addresses to bypass when a proxy is in use. When requests are made to hosts specified in this property, the proxy will not be used. For instance:

*www.google.com;www.example.com*

**TCPKeepAlive**: Determines whether or not the keep alive socket option is enabled.If set to True, the socket's keep-alive option is enabled and keep-alive packets will be sent periodically to maintain the connection. Set [KeepAliveTime](#KeepAliveTime) and [KeepAliveInterval](#KeepAliveInterval) to configure the timing of the keep-alive packets.

NOTE: This value is not applicable in Java.

**TcpNoDelay**: Whether or not to delay when sending packets. When set to True, the socket will send all data that are ready to send at once. When set to False, the socket will send smaller buffered packets of data at small intervals. This is known as the Nagle algorithm.

By default, this configuration setting is set to False.

**UseIPv6**: Whether to use IPv6.When set to *0* (default), the struct will use IPv4 exclusively. When set to *1*, the struct will use IPv6 exclusively. To instruct the struct to prefer IPv6 addresses, but use IPv4 if IPv6 is not supported on the system, this setting should be set to *2*. The default value is *0*. Possible values are as follows:

|  |  |
| --- | --- |
| 0 | IPv4 only |
| 1 | IPv6 only |
| 2 | IPv6 with IPv4 fallback |

**UseNTLMv2**: Whether to use NTLM V2.When authenticating with NTLM, this setting specifies whether NTLM V2 is used. By default this value is True and NTLM V2 will be used. Set this to False to use NTLM V1.

### SSL Config Settings

**LogSSLPackets**: Controls whether SSL packets are logged when using the internal security API.When [ssl_provider](#ssl_provider-property-googledrive-struct) is set to *Internal*, this configuration setting controls whether Secure Sockets Layer (SSL) packets should be logged. By default, this configuration setting is *False*, as it is useful only for debugging purposes.

When enabled, SSL packet logs are output using the [on_ssl_status](#on_ssl_status-event-googledrive-struct) event, which will fire each time an SSL packet is sent or received.

Enabling this configuration setting has no effect if [ssl_provider](#ssl_provider-property-googledrive-struct) is set to *Platform*.

**OpenSSLCADir**: The path to a directory containing CA certificates.This functionality is available only when the provider is OpenSSL.

The path set by this property should point to a directory containing CA certificates in PEM format. The files each contain one CA certificate. The files are looked up by the CA subject name hash value, which must hence be available. If more than one CA certificate with the same name hash value exist, the extension must be different (e.g., 9d66eef0.0, 9d66eef0.1). OpenSSL recommends the use of the c_rehash utility to create the necessary links. Please refer to the OpenSSL man page SSL_CTX_load_verify_locations(3) for details.

**OpenSSLCAFile**: Name of the file containing the list of CA's trusted by your application.This functionality is available only when the provider is OpenSSL.

The file set by this property should contain a list of CA certificates in PEM format. The file can contain several CA certificates identified by the following sequences:

 -----BEGIN CERTIFICATE-----

 ... (CA certificate in base64 encoding) ...

 -----END CERTIFICATE-----

 Before, between, and after the certificate text is allowed, which can be used, for example, for descriptions of the certificates. Refer to the OpenSSL man page SSL_CTX_load_verify_locations(3) for details.

**OpenSSLCipherList**: A string that controls the ciphers to be used by SSL.This functionality is available only when the provider is OpenSSL.

The format of this string is described in the OpenSSL man page ciphers(1) section "CIPHER LIST FORMAT". Please refer to it for details. The default string "DEFAULT" is determined at compile time and is normally equivalent to "ALL:!ADH:RC4+RSA:+SSLv2:@STRENGTH".

**OpenSSLPrngSeedData**: The data to seed the pseudo random number generator (PRNG).This functionality is available only when the provider is OpenSSL.

By default, OpenSSL uses the device file "/dev/urandom" to seed the PRNG, and setting OpenSSLPrngSeedData is not required. If set, the string specified is used to seed the PRNG.

**ReuseSSLSession**: Determines if the SSL session is reused.

If set to True, the struct will reuse the context if and only if the following criteria are met:

- The target host name is the same.
- The system cache entry has not expired (default timeout is 10 hours).
- The application process that calls the function is the same.
- The logon session is the same.
- The instance of the struct is the same.

**SSLCACerts**: A newline separated list of CA certificates to be included when performing an SSL handshake.When [ssl_provider](#ssl_provider-property-googledrive-struct) is set to *Internal*, this configuration setting specifies one or more CA certificates to be included with the ssl_cert property. Some servers or clients require the entire chain, including CA certificates, to be presented when performing SSL authentication. The value of this configuration setting is a newline-separated (CR/LF) list of certificates. For instance:

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

**SSLCheckCRL**: Whether to check the Certificate Revocation List for the server certificate.This configuration setting specifies whether the struct will check the Certificate Revocation List (CRL) specified by the server certificate. If set to 1 or 2, the struct will first obtain the list of CRL URLs from the server certificate's CRL distribution points extension. The struct will then make HTTP requests to each CRL endpoint to check the validity of the server's certificate. If the certificate has been revoked or any other issues are found during validation the struct fails with an error.

When set to 0 (default), the CRL check will not be performed by the struct. When set to 1, it will attempt to perform the CRL check, but it will continue without an error if the server's certificate does not support CRL. When set to 2, it will perform the CRL check and will throw an error if CRL is not supported.

This configuration setting is supported only in the Java, C#, and C++ editions. In the C++ edition, it is supported only on Windows operating systems.

**SSLCheckOCSP**: Whether to use OCSP to check the status of the server certificate.This configuration setting specifies whether the struct will use OCSP to check the validity of the server certificate. If set to 1 or 2, the struct will first obtain the Online Certificate Status Protocol (OCSP) URL from the server certificate's OCSP extension. The struct will then locate the issuing certificate and make an HTTP request to the OCSP endpoint to check the validity of the server's certificate. If the certificate has been revoked or any other issues are found during validation, the struct fails with an error.

When set to 0 (default), the struct will not perform an OCSP check. When set to 1, it will attempt to perform the OCSP check, but it will continue without an error if the server's certificate does not support OCSP. When set to 2, it will perform the OCSP check and will throw an error if OCSP is not supported.

This configuration setting is supported only in the Java, C#, and C++ editions. In the C++ edition, it is supported only on Windows operating systems.

**SSLCipherStrength**: The minimum cipher strength used for bulk encryption. This minimum cipher strength is largely dependent on the security modules installed on the system. If the cipher strength specified is not supported, an error will be returned when connections are initiated.

NOTE: This configuration setting contains the minimum cipher strength requested from the security library. The actual cipher strength used for the connection is shown by the [on_ssl_status](#on_ssl_status-event-googledrive-struct) event.

Use this configuration setting with caution. Requesting a lower cipher strength than necessary could potentially cause serious security vulnerabilities in your application.

When the provider is OpenSSL, [SSLCipherStrength](#SSLCipherStrength) is currently not supported. This functionality is instead made available through the [OpenSSLCipherList](#OpenSSLCipherList) configuration setting.

**SSLClientCACerts**: A newline separated list of CA certificates to use during SSL client certificate validation.This configuration setting is only applicable to server components (e.g., TCPServer) see [SSLServerCACerts](#SSLServerCACerts) for client components (e.g., TCPClient). This setting can be used to optionally specify one or more CA certificates to be used when verifying the client certificate that is presented by the client during the SSL handshake when ssl_authenticate_clients is enabled. When verifying the client's certificate, the certificates trusted by the system will be used as part of the verification process. If the client's CA certificates are not installed to the trusted system store, they may be specified here so they are included when performing the verification process. This configuration setting should be set only if the client's CA certificates are not already trusted on the system and cannot be installed to the trusted system store.

The value of this configuration setting is a newline-separated (CR/LF) list of certificates. For instance:

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

**SSLEnabledCipherSuites**: The cipher suite to be used in an SSL negotiation.This configuration setting enables the cipher suites to be used in SSL negotiation.

By default, the enabled cipher suites will include all available ciphers ("*").

The special value "*" means that the struct will pick all of the supported cipher suites. If [SSLEnabledCipherSuites](#SSLEnabledCipherSuites) is set to any other value, only the specified cipher suites will be considered.

Multiple cipher suites are separated by semicolons.

Example values when [ssl_provider](#ssl_provider-property-googledrive-struct) is set to *Platform* include the following:

```text
obj.config("SSLEnabledCipherSuites=*");
obj.config("SSLEnabledCipherSuites=CALG_AES_256");
obj.config("SSLEnabledCipherSuites=CALG_AES_256;CALG_3DES");
```

 Possible values when [ssl_provider](#ssl_provider-property-googledrive-struct) is set to *Platform* include the following:

- CALG_3DES
- CALG_3DES_112
- CALG_AES
- CALG_AES_128
- CALG_AES_192
- CALG_AES_256
- CALG_AGREEDKEY_ANY
- CALG_CYLINK_MEK
- CALG_DES
- CALG_DESX
- CALG_DH_EPHEM
- CALG_DH_SF
- CALG_DSS_SIGN
- CALG_ECDH
- CALG_ECDH_EPHEM
- CALG_ECDSA
- CALG_ECMQV
- CALG_HASH_REPLACE_OWF
- CALG_HUGHES_MD5
- CALG_HMAC
- CALG_KEA_KEYX
- CALG_MAC
- CALG_MD2
- CALG_MD4
- CALG_MD5
- CALG_NO_SIGN
- CALG_OID_INFO_CNG_ONLY
- CALG_OID_INFO_PARAMETERS
- CALG_PCT1_MASTER
- CALG_RC2
- CALG_RC4
- CALG_RC5
- CALG_RSA_KEYX
- CALG_RSA_SIGN
- CALG_SCHANNEL_ENC_KEY
- CALG_SCHANNEL_MAC_KEY
- CALG_SCHANNEL_MASTER_HASH
- CALG_SEAL
- CALG_SHA
- CALG_SHA1
- CALG_SHA_256
- CALG_SHA_384
- CALG_SHA_512
- CALG_SKIPJACK
- CALG_SSL2_MASTER
- CALG_SSL3_MASTER
- CALG_SSL3_SHAMD5
- CALG_TEK
- CALG_TLS1_MASTER
- CALG_TLS1PRF

 Example values when [ssl_provider](#ssl_provider-property-googledrive-struct) is set to *Internal*include the following:

```text
obj.config("SSLEnabledCipherSuites=*");
obj.config("SSLEnabledCipherSuites=TLS_DHE_DSS_WITH_AES_128_CBC_SHA");
obj.config("SSLEnabledCipherSuites=TLS_DHE_DSS_WITH_AES_128_CBC_SHA;TLS_ECDH_RSA_WITH_AES_128_CBC_SHA");
```

 Possible values when [ssl_provider](#ssl_provider-property-googledrive-struct) is set to *Internal* include the following:

- TLS_ECDHE_ECDSA_WITH_AES_256_GCM_SHA384
- TLS_ECDHE_ECDSA_WITH_AES_128_GCM_SHA256
- TLS_ECDHE_RSA_WITH_AES_128_GCM_SHA256
- TLS_ECDHE_RSA_WITH_AES_256_GCM_SHA384
- TLS_ECDH_ECDSA_WITH_AES_256_GCM_SHA384
- TLS_RSA_WITH_AES_256_GCM_SHA384
- TLS_RSA_WITH_AES_128_GCM_SHA256
- TLS_ECDH_ECDSA_WITH_AES_128_GCM_SHA256
- TLS_DHE_DSS_WITH_AES_256_GCM_SHA384
- TLS_DHE_RSA_WITH_AES_256_GCM_SHA384
- TLS_ECDH_RSA_WITH_AES_256_GCM_SHA384
- TLS_ECDH_RSA_WITH_AES_128_GCM_SHA256
- TLS_DHE_RSA_WITH_AES_128_GCM_SHA256
- TLS_DHE_DSS_WITH_AES_128_GCM_SHA256
- TLS_ECDHE_ECDSA_WITH_AES_256_CBC_SHA384
- TLS_ECDHE_ECDSA_WITH_AES_128_CBC_SHA256
- TLS_ECDH_ECDSA_WITH_AES_256_CBC_SHA384
- TLS_DHE_DSS_WITH_AES_256_CBC_SHA256
- TLS_RSA_WITH_AES_256_CBC_SHA256
- TLS_ECDHE_RSA_WITH_AES_256_CBC_SHA384
- TLS_ECDH_RSA_WITH_AES_256_CBC_SHA384
- TLS_DHE_RSA_WITH_AES_256_CBC_SHA256
- TLS_DHE_RSA_WITH_AES_128_CBC_SHA256
- TLS_ECDHE_RSA_WITH_AES_128_CBC_SHA256
- TLS_RSA_WITH_AES_128_CBC_SHA256
- TLS_ECDH_ECDSA_WITH_AES_128_CBC_SHA256
- TLS_ECDH_RSA_WITH_AES_128_CBC_SHA256
- TLS_DHE_DSS_WITH_AES_128_CBC_SHA256
- TLS_RSA_WITH_AES_256_CBC_SHA
- TLS_ECDHE_ECDSA_WITH_AES_256_CBC_SHA
- TLS_ECDHE_RSA_WITH_AES_256_CBC_SHA
- TLS_ECDH_ECDSA_WITH_AES_256_CBC_SHA
- TLS_DHE_RSA_WITH_AES_256_CBC_SHA
- TLS_ECDH_RSA_WITH_AES_256_CBC_SHA
- TLS_DHE_DSS_WITH_AES_256_CBC_SHA
- TLS_RSA_WITH_AES_128_CBC_SHA
- TLS_ECDHE_RSA_WITH_AES_128_CBC_SHA
- TLS_ECDHE_ECDSA_WITH_AES_128_CBC_SHA
- TLS_ECDH_ECDSA_WITH_AES_128_CBC_SHA
- TLS_ECDH_RSA_WITH_AES_128_CBC_SHA
- TLS_DHE_RSA_WITH_AES_128_CBC_SHA
- TLS_DHE_DSS_WITH_AES_128_CBC_SHA
- TLS_ECDHE_ECDSA_WITH_3DES_EDE_CBC_SHA
- TLS_ECDHE_RSA_WITH_3DES_EDE_CBC_SHA
- TLS_ECDH_ECDSA_WITH_3DES_EDE_CBC_SHA
- TLS_ECDH_RSA_WITH_3DES_EDE_CBC_SHA
- TLS_DHE_RSA_WITH_3DES_EDE_CBC_SHA
- TLS_DHE_DSS_WITH_3DES_EDE_CBC_SHA
- TLS_RSA_WITH_3DES_EDE_CBC_SHA
- TLS_RSA_WITH_DES_CBC_SHA
- TLS_DHE_RSA_WITH_DES_CBC_SHA
- TLS_DHE_DSS_WITH_DES_CBC_SHA
- TLS_RSA_WITH_RC4_128_MD5
- TLS_RSA_WITH_RC4_128_SHA

When TLS 1.3 is negotiated (see [SSLEnabledProtocols](#SSLEnabledProtocols)), only the following cipher suites are supported:

- TLS_AES_256_GCM_SHA384
- TLS_CHACHA20_POLY1305_SHA256
- TLS_AES_128_GCM_SHA256

[SSLEnabledCipherSuites](#SSLEnabledCipherSuites) is used together with [SSLCipherStrength](#SSLCipherStrength).

**SSLEnabledProtocols**: Used to enable/disable the supported security protocols.This configuration setting is used to enable or disable the supported security protocols.

Not all supported protocols are enabled by default. The default value is *4032* for client components, and *3072* for server components. To specify a combination of enabled protocol versions set this config to the binary *OR* of one or more of the following values:

|  |  |
| --- | --- |
| TLS1.3 | 12288 (Hex 3000) |
| TLS1.2 | 3072 (Hex C00) (Default - Client and Server) |
| TLS1.1 | 768 (Hex 300) (Default - Client) |
| TLS1 | 192 (Hex C0) (Default - Client) |
| SSL3 | 48 (Hex 30) |
| SSL2 | 12 (Hex 0C) |

Note that only TLS 1.2 is enabled for server components that accept incoming connections. This adheres to industry standards to ensure a secure connection. Client components enable TLS 1.0, TLS 1.1, and TLS 1.2 by default and will negotiate the highest mutually supported version when connecting to a server, which should be TLS 1.2 in most cases.

**SSLEnabledProtocols: Transport Layer Security (TLS) 1.3 Notes:**

By default when TLS 1.3 is enabled, the struct will first try to use the platform TLS 1.3 implementation when the [ssl_provider](#ssl_provider-property-googledrive-struct) is set to Automatic for all editions. If the platform TLS 1.3 implementation is not available, the internal implementation will be used.

In editions that are designed to run on Windows, [ssl_provider](#ssl_provider-property-googledrive-struct) can be set to Platform to use the platform implementation instead of the internal implementation. When configured in this manner, please note that the platform provider is supported only on Windows 11/Windows Server 2022 and up. The default internal provider is available on all platforms and is not restricted to any specific OS version.

If set to *1* (Platform provider), please be aware of the following notes:

- The platform provider is available only on Windows 11/Windows Server 2022 and up.
- [SSLEnabledCipherSuites](#SSLEnabledCipherSuites) and other similar SSL configuration settings are not supported.
- If [SSLEnabledProtocols](#SSLEnabledProtocols) includes both TLS 1.3 and TLS 1.2, these restrictions are still applicable even if TLS 1.2 is negotiated. Enabling TLS 1.3 with the platform provider changes the implementation used for all TLS versions.

**SSLEnabledProtocols: SSL2 and SSL3 Notes: **

SSL 2.0 and 3.0 are not supported by the struct when the [ssl_provider](#ssl_provider-property-googledrive-struct) is set to internal. To use SSL 2.0 or SSL 3.0, the platform security API must have the protocols enabled and [ssl_provider](#ssl_provider-property-googledrive-struct) needs to be set to platform.

**SSLEnableRenegotiation**: Whether the renegotiation_info SSL extension is supported.This configuration setting specifies whether the renegotiation_info SSL extension will be used in the request when using the internal security API. This configuration setting is *false* by default, but it can be set to *true* to enable the extension.

This configuration setting is applicable only when [ssl_provider](#ssl_provider-property-googledrive-struct) is set to *Internal*.

**SSLIncludeCertChain**: Whether the entire certificate chain is included in the SSLServerAuthentication event.This configuration setting specifies whether the Encoded parameter of the [on_ssl_server_authentication](#on_ssl_server_authentication-event-googledrive-struct) event contains the full certificate chain. By default this value is False and only the leaf certificate will be present in the Encoded parameter of the [on_ssl_server_authentication](#on_ssl_server_authentication-event-googledrive-struct) event.

If set to True, all certificates returned by the server will be present in the Encoded parameter of the [on_ssl_server_authentication](#on_ssl_server_authentication-event-googledrive-struct) event. This includes the leaf certificate, any intermediate certificate, and the root certificate.

**SSLKeyLogFile**: The location of a file where per-session secrets are written for debugging purposes.This configuration setting optionally specifies the full path to a file on disk where per-session secrets are stored for debugging purposes.

When set, the struct will save the session secrets in the same format as the SSLKEYLOGFILE environment variable functionality used by most major browsers and tools, such as Chrome, Firefox, and cURL. This file can then be used in tools such as Wireshark to decrypt TLS traffic for debugging purposes. When writing to this file, the struct will only append, it will not overwrite previous values.

NOTE: This configuration setting is applicable only when [ssl_provider](#ssl_provider-property-googledrive-struct) is set to *Internal*.

**SSLNegotiatedCipher**: Returns the negotiated cipher suite.This configuration setting returns the cipher suite negotiated during the SSL handshake.

NOTE: For server components (e.g., TCPServer), this is a per-connection configuration setting accessed by passing the ConnectionId. For example:

```csharp
server.Config("SSLNegotiatedCipher[connId]");
```

**SSLNegotiatedCipherStrength**: Returns the negotiated cipher suite strength.This configuration setting returns the strength of the cipher suite negotiated during the SSL handshake.

NOTE: For server components (e.g., TCPServer), this is a per-connection configuration setting accessed by passing the ConnectionId. For example:

```csharp
server.Config("SSLNegotiatedCipherStrength[connId]");
```

**SSLNegotiatedCipherSuite**: Returns the negotiated cipher suite.This configuration setting returns the cipher suite negotiated during the SSL handshake represented as a single string.

NOTE: For server components (e.g., TCPServer), this is a per-connection configuration setting accessed by passing the ConnectionId. For example:

```csharp
server.Config("SSLNegotiatedCipherSuite[connId]");
```

**SSLNegotiatedKeyExchange**: Returns the negotiated key exchange algorithm.This configuration setting returns the key exchange algorithm negotiated during the SSL handshake.

NOTE: For server components (e.g., TCPServer), this is a per-connection configuration setting accessed by passing the ConnectionId. For example:

```csharp
server.Config("SSLNegotiatedKeyExchange[connId]");
```

**SSLNegotiatedKeyExchangeStrength**: Returns the negotiated key exchange algorithm strength.This configuration setting returns the strength of the key exchange algorithm negotiated during the SSL handshake.

NOTE: For server components (e.g., TCPServer), this is a per-connection configuration setting accessed by passing the ConnectionId. For example:

```csharp
server.Config("SSLNegotiatedKeyExchangeStrength[connId]");
```

**SSLNegotiatedVersion**: Returns the negotiated protocol version.This configuration setting returns the protocol version negotiated during the SSL handshake.

NOTE: For server components (e.g., TCPServer), this is a per-connection configuration setting accessed by passing the ConnectionId. For example:

```csharp
server.Config("SSLNegotiatedVersion[connId]");
```

**SSLSecurityFlags**: Flags that control certificate verification.The following flags are defined (specified in hexadecimal notation). They can be ORed together to exclude multiple conditions:

|  |  |
| --- | --- |
| 0x00000001 | Ignore time validity status of certificate. |
| 0x00000002 | Ignore time validity status of CTL. |
| 0x00000004 | Ignore non-nested certificate times. |
| 0x00000010 | Allow unknown certificate authority. |
| 0x00000020 | Ignore wrong certificate usage. |
| 0x00000100 | Ignore unknown certificate revocation status. |
| 0x00000200 | Ignore unknown CTL signer revocation status. |
| 0x00000400 | Ignore unknown certificate authority revocation status. |
| 0x00000800 | Ignore unknown root revocation status. |
| 0x00008000 | Allow test root certificate. |
| 0x00004000 | Trust test root certificate. |
| 0x80000000 | Ignore non-matching CN (certificate CN non-matching server name). |

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

**SSLServerCACerts**: A newline separated list of CA certificates to use during SSL server certificate validation.This configuration setting is only used by client components (e.g., TCPClient) see [SSLClientCACerts](#SSLClientCACerts) for server components (e.g., TCPServer). This configuration setting can be used to optionally specify one or more CA certificates to be used when connecting to the server and verifying the server certificate. When verifying the server's certificate, the certificates trusted by the system will be used as part of the verification process. If the server's CA certificates are not installed to the trusted system store, they may be specified here so they are included when performing the verification process. This configuration setting should be set only if the server's CA certificates are not already trusted on the system and cannot be installed to the trusted system store.

The value of this configuration setting is a newline-separated (CR/LF) list of certificates. For instance:

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

**TLS12SignatureAlgorithms**: Defines the allowed TLS 1.2 signature algorithms when SSLProvider is set to Internal.This configuration setting specifies the allowed server certificate signature algorithms when [ssl_provider](#ssl_provider-property-googledrive-struct) is set to *Internal* and [SSLEnabledProtocols](#SSLEnabledProtocols) is set to allow TLS 1.2.

When specified the struct will verify that the server certificate signature algorithm is among the values specified in this configuration setting. If the server certificate signature algorithm is unsupported, the struct fails with an error.

The format of this value is a comma-separated list of hash-signature combinations. For instance:

```csharp
component.SSLProvider = TCPClientSSLProviders.sslpInternal;
component.Config("SSLEnabledProtocols=3072"); //TLS 1.2
component.Config("TLS12SignatureAlgorithms=sha256-rsa,sha256-dsa,sha1-rsa,sha1-dsa");
```

 The default value for this configuration setting is *sha512-ecdsa,sha512-rsa,sha512-dsa,sha384-ecdsa,sha384-rsa,sha384-dsa,sha256-ecdsa,sha256-rsa,sha256-dsa,sha224-ecdsa,sha224-rsa,sha224-dsa,sha1-ecdsa,sha1-rsa,sha1-dsa*.

To not restrict the server's certificate signature algorithm, specify an empty string as the value for this configuration setting, which will cause the signature_algorithms TLS 1.2 extension to not be sent.

**TLS12SupportedGroups**: The supported groups for ECC.This configuration setting specifies a comma-separated list of named groups used in TLS 1.2 for ECC.

The default value is *ecdhe_secp256r1,ecdhe_secp384r1,ecdhe_secp521r1*.

When using TLS 1.2 and [ssl_provider](#ssl_provider-property-googledrive-struct) is set to *Internal*, the values refer to the supported groups for ECC. The following values are supported:

- "ecdhe_secp256r1" (default)
- "ecdhe_secp384r1" (default)
- "ecdhe_secp521r1" (default)

**TLS13KeyShareGroups**: The groups for which to pregenerate key shares.This configuration setting specifies a comma-separated list of named groups used in TLS 1.3 for key exchange. The groups specified here will have key share data pregenerated locally before establishing a connection. This can prevent an additional roundtrip during the handshake if the group is supported by the server.

The default value is set to balance common supported groups and the computational resources required to generate key shares. As a result, only some groups are included by default in this configuration setting.

NOTE: All supported groups can always be used during the handshake even if not listed here, but if a group is used that is not present in this list, it will incur an additional roundtrip and time to generate the key share for that group.

In most cases, this configuration setting does not need to be modified. This should be modified only if there is a specific reason to do so.

The default value is *ecdhe_x25519,ecdhe_secp256r1,ecdhe_secp384r1,ffdhe_2048,ffdhe_3072*

The values are ordered from most preferred to least preferred. The following values are supported:

- "ecdhe_x25519" (default)
- "ecdhe_x448"
- "ecdhe_secp256r1" (default)
- "ecdhe_secp384r1" (default)
- "ecdhe_secp521r1"
- "ffdhe_2048" (default)
- "ffdhe_3072" (default)
- "ffdhe_4096"
- "ffdhe_6144"
- "ffdhe_8192"

**TLS13SignatureAlgorithms**: The allowed certificate signature algorithms.This configuration setting holds a comma-separated list of allowed signature algorithms. Possible values include the following:

- "ed25519" (default)
- "ed448" (default)
- "ecdsa_secp256r1_sha256" (default)
- "ecdsa_secp384r1_sha384" (default)
- "ecdsa_secp521r1_sha512" (default)
- "rsa_pkcs1_sha256" (default)
- "rsa_pkcs1_sha384" (default)
- "rsa_pkcs1_sha512" (default)
- "rsa_pss_sha256" (default)
- "rsa_pss_sha384" (default)
- "rsa_pss_sha512" (default)

 The default value is *rsa_pss_sha256,rsa_pss_sha384,rsa_pss_sha512,rsa_pkcs1_sha256,rsa_pkcs1_sha384,rsa_pkcs1_sha512,ecdsa_secp256r1_sha256,ecdsa_secp384r1_sha384,ecdsa_secp521r1_sha512,ed25519,ed448*. This configuration setting is applicable only when [SSLEnabledProtocols](#SSLEnabledProtocols) includes TLS 1.3.

**TLS13SupportedGroups**: The supported groups for (EC)DHE key exchange.This configuration setting specifies a comma-separated list of named groups used in TLS 1.3 for key exchange. This configuration setting should be modified only if there is a specific reason to do so.

The default value is *ecdhe_x25519,ecdhe_x448,ecdhe_secp256r1,ecdhe_secp384r1,ecdhe_secp521r1,ffdhe_2048,ffdhe_3072,ffdhe_4096,ffdhe_6144,ffdhe_8192,mlkem_512,mlkem_768,mlkem_1024,x25519_mlkem_768,secp256r1_mlkem_768*

The values are ordered from most preferred to least preferred. The following values are supported:

- "ecdhe_x25519" (default)
- "ecdhe_x448" (default)
- "ecdhe_secp256r1" (default)
- "ecdhe_secp384r1" (default)
- "ecdhe_secp521r1" (default)
- "ffdhe_2048" (default)
- "ffdhe_3072" (default)
- "ffdhe_4096" (default)
- "ffdhe_6144" (default)
- "ffdhe_8192" (default)
- "mlkem_512" (default)
- "mlkem_768" (default)
- "mlkem_1024" (default)
- "x25519_mlkem_768" (default)
- "secp256r1_mlkem_768" (default)

Post-quantum algorithms (*mlkem_512,mlkem_768,mlkem_1024,x25519_mlkem_768,secp256r1_mlkem_768*) in our components rely on the operating system's underlying cryptographic primitives. The following platforms are currently supported:

-  Windows Server 2025
-  Windows 11 24H2
-  Windows 11 25H2

### Socket Config Settings

**AbsoluteTimeout**: Determines whether timeouts are inactivity timeouts or absolute timeouts.If [AbsoluteTimeout](#AbsoluteTimeout) is set to True, any method that does not complete within [timeout](#timeout-property-googledrive-struct) seconds will be aborted. By default, *AbsoluteTimeout* is False, and the timeout is an inactivity timeout.

NOTE: This option is not valid for User Datagram Protocol (UDP) ports.

**FirewallData**: Used to send extra data to the firewall.When the firewall is a tunneling proxy, use this property to send custom (additional) headers to the firewall (e.g., headers for custom authentication schemes).

**InBufferSize**: The size in bytes of the incoming queue of the socket.This is the size of an internal queue in the Transmission Control Protocol (TCP)/IP stack. You can increase or decrease its size depending on the amount of data that you will be receiving. In some cases, increasing the value of the *InBufferSize* setting can provide significant improvements in performance.

Some TCP/IP implementations do not support variable buffer sizes. If that is the case, when the struct is activated the *InBufferSize* reverts to its defined size. The same happens if you attempt to make it too large or too small.

**OutBufferSize**: The size in bytes of the outgoing queue of the socket.This is the size of an internal queue in the TCP/IP stack. You can increase or decrease its size depending on the amount of data that you will be sending. In some cases, increasing the value of the *OutBufferSize* setting can provide significant improvements in performance.

Some TCP/IP implementations do not support variable buffer sizes. If that is the case, when the struct is activated the *OutBufferSize* reverts to its defined size. The same happens if you attempt to make it too large or too small.

### Base Config Settings

**BuildInfo**: Information about the product's build.When queried, this setting will return a string containing information about the product's build.

**CodePage**: The system code page used for Unicode to Multibyte translations.The default code page is Unicode UTF-8 (65001).

The following is a list of valid code page identifiers:

|  |  |
| --- | --- |
| Identifier | Name |
| 037 | IBM EBCDIC - U.S./Canada |
| 437 | OEM - United States |
| 500 | IBM EBCDIC - International |
| 708 | Arabic - ASMO 708 |
| 709 | Arabic - ASMO 449+, BCON V4 |
| 710 | Arabic - Transparent Arabic |
| 720 | Arabic - Transparent ASMO |
| 737 | OEM - Greek (formerly 437G) |
| 775 | OEM - Baltic |
| 850 | OEM - Multilingual Latin I |
| 852 | OEM - Latin II |
| 855 | OEM - Cyrillic (primarily Russian) |
| 857 | OEM - Turkish |
| 858 | OEM - Multilingual Latin I + Euro symbol |
| 860 | OEM - Portuguese |
| 861 | OEM - Icelandic |
| 862 | OEM - Hebrew |
| 863 | OEM - Canadian-French |
| 864 | OEM - Arabic |
| 865 | OEM - Nordic |
| 866 | OEM - Russian |
| 869 | OEM - Modern Greek |
| 870 | IBM EBCDIC - Multilingual/ROECE (Latin-2) |
| 874 | ANSI/OEM - Thai (same as 28605, ISO 8859-15) |
| 875 | IBM EBCDIC - Modern Greek |
| 932 | ANSI/OEM - Japanese, Shift-JIS |
| 936 | ANSI/OEM - Simplified Chinese (PRC, Singapore) |
| 949 | ANSI/OEM - Korean (Unified Hangul Code) |
| 950 | ANSI/OEM - Traditional Chinese (Taiwan; Hong Kong SAR, PRC) |
| 1026 | IBM EBCDIC - Turkish (Latin-5) |
| 1047 | IBM EBCDIC - Latin 1/Open System |
| 1140 | IBM EBCDIC - U.S./Canada (037 + Euro symbol) |
| 1141 | IBM EBCDIC - Germany (20273 + Euro symbol) |
| 1142 | IBM EBCDIC - Denmark/Norway (20277 + Euro symbol) |
| 1143 | IBM EBCDIC - Finland/Sweden (20278 + Euro symbol) |
| 1144 | IBM EBCDIC - Italy (20280 + Euro symbol) |
| 1145 | IBM EBCDIC - Latin America/Spain (20284 + Euro symbol) |
| 1146 | IBM EBCDIC - United Kingdom (20285 + Euro symbol) |
| 1147 | IBM EBCDIC - France (20297 + Euro symbol) |
| 1148 | IBM EBCDIC - International (500 + Euro symbol) |
| 1149 | IBM EBCDIC - Icelandic (20871 + Euro symbol) |
| 1200 | Unicode UCS-2 Little-Endian (BMP of ISO 10646) |
| 1201 | Unicode UCS-2 Big-Endian |
| 1250 | ANSI - Central European |
| 1251 | ANSI - Cyrillic |
| 1252 | ANSI - Latin I |
| 1253 | ANSI - Greek |
| 1254 | ANSI - Turkish |
| 1255 | ANSI - Hebrew |
| 1256 | ANSI - Arabic |
| 1257 | ANSI - Baltic |
| 1258 | ANSI/OEM - Vietnamese |
| 1361 | Korean (Johab) |
| 10000 | MAC - Roman |
| 10001 | MAC - Japanese |
| 10002 | MAC - Traditional Chinese (Big5) |
| 10003 | MAC - Korean |
| 10004 | MAC - Arabic |
| 10005 | MAC - Hebrew |
| 10006 | MAC - Greek I |
| 10007 | MAC - Cyrillic |
| 10008 | MAC - Simplified Chinese (GB 2312) |
| 10010 | MAC - Romania |
| 10017 | MAC - Ukraine |
| 10021 | MAC - Thai |
| 10029 | MAC - Latin II |
| 10079 | MAC - Icelandic |
| 10081 | MAC - Turkish |
| 10082 | MAC - Croatia |
| 12000 | Unicode UCS-4 Little-Endian |
| 12001 | Unicode UCS-4 Big-Endian |
| 20000 | CNS - Taiwan |
| 20001 | TCA - Taiwan |
| 20002 | Eten - Taiwan |
| 20003 | IBM5550 - Taiwan |
| 20004 | TeleText - Taiwan |
| 20005 | Wang - Taiwan |
| 20105 | IA5 IRV International Alphabet No. 5 (7-bit) |
| 20106 | IA5 German (7-bit) |
| 20107 | IA5 Swedish (7-bit) |
| 20108 | IA5 Norwegian (7-bit) |
| 20127 | US-ASCII (7-bit) |
| 20261 | T.61 |
| 20269 | ISO 6937 Non-Spacing Accent |
| 20273 | IBM EBCDIC - Germany |
| 20277 | IBM EBCDIC - Denmark/Norway |
| 20278 | IBM EBCDIC - Finland/Sweden |
| 20280 | IBM EBCDIC - Italy |
| 20284 | IBM EBCDIC - Latin America/Spain |
| 20285 | IBM EBCDIC - United Kingdom |
| 20290 | IBM EBCDIC - Japanese Katakana Extended |
| 20297 | IBM EBCDIC - France |
| 20420 | IBM EBCDIC - Arabic |
| 20423 | IBM EBCDIC - Greek |
| 20424 | IBM EBCDIC - Hebrew |
| 20833 | IBM EBCDIC - Korean Extended |
| 20838 | IBM EBCDIC - Thai |
| 20866 | Russian - KOI8-R |
| 20871 | IBM EBCDIC - Icelandic |
| 20880 | IBM EBCDIC - Cyrillic (Russian) |
| 20905 | IBM EBCDIC - Turkish |
| 20924 | IBM EBCDIC - Latin-1/Open System (1047 + Euro symbol) |
| 20932 | JIS X 0208-1990 & 0121-1990 |
| 20936 | Simplified Chinese (GB2312) |
| 21025 | IBM EBCDIC - Cyrillic (Serbian, Bulgarian) |
| 21027 | Extended Alpha Lowercase |
| 21866 | Ukrainian (KOI8-U) |
| 28591 | ISO 8859-1 Latin I |
| 28592 | ISO 8859-2 Central Europe |
| 28593 | ISO 8859-3 Latin 3 |
| 28594 | ISO 8859-4 Baltic |
| 28595 | ISO 8859-5 Cyrillic |
| 28596 | ISO 8859-6 Arabic |
| 28597 | ISO 8859-7 Greek |
| 28598 | ISO 8859-8 Hebrew |
| 28599 | ISO 8859-9 Latin 5 |
| 28605 | ISO 8859-15 Latin 9 |
| 29001 | Europa 3 |
| 38598 | ISO 8859-8 Hebrew |
| 50220 | ISO 2022 Japanese with no halfwidth Katakana |
| 50221 | ISO 2022 Japanese with halfwidth Katakana |
| 50222 | ISO 2022 Japanese JIS X 0201-1989 |
| 50225 | ISO 2022 Korean |
| 50227 | ISO 2022 Simplified Chinese |
| 50229 | ISO 2022 Traditional Chinese |
| 50930 | Japanese (Katakana) Extended |
| 50931 | US/Canada and Japanese |
| 50933 | Korean Extended and Korean |
| 50935 | Simplified Chinese Extended and Simplified Chinese |
| 50936 | Simplified Chinese |
| 50937 | US/Canada and Traditional Chinese |
| 50939 | Japanese (Latin) Extended and Japanese |
| 51932 | EUC - Japanese |
| 51936 | EUC - Simplified Chinese |
| 51949 | EUC - Korean |
| 51950 | EUC - Traditional Chinese |
| 52936 | HZ-GB2312 Simplified Chinese |
| 54936 | Windows XP: GB18030 Simplified Chinese (4 Byte) |
| 57002 | ISCII Devanagari |
| 57003 | ISCII Bengali |
| 57004 | ISCII Tamil |
| 57005 | ISCII Telugu |
| 57006 | ISCII Assamese |
| 57007 | ISCII Oriya |
| 57008 | ISCII Kannada |
| 57009 | ISCII Malayalam |
| 57010 | ISCII Gujarati |
| 57011 | ISCII Punjabi |
| 65000 | Unicode UTF-7 |
| 65001 | Unicode UTF-8 |

 The following is a list of valid code page identifiers for Mac OS only:

|  |  |
| --- | --- |
| Identifier | Name |
| 1 | ASCII |
| 2 | NEXTSTEP |
| 3 | JapaneseEUC |
| 4 | UTF8 |
| 5 | ISOLatin1 |
| 6 | Symbol |
| 7 | NonLossyASCII |
| 8 | ShiftJIS |
| 9 | ISOLatin2 |
| 10 | Unicode |
| 11 | WindowsCP1251 |
| 12 | WindowsCP1252 |
| 13 | WindowsCP1253 |
| 14 | WindowsCP1254 |
| 15 | WindowsCP1250 |
| 21 | ISO2022JP |
| 30 | MacOSRoman |
| 10 | UTF16String |
| 0x90000100 | UTF16BigEndian |
| 0x94000100 | UTF16LittleEndian |
| 0x8c000100 | UTF32String |
| 0x98000100 | UTF32BigEndian |
| 0x9c000100 | UTF32LittleEndian |
| 65536 | Proprietary |

**LicenseInfo**: Information about the current license.When queried, this setting will return a string containing information about the license this instance of a struct is using. It will return the following information:

- Product: The product the license is for.
- Product Key: The key the license was generated from.
- License Source: Where the license was found (e.g., RuntimeLicense, License File).
- License Type: The type of license installed (e.g., Royalty Free, Single Server).
- Last Valid Build: The last valid build number for which the license will work.

**MaskSensitiveData**: Whether sensitive data is masked in log messages.In certain circumstances it may be beneficial to mask sensitive data, like passwords, in log messages. Set this to *true* to mask sensitive data. The default is *true*.

**UseInternalSecurityAPI**: Whether or not to use the system security libraries or an internal implementation. When set to *false*, the struct will use the system security libraries by default to perform cryptographic functions where applicable.

Setting this configuration setting to *true* tells the struct to use the internal implementation instead of using the system security libraries.

 On Windows, this setting is set to *false* by default. On Linux/macOS, this setting is set to *true* by default.

 To use the system security libraries for Linux, OpenSSL support must be enabled. For more information on how to enable OpenSSL, please refer to the [OpenSSL Notes](platforms.md) section.

# Trappable Errors ([GoogleDrive](#struct-cloudstoragegoogledrive) Struct)

### Common Errors

|  |  |
| --- | --- |
| 600 | A server error occurred, and/or the struct was unable to process the server's response. Please refer to the error message for more information. |
| 601 | An unsupported operation or action was attempted. |
| 602 | The [RawRequest](#RawRequest) or [RawResponse](#RawResponse) configuration setting was queried without first setting the TransferredRequest configuration setting to ON. |
| 603 | The login credentials specified were invalid. Please refer to the error message for more information. |
| 604 | An invalid remote resource identifier (i.e., a name, path, Id, etc.) was specified. |
| 605 | An invalid index was specified. |
| 606 | An upload was aborted by the user before it could finish. |
| 607 | The specified resource is a folder and cannot be downloaded. |
| 608 | A download failed because the specified [local_file](#local_file-property-googledrive-struct) already exists and [overwrite](#overwrite-property-googledrive-struct) is false. |
| 609 | The struct could not resume a download or upload. Please refer to the error message for more information. |
| 610 | An encrypted download could not be resumed because the [DownloadTempFile](#DownloadTempFile) configuration setting is not set. |
| 611 | An exception occurred while working with the specified [local_file](#local_file-property-googledrive-struct) (or the current value of [local_file](#local_file-property-googledrive-struct) is invalid). Please refer to the error message for more information. |
| 612 | An exception occurred while working with the specified upload or download stream. Please refer to the error message for more information. |

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

### HTTP Errors

|  |  |
| --- | --- |
| 118 | Firewall error. The error description contains the detailed message. |
| 143 | Busy executing current method. |
| 151 | HTTP protocol error. The error message has the server response. |
| 152 | No server specified in url. |
| 153 | Specified url_scheme is invalid. |
| 155 | Range operation is not supported by server. |
| 156 | Invalid cookie index (out of range). |
| 301 | Interrupted. |
| 302 | Cannot open attached_file. |

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

### TCPClient Errors

|  |  |
| --- | --- |
| 100 | You cannot change the remote_port at this time. A connection is in progress. |
| 101 | You cannot change the remote_host (Server) at this time. A connection is in progress. |
| 102 | The remote_host address is invalid (0.0.0.0). |
| 104 | Already connected. If you want to reconnect, close the current connection first. |
| 106 | You cannot change the local_port at this time. A connection is in progress. |
| 107 | You cannot change the [local_host](#local_host-property-googledrive-struct) at this time. A connection is in progress. |
| 112 | You cannot change [MaxLineLength](#MaxLineLength) at this time. A connection is in progress. |
| 116 | remote_port cannot be zero. Please specify a valid service port number. |
| 117 | You cannot change the UseConnection option while the struct is active. |
| 135 | Operation would block. |
| 201 | Timeout. |
| 211 | Action impossible in control's present state. |
| 212 | Action impossible while not connected. |
| 213 | Action impossible while listening. |
| 301 | Timeout. |
| 302 | Could not open file. |
| 434 | Unable to convert string to selected CodePage. |
| 1105 | Already connecting. If you want to reconnect, close the current connection first. |
| 1117 | You need to connect first. |
| 1119 | You cannot change the LocalHost at this time. A connection is in progress. |
| 1120 | Connection dropped by remote host. |

### SSL Errors

|  |  |
| --- | --- |
| 270 | Cannot load specified security library. |
| 271 | Cannot open certificate store. |
| 272 | Cannot find specified certificate. |
| 273 | Cannot acquire security credentials. |
| 274 | Cannot find certificate chain. |
| 275 | Cannot verify certificate chain. |
| 276 | Error during handshake. |
| 280 | Error verifying certificate. |
| 281 | Could not find client certificate. |
| 282 | Could not find server certificate. |
| 283 | Error encrypting data. |
| 284 | Error decrypting data. |

### TCP/IP Errors

|  |  |
| --- | --- |
| 10004 | [10004] Interrupted system call. |
| 10009 | [10009] Bad file number. |
| 10013 | [10013] Access denied. |
| 10014 | [10014] Bad address. |
| 10022 | [10022] Invalid argument. |
| 10024 | [10024] Too many open files. |
| 10035 | [10035] Operation would block. |
| 10036 | [10036] Operation now in progress. |
| 10037 | [10037] Operation already in progress. |
| 10038 | [10038] Socket operation on nonsocket. |
| 10039 | [10039] Destination address required. |
| 10040 | [10040] Message is too long. |
| 10041 | [10041] Protocol wrong type for socket. |
| 10042 | [10042] Bad protocol option. |
| 10043 | [10043] Protocol is not supported. |
| 10044 | [10044] Socket type is not supported. |
| 10045 | [10045] Operation is not supported on socket. |
| 10046 | [10046] Protocol family is not supported. |
| 10047 | [10047] Address family is not supported by protocol family. |
| 10048 | [10048] Address already in use. |
| 10049 | [10049] Cannot assign requested address. |
| 10050 | [10050] Network is down. |
| 10051 | [10051] Network is unreachable. |
| 10052 | [10052] Net dropped connection or reset. |
| 10053 | [10053] Software caused connection abort. |
| 10054 | [10054] Connection reset by peer. |
| 10055 | [10055] No buffer space available. |
| 10056 | [10056] Socket is already connected. |
| 10057 | [10057] Socket is not connected. |
| 10058 | [10058] Cannot send after socket shutdown. |
| 10059 | [10059] Too many references, cannot splice. |
| 10060 | [10060] Connection timed out. |
| 10061 | [10061] Connection refused. |
| 10062 | [10062] Too many levels of symbolic links. |
| 10063 | [10063] File name is too long. |
| 10064 | [10064] Host is down. |
| 10065 | [10065] No route to host. |
| 10066 | [10066] Directory is not empty |
| 10067 | [10067] Too many processes. |
| 10068 | [10068] Too many users. |
| 10069 | [10069] Disc Quota Exceeded. |
| 10070 | [10070] Stale NFS file handle. |
| 10071 | [10071] Too many levels of remote in path. |
| 10091 | [10091] Network subsystem is unavailable. |
| 10092 | [10092] WINSOCK DLL Version out of range. |
| 10093 | [10093] Winsock is not loaded yet. |
| 11001 | [11001] Host not found. |
| 11002 | [11002] Nonauthoritative 'Host not found' (try again or check DNS setup). |
| 11003 | [11003] Nonrecoverable errors: FORMERR, REFUSED, NOTIMP. |
| 11004 | [11004] Valid name, no data record (check DNS setup). |