GoogleDrive Class
Properties Methods Events Configuration Settings Errors
The GoogleDrive class makes it easy to upload, download, and manage files and folders within Google Drive.
Syntax
IPWorksCloudGoogleDrive
IPWorksCloudGoogleDriveSwift
Remarks
The GoogleDrive class provides an easy-to-use interface for Google Drive. Capabilities include uploading and downloading files, file and folder manipulation and organization, Google Shared Drive support, strong client-side file encryption functionality, and more.
To begin, first create an account and register your application with Google. Consult the Google Drive documentation for more information on this process.
Authentication
This class supports authentication via OAuth 2.0. First, perform OAuth authentication using the OAuth class or a separate process. Once complete you should have an authorization string which looks like:
Bearer ya29.AHES6ZSZEJzATdZYjeihDn5W-VrXSsxEZu5p0pclxGdKKQAssign this value to the Authorization property before attempting any operations. Consult the documentation for the service for more information about supported scope values and more details on OAuth authentication.
Listing Resources
The ListResources method is used to list resources within the scope specified by the ListResourcesScope property.
The ListChildren, ListParents, and GetResourceInfo methods are also available for finer-grained control.
// ResourceList event handler. googledrive.OnResourceList += (s, e) => { Console.WriteLine(e.Name); }; // List all of the current user's resources. googledrive.ListResourcesScope = GoogledriveListResourcesScopes.lrsUser; do { googledrive.ListResources(); for (int i = 0; i < googledrive.Resources.Count; i++) { // Process resources here. } } while (!string.IsNullOrEmpty(googledrive.ResourceMarker)); // List all of the resources in the specified shared drive. googledrive.SharedDrive = "wfsr789vusijfv"; googledrive.ListResourcesScope = GoogledriveListResourcesScopes.lrsSharedDrive; do { googledrive.ListResources(); for (int i = 0; i < googledrive.Resources.Count; i++) { // Process resources here. } } while (!string.IsNullOrEmpty(googledrive.ResourceMarker));
Downloading Files
The DownloadFile method is used to download files.
Download Notes
Downloading an Encrypted FileTo decrypt an encrypted file set EncryptionAlgorithm and EncryptionPassword before calling this method.
googledrive.LocalFile = "../MyFile.zip"; googledrive.DownloadFile(googledrive.Resources[0].Id, "");
Resuming Downloads
The class also supports resuming failed downloads by using the StartByte property. If a download is interrupted, set StartByte to the appropriate offset before calling this method to resume the download.
string downloadFile = "../MyFile.zip"; googledrive.LocalFile = downloadFile; googledrive.DownloadFile(googledrive.Resources[0].Id, ""); //The transfer is interrupted and DownloadFile() above fails. Later, resume the download: //Get the size of the partially downloaded file googledrive.StartByte = new FileInfo(downloadFile).Length; googledrive.DownloadFile(googledrive.Resources[0].Id, "");
Resuming Encrypted File Downloads
Resuming encrypted file downloads is only supported when LocalFile was set in the initial download attempt.
If LocalFile is set when beginning an encrypted download, the class creates a temporary file in TempPath to hold the encrypted data until the download is complete. If the download is interrupted, DownloadTempFile will be populated with the path of the temporary file that holds the partial data.
To resume, DownloadTempFile must be populated, along with StartByte, to allow the remainder of the encrypted data to be downloaded. Once the encrypted data is downloaded it will be decrypted and written to LocalFile.
googledrive.LocalFile = "../MyFile.zip"; googledrive.EncryptionPassword = "password"; googledrive.DownloadFile(googledrive.Resource[0].Id, ""); //The transfer is interrupted and DownloadFile() above fails. Later, resume the download: //Get the size of the partially download temp file googledrive.StartByte = new FileInfo(googledrive.Config("DownloadTempFile")).Length; googledrive.DownloadFile(googledrive.Resource[0].Id, "");
Uploading Files
The UploadFile method is used to upload files.
Upload Notes
Google Drive offers two ways to upload a file. For smaller files a simple upload option is provided to upload data in one request. This is the default option. For larger files, uploads can be fragmented into multiple pieces, allowing resuming of uploads that may be interrupted.
Simple
By default the class uses the simple upload mechanism.
googledrive.LocalFile = "../MyFile.zip"; googledrive.UploadFile("MyFile.zip", "");
Resumable
To enable resumable uploads set UseResumableUpload to true. This is recommended for large files. The class will automatically fragment the specified file into smaller pieces and upload each individually. FragmentSize may be set to specify the size of the fragment if desired. The default fragment size is 10 MB.
When UseResumableUpload is set to true and UploadFile is called, a resumable upload session is started by the class. ResumeURL is populated with a URL identifying the session (this value may be needed for additional operations if the upload does not complete normally).
During a resumable upload, the FragmentComplete event fires after each fragment is uploaded to indicate overall progress. The class also updates StartByte as necessary to indicate the current offset in the file.
If the upload is interrupted for any reason, resuming it is easy. First, verify that ResumeURL and StartByte are populated (if the same instance of the class is used, they should already be populated, and no special action should be needed). Then call UploadFile again to resume the upload at the specified StartByte offset.
Note that if the upload is not resumed after some time the upload session will expire. GetUploadStatus may be used to check the status of a resumable upload.
googledrive.LocalFile = "../MyFile.zip"; googledrive.UploadFile("MyFile.zip", ""); //The transfer is interrupted and UploadFile() above fails. Later, resume the download. //Using the same instance StartByte and ResumeURL are already populated from the previous //upload attempt. googledrive.UploadFile("MyFile.zip", "");
Shared Drive Support
The GoogleDrive class 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 class with Google Shared Drives, refer to both the shared-drive-specific documentation sections for commonly-used methods like ListResources, MoveResource, UpdatePermissions, etc.; and browse through the documentation for shared-drive-specific methods and properties such as the AddSharedDriveMember and ListSharedDrives methods, the SharedDrive property, etc.
Additional Functionality
The GoogleDrive class offers advanced functionality beyond simple uploads and downloads. For instance:
- Encrypt and decrypt files using the EncryptionAlgorithm and EncryptionPassword properties.
- Basic file and folder manipulation and organization using methods such as CopyResource, CreateFolder, DeleteResource, MoveResource, and UpdateResource.
- Enumeration and manipulation of parent-child relationships using the AddParents, ListChildren, ListParents, and RemoveParents methods.
- Resourcing trashing and deletion: DeleteResource, TrashResource, RestoreResource.
- Control over permissions using ListPermissions and UpdatePermissions.
- Change tracking with ListChanges.
- And more!
Property List
The following is the full list of the properties of the class with short descriptions. Click on the links for further details.
- accountCanCreateSharedDrives | Whether the account has permission to create shared drives. |
- accountDriveUsage | Amount of storage used in Google Drive. |
- accountEmail | The email address of the account. |
- accountName | The name of the account's user. |
- accountPermissionId | The permission Id associated with the account. |
- accountStorageQuota | The account's storage quota. |
- accountStorageUsage | Amount of storage used across all Google services. |
- accountTrashUsage | Amount of storage used by trashed items in Google Drive. |
- authorization | OAuth 2.0 Authorization Token. |
- changeMarker | A marker indicating what page of changes to return next. |
- changeCount | The number of records in the Change arrays. |
- changeRemoved:(int)changeIndex | Whether the file or shared drive has been removed. |
- changeResourceId:(int)changeIndex | The Id of the file to which the change applies. |
- changeSharedDriveId:(int)changeIndex | The Id of the shared drive. |
- changeTime:(int)changeIndex | The time of the change. |
- changeType:(int)changeIndex | Whether the change is for a file or a shared drive. |
- childMarker | A marker when child resources are paged. |
- childCount | The number of records in the Child arrays. |
- childContentAccessible:(int)childIndex | Whether the resource's content is accessible to less-privileged users. |
- childCreatedTime:(int)childIndex | The creation date of the resource. |
- childDescription:(int)childIndex | A short description of the resource. |
- childExtension:(int)childIndex | The file extension of the resource. |
- childId:(int)childIndex | The Id of the resource. |
- childMD5Checksum:(int)childIndex | The MD5 checksum of the file resource. |
- childMIMEType:(int)childIndex | The MIME type of the resource. |
- childModifiedTime:(int)childIndex | The last modified date of the resource. |
- childName:(int)childIndex | The name of the resource. |
- childOriginalName:(int)childIndex | The original name of the file resource. |
- childOwner:(int)childIndex | The name of the resource's owner. |
- childOwnerEmail:(int)childIndex | The email address of the resource's owner. |
- childParentIds:(int)childIndex | The Ids of the resource's parent folders. |
- childSharedDriveId:(int)childIndex | The Id of the shared drive the resource is in. |
- childSize:(int)childIndex | The size of the file resource in bytes. |
- childStarred:(int)childIndex | Whether the resource is starred. |
- childTrashed:(int)childIndex | Whether the resource is in the trash. |
- childType:(int)childIndex | The resource's type. |
- childViewed:(int)childIndex | Whether the resource has been viewed. |
- childViewLink:(int)childIndex | A link for opening the resource in a relevant Google editor or viewer in a browser. |
- encryptionAlgorithm | The encryption algorithm. |
- encryptionPassword | The encryption password. |
- firewallAutoDetect | This property tells the class whether or not to automatically detect and use firewall system settings, if available. |
- firewallType | This property determines the type of firewall to connect through. |
- firewallHost | This property contains the name or IP address of firewall (optional). |
- firewallPassword | This property contains a password if authentication is to be used when connecting through the firewall. |
- firewallPort | This property contains the TCP port for the firewall Host . |
- firewallUser | This property contains a user name if authentication is to be used connecting through a firewall. |
- idle | The current status of the class. |
- listResourcesScope | Controls the scope of the results when listing resources. |
- localFile | The location of the local file. |
- localHost | The name of the local host or user-assigned IP interface through which connections are initiated or accepted. |
- nextChangeMarker | A marker indicating what page of changes to return in the future. |
- otherHeaders | Other headers as determined by the user (optional). |
- overwrite | Determines if local files are overwritten. |
- parsedHeaderCount | The number of records in the ParsedHeader arrays. |
- parsedHeaderField:(int)parsedHeaderIndex | This property contains the name of the HTTP header (same case as it is delivered). |
- parsedHeaderValue:(int)parsedHeaderIndex | This property contains the header contents. |
- permissionMarker | A marker when permissions are paged. |
- permissionCount | The number of records in the Permission arrays. |
- permissionAllowFileDiscovery:(int)permissionIndex | Whether the permission allows the file or folder to be discovered through search. |
- permissionDomain:(int)permissionIndex | The domain to which the permission applies. |
- permissionEmail:(int)permissionIndex | The user or group to which the permission applies. |
- permissionId:(int)permissionIndex | The Id of the permission. |
- permissionModOp:(int)permissionIndex | The operation to perform on the permission. |
- permissionRole:(int)permissionIndex | The role specified by the permission. |
- permissionType:(int)permissionIndex | The set of users to which the permission applies. |
- proxyAuthScheme | This property is used to tell the class which type of authorization to perform when connecting to the proxy. |
- proxyAutoDetect | This property tells the class whether or not to automatically detect and use proxy system settings, if available. |
- proxyPassword | This property contains a password if authentication is to be used for the proxy. |
- proxyPort | This property contains the TCP port for the proxy Server (default 80). |
- proxyServer | If a proxy Server is given, then the HTTP request is sent to the proxy instead of the server otherwise specified. |
- proxySSL | This property determines when to use SSL for the connection to the proxy. |
- proxyUser | This property contains a user name, if authentication is to be used for the proxy. |
- queryParamCount | The number of records in the QueryParam arrays. |
- queryParamName:(int)queryParamIndex | The name of the query parameter. |
- queryParamValue:(int)queryParamIndex | The value of the query parameter. |
- resourceData | The data that was downloaded, or that should be uploaded. |
- resourceMarker | A marker indicating what page of resources to return next. |
- resourceCount | The number of records in the Resource arrays. |
- resourceContentAccessible:(int)resourceIndex | Whether the resource's content is accessible to less-privileged users. |
- resourceCreatedTime:(int)resourceIndex | The creation date of the resource. |
- resourceDescription:(int)resourceIndex | A short description of the resource. |
- resourceExtension:(int)resourceIndex | The file extension of the resource. |
- resourceId:(int)resourceIndex | The Id of the resource. |
- resourceMD5Checksum:(int)resourceIndex | The MD5 checksum of the file resource. |
- resourceMIMEType:(int)resourceIndex | The MIME type of the resource. |
- resourceModifiedTime:(int)resourceIndex | The last modified date of the resource. |
- resourceName:(int)resourceIndex | The name of the resource. |
- resourceOriginalName:(int)resourceIndex | The original name of the file resource. |
- resourceOwner:(int)resourceIndex | The name of the resource's owner. |
- resourceOwnerEmail:(int)resourceIndex | The email address of the resource's owner. |
- resourceParentIds:(int)resourceIndex | The Ids of the resource's parent folders. |
- resourceSharedDriveId:(int)resourceIndex | The Id of the shared drive the resource is in. |
- resourceSize:(int)resourceIndex | The size of the file resource in bytes. |
- resourceStarred:(int)resourceIndex | Whether the resource is starred. |
- resourceTrashed:(int)resourceIndex | Whether the resource is in the trash. |
- resourceType:(int)resourceIndex | The resource's type. |
- resourceViewed:(int)resourceIndex | Whether the resource has been viewed. |
- resourceViewLink:(int)resourceIndex | A link for opening the resource in a relevant Google editor or viewer in a browser. |
- resumeURL | The resumable upload URL. |
- sharedDrive | The shared drive to list file and folder resources for. |
- sharedDriveMarker | A marker when shared drives are paged. |
- sharedDriveCount | The number of records in the SharedDrive arrays. |
- sharedDriveCapabilities:(int)sharedDriveIndex | The capabilities that the current user has for the shared drive. |
- sharedDriveCreatedTime:(int)sharedDriveIndex | The creation date of the shared drive. |
- sharedDriveHidden:(int)sharedDriveIndex | Whether the shared drive is hidden from default view. |
- sharedDriveId:(int)sharedDriveIndex | The Id of the shared drive. |
- sharedDriveName:(int)sharedDriveIndex | The name of the shared drive. |
- sharedDriveRestrictions:(int)sharedDriveIndex | The restrictions that apply to the shared drive. |
- SSLAcceptServerCertEncoded | The certificate (PEM/base64 encoded). |
- SSLCertEncoded | The certificate (PEM/base64 encoded). |
- SSLCertStore | The name of the certificate store for the client certificate. |
- SSLCertStorePassword | 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. |
- SSLCertStoreType | The type of certificate store for this certificate. |
- SSLCertSubject | The subject of the certificate used for client authentication. |
- SSLServerCertEncoded | The certificate (PEM/base64 encoded). |
- startByte | The byte offset from which to start the upload or download. |
- timeout | A timeout for the class. |
- useResumableUpload | Whether to use resumable uploads. |
Method List
The following is the full list of the methods of the class with short descriptions. Click on the links for further details.
- addParents | Adds folders to the list of parents for a file or folder. |
- addQueryParam | Adds a query parameter to the QueryParams properties. |
- addSharedDriveMember | Creates a new shared drive member. |
- config | Sets or retrieves a configuration setting. |
- copyResource | Copies a file. |
- createFolder | Creates a new folder. |
- createSharedDrive | Creates a new shared drive. |
- deleteResource | Deletes the specified file or folder permanently. |
- deleteSharedDrive | Deletes a shared drive. |
- downloadFile | Downloads, and optionally converts, a file. |
- emptyTrash | Permanently deletes all of the current user's trashed files. |
- getAccountInfo | Gets information about the current user's account and space usage. |
- getCurrentChangeMarker | Gets the most current change marker. |
- getPermissionInfo | Gets information about a specific permission. |
- getResourceInfo | Gets information about specific files and folders. |
- getSharedDriveInfo | Gets information about a specific shared drive. |
- getUploadStatus | Gets the status of a resumable upload session. |
- interrupt | Interrupt the current method. |
- listChanges | Lists changes to resources and shared drives. |
- listChildren | Lists the child resources of one or more folders. |
- listParents | Lists the parent folders of a file or folder. |
- listPermissions | Lists the permissions for a file, folder, or shared drive. |
- listResources | Lists files and folders. |
- listSharedDrives | Lists shared drives that the current user is a member of. |
- moveResource | Moves a file or folder. |
- removeParents | Removes folders from the list of parents for a file or folder. |
- removeSharedDriveMember | Removes an existing shared drive member. |
- reset | Resets the class to its initial state. |
- restoreResource | Restores a file or folder from the trash. |
- sendCustomRequest | Sends a custom request to the Google Drive API. |
- toggleSharedDriveHidden | Hides or unhides a shared drive. |
- trashResource | Moves the specified file or folder to the trash. |
- updatePermissions | Create, update, and delete permissions on a file, folder, or shared drive. |
- updateResource | Updates a file or folder. |
- updateSharedDrive | Updates a shared drive. |
- updateSharedDriveMember | Updates an existing shared drive member's role. |
- uploadFile | Uploads, and optionally converts, a new file. |
Event List
The following is the full list of the events fired by the class with short descriptions. Click on the links for further details.
- onChangeList | Fires once for each change when ListChanges is called. |
- onEndTransfer | Fired when a document finishes transferring. |
- onError | Information about errors during data delivery. |
- onFragmentComplete | Fires after each fragment of a resumable upload is completed. |
- onHeader | Fired every time a header line comes in. |
- onLog | Fires once for each log message. |
- onPermissionList | This event fires once for each permission returned when listing permissions. |
- onProgress | Fires during an upload or download to indicate transfer progress. |
- onResourceList | Fires once for each resource returned when listing resources. |
- onSharedDriveList | Fires once for each shared drive returned when listing shared drives. |
- onSSLServerAuthentication | Fired after the server presents its certificate to the client. |
- onSSLStatus | Shows the progress of the secure connection. |
- onStartTransfer | Fired when a document starts transferring (after the headers). |
- onTransfer | Fired while a document transfers (delivers document). |
Configuration Settings
The following is a list of configuration settings for the class with short descriptions. Click on the links for further details.
AccumulatePages | Whether the class should accumulate subsequent pages of results when listing them. |
DocsExportFormat | The file format to export Google Docs files as when downloading. |
DownloadTempFile | The temporary file used when downloading encrypted data. |
DrawingsExportFormat | The file format to export Google Drawings files as when downloading. |
EncryptionIV | The initialization vector to be used for encryption/decryption. |
EncryptionKey | The key to use during encryption/decryption. |
FragmentSize | The fragment size. |
IconLink[i] | A static, unauthenticated link to the file icon for the specified resource. |
IncludeAllFields | Whether to request all fields when listing resources. |
IncludeFolderProperties | Whether resource properties apply when calling CreateFolder. |
ListResourcesMode | What items to include when listing resources. |
MaxPermissionResults | Limits the number of permissions results. |
MaxResults | Limits the number of resource and change results. |
MaxSharedDriveResults | Limits the number of shared drive results. |
NormalizedFileName[i] | File name constructed using the specified resource's information. |
ProgressAbsolute | Whether the class should track transfer progress absolutely. |
ProgressStep | How often the progress event should be fired, in terms of percentage. |
RawRequest | Returns the data that was sent to the server. |
RawResponse | Returns the data that was received from the server. |
ResourceKey[i] | The resource key used to access a file. |
SearchIncomplete | Indicates whether the server declined to search all possible locations when listing resources. |
SheetsExportFormat | The file format to export Google Sheets files as when downloading. |
SlidesExportFormat | The file format to export Google Slides files as when downloading. |
TempPath | The path to the directory where temporary files are created. |
TransferOwnership | Must be set to True before modifying permissions in a manner that causes the owner of a resource to change. |
UseDomainAdminAccess | Whether to make requests using domain administrator permissions. |
XChildCount | The number of child elements of the current element. |
XChildName[i] | The name of the child element. |
XChildXText[i] | The inner text of the child element. |
XElement | The name of the current element. |
XParent | The parent of the current element. |
XPath | Provides a way to point to a specific element in the returned XML or JSON response. |
XSubTree | A snapshot of the current element in the document. |
XText | The text of the current element. |
AcceptEncoding | Used to tell the server which types of content encodings the client supports. |
AllowHTTPCompression | This property enables HTTP compression for receiving data. |
AllowHTTPFallback | Whether HTTP/2 connections are permitted to fallback to HTTP/1.1. |
Append | Whether to append data to LocalFile. |
Authorization | The Authorization string to be sent to the server. |
BytesTransferred | Contains the number of bytes transferred in the response data. |
ChunkSize | Specifies the chunk size in bytes when using chunked encoding. |
CompressHTTPRequest | Set to true to compress the body of a PUT or POST request. |
EncodeURL | If set to true the URL will be encoded by the class. |
FollowRedirects | Determines what happens when the server issues a redirect. |
GetOn302Redirect | If set to true the class will perform a GET on the new location. |
HTTP2HeadersWithoutIndexing | HTTP2 headers that should not update the dynamic header table with incremental indexing. |
HTTPVersion | The version of HTTP used by the class. |
IfModifiedSince | A date determining the maximum age of the desired document. |
KeepAlive | Determines whether the HTTP connection is closed after completion of the request. |
KerberosSPN | The Service Principal Name for the Kerberos Domain Controller. |
LogLevel | The level of detail that is logged. |
MaxRedirectAttempts | Limits the number of redirects that are followed in a request. |
NegotiatedHTTPVersion | The negotiated HTTP version. |
OtherHeaders | Other headers as determined by the user (optional). |
ProxyAuthorization | The authorization string to be sent to the proxy server. |
ProxyAuthScheme | The authorization scheme to be used for the proxy. |
ProxyPassword | A password if authentication is to be used for the proxy. |
ProxyPort | Port for the proxy server (default 80). |
ProxyServer | Name or IP address of a proxy server (optional). |
ProxyUser | A user name if authentication is to be used for the proxy. |
SentHeaders | The full set of headers as sent by the client. |
StatusLine | The first line of the last response from the server. |
TransferredData | The contents of the last response from the server. |
TransferredDataLimit | The maximum number of incoming bytes to be stored by the class. |
TransferredHeaders | The full set of headers as received from the server. |
TransferredRequest | The full request as sent by the client. |
UseChunkedEncoding | Enables or Disables HTTP chunked encoding for transfers. |
UseIDNs | Whether to encode hostnames to internationalized domain names. |
UsePlatformHTTPClient | Whether or not to use the platform HTTP client. |
UserAgent | Information about the user agent (browser). |
ConnectionTimeout | Sets a separate timeout value for establishing a connection. |
FirewallAutoDetect | Tells the class whether or not to automatically detect and use firewall system settings, if available. |
FirewallHost | Name or IP address of firewall (optional). |
FirewallPassword | Password to be used if authentication is to be used when connecting through the firewall. |
FirewallPort | The TCP port for the FirewallHost;. |
FirewallType | Determines the type of firewall to connect through. |
FirewallUser | A user name if authentication is to be used connecting through a firewall. |
KeepAliveInterval | The retry interval, in milliseconds, to be used when a TCP keep-alive packet is sent and no response is received. |
KeepAliveTime | The inactivity time in milliseconds before a TCP keep-alive packet is sent. |
Linger | When set to True, connections are terminated gracefully. |
LingerTime | Time in seconds to have the connection linger. |
LocalHost | The name of the local host through which connections are initiated or accepted. |
LocalPort | The port in the local host where the class binds. |
MaxLineLength | The maximum amount of data to accumulate when no EOL is found. |
MaxTransferRate | The transfer rate limit in bytes per second. |
ProxyExceptionsList | A semicolon separated list of hosts and IPs to bypass when using a proxy. |
TCPKeepAlive | Determines whether or not the keep alive socket option is enabled. |
TcpNoDelay | Whether or not to delay when sending packets. |
UseIPv6 | Whether to use IPv6. |
LogSSLPackets | Controls whether SSL packets are logged when using the internal security API. |
OpenSSLCADir | The path to a directory containing CA certificates. |
OpenSSLCAFile | Name of the file containing the list of CA's trusted by your application. |
OpenSSLCipherList | A string that controls the ciphers to be used by SSL. |
OpenSSLPrngSeedData | The data to seed the pseudo random number generator (PRNG). |
ReuseSSLSession | Determines if the SSL session is reused. |
SSLCACertFilePaths | The paths to CA certificate files on Unix/Linux. |
SSLCACerts | A newline separated list of CA certificate to use during SSL client authentication. |
SSLCheckCRL | Whether to check the Certificate Revocation List for the server certificate. |
SSLCipherStrength | The minimum cipher strength used for bulk encryption. |
SSLEnabledCipherSuites | The cipher suite to be used in an SSL negotiation. |
SSLEnabledProtocols | Used to enable/disable the supported security protocols. |
SSLEnableRenegotiation | Whether the renegotiation_info SSL extension is supported. |
SSLIncludeCertChain | Whether the entire certificate chain is included in the SSLServerAuthentication event. |
SSLNegotiatedCipher | Returns the negotiated ciphersuite. |
SSLNegotiatedCipherStrength | Returns the negotiated ciphersuite strength. |
SSLNegotiatedCipherSuite | Returns the negotiated ciphersuite. |
SSLNegotiatedKeyExchange | Returns the negotiated key exchange algorithm. |
SSLNegotiatedKeyExchangeStrength | Returns the negotiated key exchange algorithm strength. |
SSLNegotiatedVersion | Returns the negotiated protocol version. |
SSLProvider | The name of the security provider to use. |
SSLSecurityFlags | Flags that control certificate verification. |
SSLServerCACerts | A newline separated list of CA certificate to use during SSL server certificate validation. |
TLS12SignatureAlgorithms | Defines the allowed TLS 1.2 signature algorithms when UseInternalSecurityAPI is True. |
TLS12SupportedGroups | The supported groups for ECC. |
TLS13KeyShareGroups | The groups for which to pregenerate key shares. |
TLS13SignatureAlgorithms | The allowed certificate signature algorithms. |
TLS13SupportedGroups | The supported groups for (EC)DHE key exchange. |
AbsoluteTimeout | Determines whether timeouts are inactivity timeouts or absolute timeouts. |
FirewallData | Used to send extra data to the firewall. |
InBufferSize | The size in bytes of the incoming queue of the socket. |
OutBufferSize | The size in bytes of the outgoing queue of the socket. |
BuildInfo | Information about the product's build. |
CodePage | The system code page used for Unicode to Multibyte translations. |
LicenseInfo | Information about the current license. |
ProcessIdleEvents | Whether the class uses its internal event loop to process events when the main thread is idle. |
SelectWaitMillis | The length of time in milliseconds the class will wait when DoEvents is called if there are no events to process. |
UseInternalSecurityAPI | Tells the class whether or not to use the system security libraries or an internal implementation. |