GoogleDrive Component
Properties Methods Events Config Settings Errors
The GoogleDrive component makes it easy to upload, download, and manage files and folders within Google Drive.
Syntax
TcsGoogleDrive
Remarks
The GoogleDrive component provides an easy-to-use interface for Google Drive. Capabilities include uploading and downloading files, file and folder manipulation and organization, Google Shared Drive support, strong client-side file encryption functionality, and more.
Authentication
This component requires authentication via OAuth 2.0. First, perform OAuth authentication using the OAuth property to set the appropriate fields for the chosen OAuthClientProfile and OAuthGrantType.
The component 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 OAuthClientProfile and OAuthGrantType values that are supported by this component. 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 component. Depending on the grant type, this may involve launching a browser so a user can login to authenticate with a authorization server. It may also involve starting an embedded web server to receive a response from a redirect.
To start the authentication and authorization process, the Authorize method should be called. If the authorization and authentication was successful, then the OAuthAccessToken property will be populated. Additionally, if a refresh token was provided the OAuthRefreshToken property will be populated as well. These values of the fields are for informational purposes. The component will also cache these tokens along with when the OAuthAccessToken will be expired. When a method that makes requests to the service provider is called or the Authorize method is called the component will automatically check to see if the access token is expired. If it is, it will then automatically try to get a new OAuthAccessToken. If the Authorize method was not used and user interaction would be required, the component will throw an error which can be caught. When user interaction is needed depends on what grant type is set in the OAuthGrantType property. To force the component to only check the access token when the Authorize method is called, the OAuthAutomaticRefresh configuration setting can be set to false.
A brief description of the supported values for the OAuthGrantType property are below. For more information, see the service documentation.
Authorization Code
When using the Authorization Code grant type, the component will use an authorization code to get an access token. For this OAuthGrantType the component expects a OAuthClientId, OAuthClientSecret, OAuthServerAuthURL, and OAuthServerTokenURL to be set. When the Authorize method is called, the component will start the embedded web server and launch the browser so the user can authorize the application. Once the user authorizes, the service provider will redirect them to the embedded web server and the component will parse the authorization code, setting the OAuthAuthorizationCode property, from the redirect. Immediately, the component will make a request to the token server to exchange the authorization code for an access token. The token server will return an access token and possibly a refresh token. If the OAuthRefreshToken property is set, or a refresh token is cached, then the component will not launch the browser and use the refresh token in its request to the token server instead of an authorization code.
Example:
GoogleDrive googledrive = new GoogleDrive();
googledrive.OAuth.ClientProfile = CloudOAuthClientProfiles.cocpApplication;
googledrive.OAuth.GrantType = OAuthSettingsGrantTypes.cogtAuthorizationCode;
googledrive.OAuth.ClientId = CLIENT_ID;
googledrive.OAuth.ClientSecret = CLIENT_SECRET;
googledrive.Authorize();
Implicit
Note: This grant type is considered insecure and should only be used when necessary.
When using the Implicit grant type, the component will request the authorization server to get an access token. For this OAuthGrantType the component expects a OAuthClientId, OAuthClientSecret, and OAuthServerAuthURL to be set. When the Authorize method is called, the component will start the embedded web server and launch the browser so the user can authorize the application. Once the user authorizes, the service provider will redirect them to the embedded web server and the component 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 component will not be able to automatically get a fresh token once it expires.
Web Profile
This profile is similar to setting the component to the Application profile and Authorization Code grant type except the component will not launch the browser. It is typically used in situations where there is a back-end that is supporting some front end. This profile expects that OAuthClientId, OAuthClientSecret, OAuthServerAuthURL, OAuthServerTokenURL, and the OAuthReturnURL properties to be set. Before calling the Authorize method, the OAuthWebAuthURL property should be queried to get a URL. This URL should be used to redirect the user to the authorization page for the service provider. The redirect_uri parameter of this URL is mapped to the OAuthReturnURL property. The OAuthReturnURL property should be set to some web server that will parse the authorization code out of the query parameter from the redirect. Once the authorization code is parsed, it should be passed back to the server where it is then set to the OAuthAuthorizationCode property. Once that is set, the Authorize method can be called to exchange the authorization code for an access token and refresh token if provided. The component will then cache these values like normal and use them to make requests. If the OAuthRefreshToken field is set, or a refresh token is cached, then the Authorize method can immediately be called to make a request to the token server to get a new access token.
External OAuth Support
For complex profiles or grant types, or for more control of the flow, it is possible to perform OAuth authentication using the OAuth component or a separate process. Once complete you should have an authorization string which looks like:Bearer ACCESS_TOKEN_VALUE
Assign this value to the Authorization property before attempting any operations. Setting the Authorization property will cause the component to ignore the values set in the OAuth property.
For Example:
Oauth oauth = new Oauth();
oauth.ClientId = "CLIENT_ID";
oauth.ClientSecret = "CLIENT_SECRET";
oauth.AuthorizationScope = "https://www.googleapis.com/auth/gmail.readonly";
oauth.ServerAuthURL = "https://accounts.google.com/o/oauth2/auth";
oauth.ServerTokenURL = "https://www.googleapis.com/auth/drive";
oauth.GrantType = OauthGrantTypes.ogtAuthorizationCode;
googledrive.Authorization = oauth.GetAuthorization();
Consult the documentation for the service for more information about supported scope values and more details on OAuth authentication.
Listing Resources
The ListResources method is used to list resources within the scope specified by the ListResourcesScope property.
The ListChildren, ListParents, and GetResourceInfo methods are also available for finer-grained control.
// ResourceList event handler.
googledrive.OnResourceList += (s, e) => {
Console.WriteLine(e.Name);
};
// List all of the current user's resources.
googledrive.ListResourcesScope = GoogledriveListResourcesScopes.lrsUser;
do {
googledrive.ListResources();
for (int i = 0; i < googledrive.Resources.Count; i++) {
// Process resources here.
}
} while (!string.IsNullOrEmpty(googledrive.ResourceMarker));
// List all of the resources in the specified shared drive.
googledrive.SharedDrive = "wfsr789vusijfv";
googledrive.ListResourcesScope = GoogledriveListResourcesScopes.lrsSharedDrive;
do {
googledrive.ListResources();
for (int i = 0; i < googledrive.Resources.Count; i++) {
// Process resources here.
}
} while (!string.IsNullOrEmpty(googledrive.ResourceMarker));
Downloading Files
The DownloadFile method is used to download files.
Download Notes
Downloading an Encrypted 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 component also supports resuming failed downloads by using the StartByte property. If a download is interrupted, set StartByte to the appropriate offset before calling this method to resume the download.
string downloadFile = "../MyFile.zip";
googledrive.LocalFile = downloadFile;
googledrive.DownloadFile(googledrive.Resources[0].Id, "");
//The transfer is interrupted and DownloadFile() above fails. Later, resume the download:
//Get the size of the partially downloaded file
googledrive.StartByte = new FileInfo(downloadFile).Length;
googledrive.DownloadFile(googledrive.Resources[0].Id, "");
Resuming Encrypted File Downloads
Resuming encrypted file downloads is only supported when LocalFile was set in the initial download attempt.
If LocalFile is set when beginning an encrypted download, the component creates a temporary file in TempPath to hold the encrypted data until the download is complete. If the download is interrupted, DownloadTempFile will be populated with the path of the temporary file that holds the partial data.
To resume, DownloadTempFile must be populated, along with StartByte, to allow the remainder of the encrypted data to be downloaded. Once the encrypted data is downloaded it will be decrypted and written to LocalFile.
googledrive.LocalFile = "../MyFile.zip";
googledrive.EncryptionPassword = "password";
googledrive.DownloadFile(googledrive.Resource[0].Id, "");
//The transfer is interrupted and DownloadFile() above fails. Later, resume the download:
//Get the size of the partially download temp file
googledrive.StartByte = new FileInfo(googledrive.Config("DownloadTempFile")).Length;
googledrive.DownloadFile(googledrive.Resource[0].Id, "");
Uploading Files
The UploadFile method is used to upload files.
Upload Notes
Google Drive offers two ways to upload a file. For smaller files a simple upload option is provided to upload data in one request. This is the default option. For larger files, uploads can be fragmented into multiple pieces, allowing resuming of uploads that may be interrupted.
Simple
By default the component uses the simple upload mechanism.
googledrive.LocalFile = "../MyFile.zip";
googledrive.UploadFile("MyFile.zip", "");
Resumable
To enable resumable uploads set UseResumableUpload to true. This is recommended for large files. The component will automatically fragment the specified file into smaller pieces and upload each individually. FragmentSize may be set to specify the size of the fragment if desired. The default fragment size is 10 MB.
When UseResumableUpload is set to true and UploadFile is called, a resumable upload session is started by the component. ResumeURL is populated with a URL identifying the session (this value may be needed for additional operations if the upload does not complete normally).
During a resumable upload, the FragmentComplete event fires after each fragment is uploaded to indicate overall progress. The component also updates StartByte as necessary to indicate the current offset in the file.
If the upload is interrupted for any reason, resuming it is easy. First, verify that ResumeURL and StartByte are populated (if the same instance of the component is used, they should already be populated, and no special action should be needed). Then call UploadFile again to resume the upload at the specified StartByte offset.
Note that if the upload is not resumed after some time the upload session will expire. GetUploadStatus may be used to check the status of a resumable upload.
googledrive.LocalFile = "../MyFile.zip";
googledrive.UploadFile("MyFile.zip", "");
//The transfer is interrupted and UploadFile() above fails. Later, resume the download.
//Using the same instance StartByte and ResumeURL are already populated from the previous
//upload attempt.
googledrive.UploadFile("MyFile.zip", "");
Shared Drive Support
The GoogleDrive component has full support for Google Shared Drives. For the most common use-cases (such as those described above), there is very little difference when using a shared drive versus a personal Google Drive ("My Drive").
For more information about how to use the component with Google Shared Drives, refer to both the shared-drive-specific documentation sections for commonly-used methods like ListResources, MoveResource, UpdatePermissions, etc.; and browse through the documentation for shared-drive-specific methods and properties such as the AddSharedDriveMember and ListSharedDrives methods, the SharedDrive property, etc.
Additional Functionality
The GoogleDrive component offers advanced functionality beyond simple uploads and downloads. For instance:
- 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 component 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 | Whether the file or shared drive has been removed. |
ChangeResourceId | The Id of the file to which the change applies. |
ChangeSharedDriveId | The Id of the shared drive. |
ChangeTime | The time of the change. |
ChangeType | 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 | Whether the resource's content is accessible to less-privileged users. |
ChildCreatedTime | The creation date of the resource. |
ChildDescription | A short description of the resource. |
ChildExtension | The file extension of the resource. |
ChildId | The Id of the resource. |
ChildMD5Checksum | The MD5 checksum of the file resource. |
ChildMIMEType | The MIME type of the resource. |
ChildModifiedTime | The last modified date of the resource. |
ChildName | The name of the resource. |
ChildOriginalName | The original name of the file resource. |
ChildOwner | The name of the resource's owner. |
ChildOwnerEmail | The email address of the resource's owner. |
ChildParentIds | The Ids of the resource's parent folders. |
ChildSharedDriveId | The Id of the shared drive the resource is in. |
ChildSize | The size of the file resource in bytes. |
ChildStarred | Whether the resource is starred. |
ChildTrashed | Whether the resource is in the trash. |
ChildType | The resource's type. |
ChildViewed | Whether the resource has been viewed. |
ChildViewLink | 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 component 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 the firewall (optional). |
FirewallPassword | This property contains a password if authentication is to be used when connecting through the firewall. |
FirewallPort | This property contains the Transmission Control Protocol (TCP) port for the firewall Host . |
FirewallUser | This property contains a username if authentication is to be used when connecting through a firewall. |
Idle | This property specifies the current status of the component. |
ListResourcesScope | Controls the scope of the results when listing resources. |
LocalFile | The location of the local file. |
LocalHost | This property includes 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. |
OAuthAccessToken | The access token returned by the authorization server. |
OAuthAuthorizationCode | The authorization code that is exchanged for an access token. |
OAuthAuthorizationScope | The scope request or response parameter used during authorization. |
OAuthClientId | The id of the client assigned when registering the application. |
OAuthClientProfile | The type of client that is requesting authorization. |
OAuthClientSecret | The secret value for the client assigned when registering the application. |
OAuthGrantType | The OAuth grant type used to acquire an OAuth access token. |
OAuthRefreshToken | Specifies the refresh token received from or sent to the authorization server. |
OAuthRequestRefreshToken | Specifies whether the component will request a refresh token during authorization. |
OAuthReturnURL | The URL where the user (browser) returns after authenticating. |
OAuthServerAuthURL | The URL of the authorization server. |
OAuthServerTokenURL | The URL of the token server used to obtain the access token. |
OAuthWebAuthURL | The URL to which the user should be re-directed for authorization. |
OtherHeaders | This property includes 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 | This property contains the name of the HTTP header (this is the same case as it is delivered). |
ParsedHeaderValue | This property contains the header contents. |
PermissionMarker | A marker when permissions are paged. |
PermissionCount | The number of records in the Permission arrays. |
PermissionAllowFileDiscovery | Whether the permission allows the file or folder to be discovered through search. |
PermissionDomain | The domain to which the permission applies. |
PermissionEmail | The user or group to which the permission applies. |
PermissionId | The Id of the permission. |
PermissionModOp | The operation to perform on the permission. |
PermissionRole | The role specified by the permission. |
PermissionType | The set of users to which the permission applies. |
ProxyAuthScheme | This property is used to tell the component which type of authorization to perform when connecting to the proxy. |
ProxyAutoDetect | This property tells the component 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 Transmission Control Protocol (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 a Secure Sockets Layer (SSL) for the connection to the proxy. |
ProxyUser | This property contains a username if authentication is to be used for the proxy. |
QueryParamCount | The number of records in the QueryParam arrays. |
QueryParamName | The name of the query parameter. |
QueryParamValue | 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 | Whether the resource's content is accessible to less-privileged users. |
ResourceCreatedTime | The creation date of the resource. |
ResourceDescription | A short description of the resource. |
ResourceExtension | The file extension of the resource. |
ResourceId | The Id of the resource. |
ResourceMD5Checksum | The MD5 checksum of the file resource. |
ResourceMIMEType | The MIME type of the resource. |
ResourceModifiedTime | The last modified date of the resource. |
ResourceName | The name of the resource. |
ResourceOriginalName | The original name of the file resource. |
ResourceOwner | The name of the resource's owner. |
ResourceOwnerEmail | The email address of the resource's owner. |
ResourceParentIds | The Ids of the resource's parent folders. |
ResourceSharedDriveId | The Id of the shared drive the resource is in. |
ResourceSize | The size of the file resource in bytes. |
ResourceStarred | Whether the resource is starred. |
ResourceTrashed | Whether the resource is in the trash. |
ResourceType | The resource's type. |
ResourceViewed | Whether the resource has been viewed. |
ResourceViewLink | 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 | The capabilities that the current user has for the shared drive. |
SharedDriveCreatedTime | The creation date of the shared drive. |
SharedDriveHidden | Whether the shared drive is hidden from default view. |
SharedDriveId | The Id of the shared drive. |
SharedDriveName | The name of the shared drive. |
SharedDriveRestrictions | The restrictions that apply to the shared drive. |
SSLAcceptServerCertEffectiveDate | This is the date on which this certificate becomes valid. |
SSLAcceptServerCertExpirationDate | This is the date the certificate expires. |
SSLAcceptServerCertExtendedKeyUsage | This is a comma-delimited list of extended key usage identifiers. |
SSLAcceptServerCertFingerprint | This is the hex-encoded, 16-byte MD5 fingerprint of the certificate. |
SSLAcceptServerCertFingerprintSHA1 | This is the hex-encoded, 20-byte SHA-1 fingerprint of the certificate. |
SSLAcceptServerCertFingerprintSHA256 | This is the hex-encoded, 32-byte SHA-256 fingerprint of the certificate. |
SSLAcceptServerCertIssuer | This is the issuer of the certificate. |
SSLAcceptServerCertPrivateKey | This is the private key of the certificate (if available). |
SSLAcceptServerCertPrivateKeyAvailable | This property shows whether a PrivateKey is available for the selected certificate. |
SSLAcceptServerCertPrivateKeyContainer | This is the name of the PrivateKey container for the certificate (if available). |
SSLAcceptServerCertPublicKey | This is the public key of the certificate. |
SSLAcceptServerCertPublicKeyAlgorithm | This property contains the textual description of the certificate's public key algorithm. |
SSLAcceptServerCertPublicKeyLength | This is the length of the certificate's public key (in bits). |
SSLAcceptServerCertSerialNumber | This is the serial number of the certificate encoded as a string. |
SSLAcceptServerCertSignatureAlgorithm | The property contains the text description of the certificate's signature algorithm. |
SSLAcceptServerCertStore | This is the name of the certificate store for the client certificate. |
SSLAcceptServerCertStorePassword | If the type of certificate store requires a password, this property is used to specify the password needed to open the certificate store. |
SSLAcceptServerCertStoreType | This is the type of certificate store for this certificate. |
SSLAcceptServerCertSubjectAltNames | This property contains comma-separated lists of alternative subject names for the certificate. |
SSLAcceptServerCertThumbprintMD5 | This property contains the MD5 hash of the certificate. |
SSLAcceptServerCertThumbprintSHA1 | This property contains the SHA-1 hash of the certificate. |
SSLAcceptServerCertThumbprintSHA256 | This property contains the SHA-256 hash of the certificate. |
SSLAcceptServerCertUsage | This property contains the text description of UsageFlags . |
SSLAcceptServerCertUsageFlags | This property contains the flags that show intended use for the certificate. |
SSLAcceptServerCertVersion | This property contains the certificate's version number. |
SSLAcceptServerCertSubject | This is the subject of the certificate used for client authentication. |
SSLAcceptServerCertEncoded | This is the certificate (PEM/Base64 encoded). |
SSLCertEffectiveDate | This is the date on which this certificate becomes valid. |
SSLCertExpirationDate | This is the date the certificate expires. |
SSLCertExtendedKeyUsage | This is a comma-delimited list of extended key usage identifiers. |
SSLCertFingerprint | This is the hex-encoded, 16-byte MD5 fingerprint of the certificate. |
SSLCertFingerprintSHA1 | This is the hex-encoded, 20-byte SHA-1 fingerprint of the certificate. |
SSLCertFingerprintSHA256 | This is the hex-encoded, 32-byte SHA-256 fingerprint of the certificate. |
SSLCertIssuer | This is the issuer of the certificate. |
SSLCertPrivateKey | This is the private key of the certificate (if available). |
SSLCertPrivateKeyAvailable | This property shows whether a PrivateKey is available for the selected certificate. |
SSLCertPrivateKeyContainer | This is the name of the PrivateKey container for the certificate (if available). |
SSLCertPublicKey | This is the public key of the certificate. |
SSLCertPublicKeyAlgorithm | This property contains the textual description of the certificate's public key algorithm. |
SSLCertPublicKeyLength | This is the length of the certificate's public key (in bits). |
SSLCertSerialNumber | This is the serial number of the certificate encoded as a string. |
SSLCertSignatureAlgorithm | The property contains the text description of the certificate's signature algorithm. |
SSLCertStore | This is the name of the certificate store for the client certificate. |
SSLCertStorePassword | If the type of certificate store requires a password, this property is used to specify the password needed to open the certificate store. |
SSLCertStoreType | This is the type of certificate store for this certificate. |
SSLCertSubjectAltNames | This property contains comma-separated lists of alternative subject names for the certificate. |
SSLCertThumbprintMD5 | This property contains the MD5 hash of the certificate. |
SSLCertThumbprintSHA1 | This property contains the SHA-1 hash of the certificate. |
SSLCertThumbprintSHA256 | This property contains the SHA-256 hash of the certificate. |
SSLCertUsage | This property contains the text description of UsageFlags . |
SSLCertUsageFlags | This property contains the flags that show intended use for the certificate. |
SSLCertVersion | This property contains the certificate's version number. |
SSLCertSubject | This is the subject of the certificate used for client authentication. |
SSLCertEncoded | This is the certificate (PEM/Base64 encoded). |
SSLProvider | This property specifies the Secure Sockets Layer/Transport Layer Security (SSL/TLS) implementation to use. |
SSLServerCertEffectiveDate | This is the date on which this certificate becomes valid. |
SSLServerCertExpirationDate | This is the date the certificate expires. |
SSLServerCertExtendedKeyUsage | This is a comma-delimited list of extended key usage identifiers. |
SSLServerCertFingerprint | This is the hex-encoded, 16-byte MD5 fingerprint of the certificate. |
SSLServerCertFingerprintSHA1 | This is the hex-encoded, 20-byte SHA-1 fingerprint of the certificate. |
SSLServerCertFingerprintSHA256 | This is the hex-encoded, 32-byte SHA-256 fingerprint of the certificate. |
SSLServerCertIssuer | This is the issuer of the certificate. |
SSLServerCertPrivateKey | This is the private key of the certificate (if available). |
SSLServerCertPrivateKeyAvailable | This property shows whether a PrivateKey is available for the selected certificate. |
SSLServerCertPrivateKeyContainer | This is the name of the PrivateKey container for the certificate (if available). |
SSLServerCertPublicKey | This is the public key of the certificate. |
SSLServerCertPublicKeyAlgorithm | This property contains the textual description of the certificate's public key algorithm. |
SSLServerCertPublicKeyLength | This is the length of the certificate's public key (in bits). |
SSLServerCertSerialNumber | This is the serial number of the certificate encoded as a string. |
SSLServerCertSignatureAlgorithm | The property contains the text description of the certificate's signature algorithm. |
SSLServerCertStore | This is the name of the certificate store for the client certificate. |
SSLServerCertStorePassword | If the type of certificate store requires a password, this property is used to specify the password needed to open the certificate store. |
SSLServerCertStoreType | This is the type of certificate store for this certificate. |
SSLServerCertSubjectAltNames | This property contains comma-separated lists of alternative subject names for the certificate. |
SSLServerCertThumbprintMD5 | This property contains the MD5 hash of the certificate. |
SSLServerCertThumbprintSHA1 | This property contains the SHA-1 hash of the certificate. |
SSLServerCertThumbprintSHA256 | This property contains the SHA-256 hash of the certificate. |
SSLServerCertUsage | This property contains the text description of UsageFlags . |
SSLServerCertUsageFlags | This property contains the flags that show intended use for the certificate. |
SSLServerCertVersion | This property contains the certificate's version number. |
SSLServerCertSubject | This is the subject of the certificate used for client authentication. |
SSLServerCertEncoded | This is the certificate (PEM/Base64 encoded). |
StartByte | The byte offset from which to start the upload or download. |
Timeout | This property includes the timeout for the component. |
UseResumableUpload | Whether to use resumable uploads. |
Method List
The following is the full list of the methods of the component with short descriptions. Click on the links for further details.
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. |
Authorize | Get the authorization string required to access the protected resource. |
CalcAuthorization | Calculates the Authorization header based on provided credentials. |
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 | This method interrupts 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. |
ListRevisions | List the revisions of a file. |
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 component 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 component with short descriptions. Click on the links for further details.
ChangeList | Fires once for each change when ListChanges is called. |
EndTransfer | This event fires when a document finishes transferring. |
Error | Fired when information is available about errors during data delivery. |
FragmentComplete | Fires after each fragment of a resumable upload is completed. |
Header | This event is fired every time a header line comes in. |
Log | This event fires once for each log message. |
PermissionList | This event fires once for each permission returned when listing permissions. |
Progress | Fires during an upload or download to indicate transfer progress. |
ResourceList | Fires once for each resource returned when listing resources. |
SharedDriveList | Fires once for each shared drive returned when listing shared drives. |
SSLServerAuthentication | Fired after the server presents its certificate to the client. |
SSLStatus | Fired when secure connection progress messages are available. |
StartTransfer | This event fires when a document starts transferring (after the headers). |
Transfer | This event is fired while a document transfers (delivers document). |
Config Settings
The following is a list of config settings for the component with short descriptions. Click on the links for further details.
AccumulatePages | Whether the component 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. |
EncryptionPasswordKDF | The KDF algorithm to use during password based encryption and 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 component 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. |
RequestedFields | What fields to request when listing or getting objects. |
ResourceKey[i] | The resource key used to access a file. |
RevisionId | The ID of the revision to make request against. |
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. |
OAuthAccessTokenExpiration | The lifetime of the access token. |
OAuthAuthorizationTokenType | The type of access token returned. |
OAuthAutomaticRefresh | Whether or not to refresh an expired access token automatically. |
OAuthBrowserResponseTimeout | Specifies the amount of time to wait for a response from the browser. |
OAuthIncludeEmptyRedirectURI | Whether an empty redirect_uri parameter is included in requests. |
OAuthJWTPayload | The payload of the JWT access token if present. |
OAuthJWTXChildCount | The number of child elements of the current element. |
OauthJWTXChildName[i] | The name of the child element. |
OAuthJWTXChildXText[i] | The inner text of the child element. |
OAuthJWTXElement | The name of the current element. |
OauthJWTXParent | The parent of the current element. |
OAuthJWTXPath | Provides a way to point to a specific element in the returned payload of a JWT based access token. |
OAuthJWTXSubTree | A snapshot of the current element in the document. |
OAuthJWTXText | The text of the current element. |
OAuthParamCount | Specifies the number of additional parameters variables to include in the request. |
OAuthParamName[i] | Specifies the parameter name at the specified index. |
OAuthParamValue[i] | Specifies the parameter value at the specified index. |
OAuthPasswordGrantUsername | Used in the Resource Owner Password grant type. |
OAuthPKCEChallengeEncoding | The PKCE code challenge method to use. |
OAuthPKCEVerifier | The PKCE verifier used to generate the challenge. |
OAuthResetData | Determines if the Reset method applies to the OAuth settings. |
OAuthReUseWebServer | Determines if the same server instance is used between requests. |
OAuthTransferredRequest | The full OAuth request last sent by the client. |
OAuthUsePKCE | Specifies if PKCE should be used. |
OAuthWebServerActive | Specifies and controls whether the embedded web server is active. |
OAuthWebServerCertStore | The certificate with private key to use when SSL is enabled. |
OAuthWebServerCertStorePassword | The certificate with private key to use when SSL is enabled. |
OAuthWebServerCertStoreType | The certificate with private key to use when SSL is enabled. |
OAuthWebServerCertSubject | The certificate with private key to use when SSL is enabled. |
OAuthWebServerFailedResponse | The custom response that will be displayed to the user if authentication failed. |
OAuthWebServerHost | The hostname used by the embedded web server displayed in the ReturnURL. |
OAuthWebServerPort | The local port on which the embedded web server listens. |
OAuthWebServerResponse | The custom response that will be displayed to the user. |
OAuthWebServerSSLEnabled | Whether the web server requires SSL connections. |
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 component. |
FollowRedirects | Determines what happens when the server issues a redirect. |
GetOn302Redirect | If set to True the component 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 component. |
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. |
StatusCode | The status code of the last response from the server. |
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 component. |
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. |
UseProxyAutoConfigURL | Whether to use a Proxy auto-config file when attempting a connection. |
UserAgent | Information about the user agent (browser). |
ConnectionTimeout | Sets a separate timeout value for establishing a connection. |
FirewallAutoDetect | Tells the component 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 component 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. |
SSLCACerts | A newline separated list of CA certificate to be included when performing an SSL handshake. |
SSLCheckCRL | Whether to check the Certificate Revocation List for the server certificate. |
SSLCheckOCSP | Whether to use OCSP to check the status of the server certificate. |
SSLCipherStrength | The minimum cipher strength used for bulk encryption. |
SSLClientCACerts | A newline separated list of CA certificates to use during SSL client certificate validation. |
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. |
SSLKeyLogFile | The location of a file where per-session secrets are written for debugging purposes. |
SSLNegotiatedCipher | Returns the negotiated cipher suite. |
SSLNegotiatedCipherStrength | Returns the negotiated cipher suite strength. |
SSLNegotiatedCipherSuite | Returns the negotiated cipher suite. |
SSLNegotiatedKeyExchange | Returns the negotiated key exchange algorithm. |
SSLNegotiatedKeyExchangeStrength | Returns the negotiated key exchange algorithm strength. |
SSLNegotiatedVersion | Returns the negotiated protocol version. |
SSLSecurityFlags | Flags that control certificate verification. |
SSLServerCACerts | A newline separated list of CA certificates to use during SSL server certificate validation. |
TLS12SignatureAlgorithms | Defines the allowed TLS 1.2 signature algorithms when SSLProvider is set to Internal. |
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. |
MaskSensitiveData | Whether sensitive data is masked in log messages. |
UseFIPSCompliantAPI | Tells the component whether or not to use FIPS certified APIs. |
UseInternalSecurityAPI | Whether or not to use the system security libraries or an internal implementation. |
AccountCanCreateSharedDrives Property (GoogleDrive Component)
Whether the account has permission to create shared drives.
Syntax
__property bool AccountCanCreateSharedDrives = { read=FAccountCanCreateSharedDrives };
Default Value
false
Remarks
Whether the account has permission to create shared drives.
This property reflects whether the account has the permissions necessary to create shared drives.
This property is read-only and not available at design time.
Data Type
Boolean
AccountDriveUsage Property (GoogleDrive Component)
Amount of storage used in Google Drive.
Syntax
__property __int64 AccountDriveUsage = { read=FAccountDriveUsage };
Default Value
-1
Remarks
Amount of storage used in Google Drive.
This property reflects the storage usage, in bytes, for all items in the account's Google Drive (including trashed items).
This property is read-only and not available at design time.
Data Type
Long64
AccountEmail Property (GoogleDrive Component)
The email address of the account.
Syntax
__property String AccountEmail = { read=FAccountEmail };
Default Value
""
Remarks
The email address of the account.
This property reflects the email address associated with the account.
This property is read-only and not available at design time.
Data Type
String
AccountName Property (GoogleDrive Component)
The name of the account's user.
Syntax
__property String AccountName = { read=FAccountName };
Default Value
""
Remarks
The name of the account's user.
This property reflects the name of the account's user.
This property is read-only and not available at design time.
Data Type
String
AccountPermissionId Property (GoogleDrive Component)
The permission Id associated with the account.
Syntax
__property String AccountPermissionId = { read=FAccountPermissionId };
Default Value
""
Remarks
The permission Id associated with the account.
This property reflects the permission Id associated with the account. Any permissions (including shared drive memberships) created for this account will include this Id.
This property is read-only and not available at design time.
Data Type
String
AccountStorageQuota Property (GoogleDrive Component)
The account's storage quota.
Syntax
__property __int64 AccountStorageQuota = { read=FAccountStorageQuota };
Default Value
-1
Remarks
The account's storage quota.
This property reflects the account's storage quota, in bytes, across all Google services (Google Drive, Gmail, etc.).
A value of -1 indicates that the account does not have a storage quota (i.e., it has unlimited storage).
This property is read-only and not available at design time.
Data Type
Long64
AccountStorageUsage Property (GoogleDrive Component)
Amount of storage used across all Google services.
Syntax
__property __int64 AccountStorageUsage = { read=FAccountStorageUsage };
Default Value
-1
Remarks
Amount of storage used across all Google services.
This property reflects the account's total storage usage, in bytes, across all Google services (Google Drive, Gmail, etc.).
This property is read-only and not available at design time.
Data Type
Long64
AccountTrashUsage Property (GoogleDrive Component)
Amount of storage used by trashed items in Google Drive.
Syntax
__property __int64 AccountTrashUsage = { read=FAccountTrashUsage };
Default Value
-1
Remarks
Amount of storage used by trashed items in Google Drive.
This property reflects the storage usage, in bytes, for all trashed items in the account's Google Drive.
This property is read-only and not available at design time.
Data Type
Long64
Authorization Property (GoogleDrive Component)
OAuth 2.0 Authorization Token.
Syntax
__property String Authorization = { read=FAuthorization, write=FSetAuthorization };
Default Value
""
Remarks
This component supports authentication via OAuth 2.0. First, perform OAuth authentication using the OAuth property, using the OAuth component or a separate process. If using the OAuth property, then the Authorization property will not be used.
Bearer ACCESS_TOKENAssign this value to the Authorization property before attempting any operations. Consult the documentation for the service for more information about supported scope values and more details on OAuth authentication.
Data Type
String
ChangeMarker Property (GoogleDrive Component)
A marker indicating what page of changes to return next.
Syntax
__property String ChangeMarker = { read=FChangeMarker, write=FSetChangeMarker };
Default Value
""
Remarks
This property will be populated when ListChanges is called if the results are paged and there are more pages. To list all changes, continue to call ListChanges until this property returns empty string.
Setting ChangeMarker will cause NextChangeMarker to be set to empty string.
Refer to ListChanges for more information.
This property is not available at design time.
Data Type
String
ChangeCount Property (GoogleDrive Component)
The number of records in the Change arrays.
Syntax
__property int ChangeCount = { read=FChangeCount };
Default Value
0
Remarks
This property controls the size of the following arrays:
The array indices start at 0 and end at ChangeCount - 1.This property is read-only and not available at design time.
Data Type
Integer
ChangeRemoved Property (GoogleDrive Component)
Whether the file or shared drive has been removed.
Syntax
__property bool ChangeRemoved[int ChangeIndex] = { read=FChangeRemoved };
Default Value
false
Remarks
Whether the file or shared drive has been removed.
This property indicates whether the file or shared drive to which the change applies has been removed.
The ChangeIndex parameter specifies the index of the item in the array. The size of the array is controlled by the ChangeCount property.
This property is read-only and not available at design time.
Data Type
Boolean
ChangeResourceId Property (GoogleDrive Component)
The Id of the file to which the change applies.
Syntax
__property String ChangeResourceId[int ChangeIndex] = { read=FChangeResourceId };
Default Value
""
Remarks
The Id of the file to which the change applies.
This property holds the Id of the file to which the change applies.
The ChangeIndex parameter specifies the index of the item in the array. The size of the array is controlled by the ChangeCount property.
This property is read-only and not available at design time.
Data Type
String
ChangeSharedDriveId Property (GoogleDrive Component)
The Id of the shared drive.
Syntax
__property String ChangeSharedDriveId[int ChangeIndex] = { read=FChangeSharedDriveId };
Default Value
""
Remarks
The Id of the shared drive.
This property holds the Id of the shared drive to which the change applies (if ChangeType is ctSharedDrive (1)), or which owns the file to which the change applies (if ChangeType is ctFile (0)).
The ChangeIndex parameter specifies the index of the item in the array. The size of the array is controlled by the ChangeCount property.
This property is read-only and not available at design time.
Data Type
String
ChangeTime Property (GoogleDrive Component)
The time of the change.
Syntax
__property String ChangeTime[int ChangeIndex] = { read=FChangeTime };
Default Value
""
Remarks
The time of the change.
This property holds the time of the change. This is a combined date-time value (formatted according to RFC 3339).
The ChangeIndex parameter specifies the index of the item in the array. The size of the array is controlled by the ChangeCount property.
This property is read-only and not available at design time.
Data Type
String
ChangeType Property (GoogleDrive Component)
Whether the change is for a file or a shared drive.
Syntax
__property TcsGoogleDriveChangeTypes ChangeType[int ChangeIndex] = { read=FChangeType };
enum TcsGoogleDriveChangeTypes { ctFile=0, ctSharedDrive=1 };
Default Value
ctFile
Remarks
Whether the change is for a file or a shared drive.
This property indicates whether the change applies to a file or a shared drive. Possible values are:
- ctFile (0)
- ctSharedDrive (1)
The ChangeIndex parameter specifies the index of the item in the array. The size of the array is controlled by the ChangeCount property.
This property is read-only and not available at design time.
Data Type
Integer
ChildMarker Property (GoogleDrive Component)
A marker when child resources are paged.
Syntax
__property String ChildMarker = { read=FChildMarker, write=FSetChildMarker };
Default Value
""
Remarks
This property returns a marker used to iterate over pages of child resources; it's populated when ListChildren is called if the results are paged.
Continue to call ListChildren until this property returns empty string in order to list all resources.
This property is not available at design time.
Data Type
String
ChildCount Property (GoogleDrive Component)
The number of records in the Child arrays.
Syntax
__property int ChildCount = { read=FChildCount };
Default Value
0
Remarks
This property controls the size of the following arrays:
- ChildContentAccessible
- ChildCreatedTime
- ChildDescription
- ChildExtension
- ChildId
- ChildMD5Checksum
- ChildMIMEType
- ChildModifiedTime
- ChildName
- ChildOriginalName
- ChildOwner
- ChildOwnerEmail
- ChildParentIds
- ChildSharedDriveId
- ChildSize
- ChildStarred
- ChildTrashed
- ChildType
- ChildViewed
- ChildViewLink
This property is read-only and not available at design time.
Data Type
Integer
ChildContentAccessible Property (GoogleDrive Component)
Whether the resource's content is accessible to less-privileged users.
Syntax
__property bool ChildContentAccessible[int ChildIndex] = { read=FChildContentAccessible };
Default Value
false
Remarks
Whether the resource's content is accessible to less-privileged users.
This property indicates whether the resource's content is accessible. If the resource is not accessible, it cannot be copied, downloaded, or printed by a users unless they have at least "writer" permissions.
The ChildIndex parameter specifies the index of the item in the array. The size of the array is controlled by the ChildCount property.
This property is read-only and not available at design time.
Data Type
Boolean
ChildCreatedTime Property (GoogleDrive Component)
The creation date of the resource.
Syntax
__property String ChildCreatedTime[int ChildIndex] = { read=FChildCreatedTime };
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 component only uses it as input when UploadFile is called; it is ignored when calling UpdateResource.
The ChildIndex parameter specifies the index of the item in the array. The size of the array is controlled by the ChildCount property.
This property is read-only and not available at design time.
Data Type
String
ChildDescription Property (GoogleDrive Component)
A short description of the resource.
Syntax
__property String ChildDescription[int ChildIndex] = { read=FChildDescription };
Default Value
""
Remarks
A short description of the resource.
This property specifies a short description of the resource.
The ChildIndex parameter specifies the index of the item in the array. The size of the array is controlled by the ChildCount property.
This property is read-only and not available at design time.
Data Type
String
ChildExtension Property (GoogleDrive Component)
The file extension of the resource.
Syntax
__property String ChildExtension[int ChildIndex] = { read=FChildExtension };
Default Value
""
Remarks
The file extension of the resource.
This property indicates the file extension of the resource. It cannot be set, and is empty for folder resources. To specify the extension when creating a new file resource include it when calling UploadFile.
The ChildIndex parameter specifies the index of the item in the array. The size of the array is controlled by the ChildCount property.
This property is read-only and not available at design time.
Data Type
String
ChildId Property (GoogleDrive Component)
The Id of the resource.
Syntax
__property String ChildId[int ChildIndex] = { read=FChildId };
Default Value
""
Remarks
The Id of the resource.
This property holds the Id of the resource.
This property must be set before calling UpdateResource.
The ChildIndex parameter specifies the index of the item in the array. The size of the array is controlled by the ChildCount property.
This property is read-only and not available at design time.
Data Type
String
ChildMD5Checksum Property (GoogleDrive Component)
The MD5 checksum of the file resource.
Syntax
__property String ChildMD5Checksum[int ChildIndex] = { read=FChildMD5Checksum };
Default Value
""
Remarks
The MD5 checksum of the file resource.
This property holds the MD5 checksum of the resource, if it is a file resource.
The ChildIndex parameter specifies the index of the item in the array. The size of the array is controlled by the ChildCount property.
This property is read-only and not available at design time.
Data Type
String
ChildMIMEType Property (GoogleDrive Component)
The MIME type of the resource.
Syntax
__property String ChildMIMEType[int ChildIndex] = { read=FChildMIMEType };
Default Value
""
Remarks
The MIME type of the resource.
This property specifies the MIME type of the resource.
When calling UploadFile, this property is ignored in favor of the MimeType parameter of UploadFile.
When calling UpdateResource, this property is only submitted if new file data is being uploaded.
Some Google Drive MIME types:
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 property.
This property is read-only and not available at design time.
Data Type
String
ChildModifiedTime Property (GoogleDrive Component)
The last modified date of the resource.
Syntax
__property String ChildModifiedTime[int ChildIndex] = { read=FChildModifiedTime };
Default Value
""
Remarks
The last modified date of the resource.
This property holds a DateTime string representing the last modified date of the resource. This is a combined date-time value (formatted according to RFC 3339).
The ChildIndex parameter specifies the index of the item in the array. The size of the array is controlled by the ChildCount property.
This property is read-only and not available at design time.
Data Type
String
ChildName Property (GoogleDrive Component)
The name of the resource.
Syntax
__property String ChildName[int ChildIndex] = { read=FChildName };
Default Value
""
Remarks
The name of the resource.
This property specifies the name of the resource.
The ChildIndex parameter specifies the index of the item in the array. The size of the array is controlled by the ChildCount property.
This property is read-only and not available at design time.
Data Type
String
ChildOriginalName Property (GoogleDrive Component)
The original name of the file resource.
Syntax
__property String ChildOriginalName[int ChildIndex] = { read=FChildOriginalName };
Default Value
""
Remarks
The original name of the file resource.
This property specifies the original name of a file resource if the file was uploaded manually, or if the name was set programmatically through the API.
Updating ChildName will not change this value.
The ChildIndex parameter specifies the index of the item in the array. The size of the array is controlled by the ChildCount property.
This property is read-only and not available at design time.
Data Type
String
ChildOwner Property (GoogleDrive Component)
The name of the resource's owner.
Syntax
__property String ChildOwner[int ChildIndex] = { read=FChildOwner };
Default Value
""
Remarks
The name of the resource's owner.
This property holds the name of resource's owner.
The ChildIndex parameter specifies the index of the item in the array. The size of the array is controlled by the ChildCount property.
This property is read-only and not available at design time.
Data Type
String
ChildOwnerEmail Property (GoogleDrive Component)
The email address of the resource's owner.
Syntax
__property String ChildOwnerEmail[int ChildIndex] = { read=FChildOwnerEmail };
Default Value
""
Remarks
The email address of the resource's owner.
This property holds the email address of the resource's owner.
The ChildIndex parameter specifies the index of the item in the array. The size of the array is controlled by the ChildCount property.
This property is read-only and not available at design time.
Data Type
String
ChildParentIds Property (GoogleDrive Component)
The Ids of the resource's parent folders.
Syntax
__property String ChildParentIds[int ChildIndex] = { read=FChildParentIds };
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 component only uses it as input when UploadFile is called. To modify a resource's parents in any other case, use the AddParents, RemoveParents, and MoveResource methods.
The ChildIndex parameter specifies the index of the item in the array. The size of the array is controlled by the ChildCount property.
This property is read-only and not available at design time.
Data Type
String
ChildSharedDriveId Property (GoogleDrive Component)
The Id of the shared drive the resource is in.
Syntax
__property String ChildSharedDriveId[int ChildIndex] = { read=FChildSharedDriveId };
Default Value
""
Remarks
The Id of the shared drive the resource is in.
This property holds the Id of the shared drive that the resource is in, if applicable.
The ChildIndex parameter specifies the index of the item in the array. The size of the array is controlled by the ChildCount property.
This property is read-only and not available at design time.
Data Type
String
ChildSize Property (GoogleDrive Component)
The size of the file resource in bytes.
Syntax
__property __int64 ChildSize[int ChildIndex] = { read=FChildSize };
Default Value
0
Remarks
The size of the file resource in bytes.
This property holds the size of a file resource in bytes. This is only applicable to files.
The ChildIndex parameter specifies the index of the item in the array. The size of the array is controlled by the ChildCount property.
This property is read-only and not available at design time.
Data Type
Long64
ChildStarred Property (GoogleDrive Component)
Whether the resource is starred.
Syntax
__property bool ChildStarred[int ChildIndex] = { read=FChildStarred };
Default Value
false
Remarks
Whether the resource is starred.
This property indicates whether the resource is starred by the current user.
The ChildIndex parameter specifies the index of the item in the array. The size of the array is controlled by the ChildCount property.
This property is read-only and not available at design time.
Data Type
Boolean
ChildTrashed Property (GoogleDrive Component)
Whether the resource is in the trash.
Syntax
__property bool ChildTrashed[int ChildIndex] = { read=FChildTrashed };
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 component only uses it as input when UpdateResource is called; it is ignored when calling UploadFile.
The ChildIndex parameter specifies the index of the item in the array. The size of the array is controlled by the ChildCount property.
This property is read-only and not available at design time.
Data Type
Boolean
ChildType Property (GoogleDrive Component)
The resource's type.
Syntax
__property TcsGoogleDriveChildTypes ChildType[int ChildIndex] = { read=FChildType };
enum TcsGoogleDriveChildTypes { gdrtFile=0, gdrtFolder=1 };
Default Value
gdrtFile
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 ResourceType property can be used to determine if a resource is a folder, a file, or a revision of a file.
To list, delete, and update folders use the ListResources, DeleteResource, and UpdateResource methods.
The ChildIndex parameter specifies the index of the item in the array. The size of the array is controlled by the ChildCount property.
This property is read-only and not available at design time.
Data Type
Integer
ChildViewed Property (GoogleDrive Component)
Whether the resource has been viewed.
Syntax
__property bool ChildViewed[int ChildIndex] = { read=FChildViewed };
Default Value
false
Remarks
Whether the resource has been viewed.
This property indicates whether the resource has been viewed by the current user.
The ChildIndex parameter specifies the index of the item in the array. The size of the array is controlled by the ChildCount property.
This property is read-only and not available at design time.
Data Type
Boolean
ChildViewLink Property (GoogleDrive Component)
A link for opening the resource in a relevant Google editor or viewer in a browser.
Syntax
__property String ChildViewLink[int ChildIndex] = { read=FChildViewLink };
Default Value
""
Remarks
A link for opening the resource in a relevant Google editor or viewer in a browser.
This property holds the link to the resource. The link may be used to view the resource in a browser or relevant editor.
The ChildIndex parameter specifies the index of the item in the array. The size of the array is controlled by the ChildCount property.
This property is read-only and not available at design time.
Data Type
String
EncryptionAlgorithm Property (GoogleDrive Component)
The encryption algorithm.
Syntax
__property TcsGoogleDriveEncryptionAlgorithms EncryptionAlgorithm = { read=FEncryptionAlgorithm, write=FSetEncryptionAlgorithm };
enum TcsGoogleDriveEncryptionAlgorithms { eaAES=0, eaBlowfish=1, eaCAST=2, eaDES=3, eaIDEA=4, eaRC2=5, eaRC4=6, eaTEA=7, eaTripleDES=8, eaTwofish=9, eaRijndael=10, eaChaCha=11, eaXSalsa20=12 };
Default Value
eaAES
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
Integer
EncryptionPassword Property (GoogleDrive Component)
The encryption password.
Syntax
__property String EncryptionPassword = { read=FEncryptionPassword, write=FSetEncryptionPassword };
Default Value
""
Remarks
If this property is populated when UploadFile or DownloadFile is called, the component will attempt to encrypt or decrypt the data before uploading or after downloading it.
The component uses the value specified here to generate the necessary encryption Key and IV values using the PKCS5 password digest algorithm. This provides a simpler alternative to creating and managing Key and IV values directly.
However, it is also possible to explicitly specify the Key and IV values to use by setting the EncryptionKey and EncryptionIV configuration settings. This may be necessary if, e.g., the data needs to be encrypted/decrypted by another utility which generates Key and IV values differently.
This property is not available at design time.
Data Type
String
FirewallAutoDetect Property (GoogleDrive Component)
This property tells the component whether or not to automatically detect and use firewall system settings, if available.
Syntax
__property bool FirewallAutoDetect = { read=FFirewallAutoDetect, write=FSetFirewallAutoDetect };
Default Value
False
Remarks
This property tells the component whether or not to automatically detect and use firewall system settings, if available.
Data Type
Boolean
FirewallType Property (GoogleDrive Component)
This property determines the type of firewall to connect through.
Syntax
__property TcsGoogleDriveFirewallTypes FirewallType = { read=FFirewallType, write=FSetFirewallType };
enum TcsGoogleDriveFirewallTypes { fwNone=0, fwTunnel=1, fwSOCKS4=2, fwSOCKS5=3, fwSOCKS4A=10 };
Default Value
fwNone
Remarks
This property determines 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. FirewallPort is set to 80. |
fwSOCKS4 (2) | Connect through a SOCKS4 Proxy. FirewallPort is set to 1080. |
fwSOCKS5 (3) | Connect through a SOCKS5 Proxy. FirewallPort is set to 1080. |
fwSOCKS4A (10) | Connect through a SOCKS4A Proxy. FirewallPort is set to 1080. |
Data Type
Integer
FirewallHost Property (GoogleDrive Component)
This property contains the name or IP address of the firewall (optional).
Syntax
__property String FirewallHost = { read=FFirewallHost, write=FSetFirewallHost };
Default Value
""
Remarks
This property contains the name or IP address of the firewall (optional). If a FirewallHost is given, the requested connections will be authenticated through the specified firewall when connecting.
If this property is set to a Domain Name, a DNS request is initiated. Upon successful termination of the request, this property is set to the corresponding address. If the search is not successful, the component raises an exception.
Data Type
String
FirewallPassword Property (GoogleDrive Component)
This property contains a password if authentication is to be used when connecting through the firewall.
Syntax
__property String FirewallPassword = { read=FFirewallPassword, write=FSetFirewallPassword };
Default Value
""
Remarks
This property contains a password if authentication is to be used when connecting through the firewall. If FirewallHost is specified, the FirewallUser and FirewallPassword properties are used to connect and authenticate to the given firewall. If the authentication fails, the component raises an exception.
Data Type
String
FirewallPort Property (GoogleDrive Component)
This property contains the Transmission Control Protocol (TCP) port for the firewall Host .
Syntax
__property int FirewallPort = { read=FFirewallPort, write=FSetFirewallPort };
Default Value
0
Remarks
This property contains the Transmission Control Protocol (TCP) port for the firewall FirewallHost. See the description of the FirewallHost property for details.
Note: This property is set automatically when FirewallType is set to a valid value. See the description of the FirewallType property for details.
Data Type
Integer
FirewallUser Property (GoogleDrive Component)
This property contains a username if authentication is to be used when connecting through a firewall.
Syntax
__property String FirewallUser = { read=FFirewallUser, write=FSetFirewallUser };
Default Value
""
Remarks
This property contains a username if authentication is to be used when connecting through a firewall. If FirewallHost is specified, this property and the FirewallPassword property are used to connect and authenticate to the given Firewall. If the authentication fails, the component raises an exception.
Data Type
String
Idle Property (GoogleDrive Component)
This property specifies the current status of the component.
Syntax
__property bool Idle = { read=FIdle };
Default Value
True
Remarks
Idle will be False if the component is currently busy (communicating or waiting for an answer), and True at all other times.
This property is read-only.
Data Type
Boolean
ListResourcesScope Property (GoogleDrive Component)
Controls the scope of the results when listing resources.
Syntax
__property TcsGoogleDriveListResourcesScopes ListResourcesScope = { read=FListResourcesScope, write=FSetListResourcesScope };
enum TcsGoogleDriveListResourcesScopes { lrsUser=0, lrsDomain=1, lrsSharedDrive=2, lrsAllDrives=3 };
Default Value
lrsUser
Remarks
This property controls the scope of the results when listing resources with ListResources or ListChildren. 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 SharedDrive 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 ListResources for more information.
This property is not available at design time.
Data Type
Integer
LocalFile Property (GoogleDrive Component)
The location of the local file.
Syntax
__property String LocalFile = { read=FLocalFile, write=FSetLocalFile };
Default Value
""
Remarks
This property specifies the location of a file on disk. This is used as the source file when calling UploadFile or UpdateResource, and as the destination file when calling DownloadFile.
Data Type
String
LocalHost Property (GoogleDrive Component)
This property includes the name of the local host or user-assigned IP interface through which connections are initiated or accepted.
Syntax
__property String LocalHost = { read=FLocalHost, write=FSetLocalHost };
Default Value
""
Remarks
The LocalHost 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 component initiate connections (or accept in the case of server components) 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 component is connected, the LocalHost property shows the IP address of the interface through which the connection is made in internet dotted format (aaa.bbb.ccc.ddd). In most cases, this is the address of the local host, except for multihomed hosts (machines with more than one IP interface).
Note: LocalHost is not persistent. You must always set it in code, and never in the property window.
Data Type
String
NextChangeMarker Property (GoogleDrive Component)
A marker indicating what page of changes to return in the future.
Syntax
__property String NextChangeMarker = { read=FNextChangeMarker, write=FSetNextChangeMarker };
Default Value
""
Remarks
This property will be populated when ListChanges is called if there are no more changes to list.
This property will be populated with the most current change marker if GetCurrentChangeMarker is called.
Setting NextChangeMarker will cause ChangeMarker to be set to empty string.
Refer to ListChanges for more information.
This property is not available at design time.
Data Type
String
OAuthAccessToken Property (GoogleDrive Component)
The access token returned by the authorization server.
Syntax
__property String OAuthAccessToken = { read=FOAuthAccessToken, write=FSetOAuthAccessToken };
Default Value
""
Remarks
The access token returned by the authorization server. This is set when the component makes a request to the token server.
This property is not available at design time.
Data Type
String
OAuthAuthorizationCode Property (GoogleDrive Component)
The authorization code that is exchanged for an access token.
Syntax
__property String OAuthAuthorizationCode = { read=FOAuthAuthorizationCode, write=FSetOAuthAuthorizationCode };
Default Value
""
Remarks
The authorization code that is exchanged for an access token. This is required to be set when the OAuthClientProfile property is set to the Web profile. Otherwise, this field is for information purposes only.
This property is not available at design time.
Data Type
String
OAuthAuthorizationScope Property (GoogleDrive Component)
The scope request or response parameter used during authorization.
Syntax
__property String OAuthAuthorizationScope = { read=FOAuthAuthorizationScope, write=FSetOAuthAuthorizationScope };
Default Value
""
Remarks
The scope request or response parameter used during authorization.
This property is not available at design time.
Data Type
String
OAuthClientId Property (GoogleDrive Component)
The id of the client assigned when registering the application.
Syntax
__property String OAuthClientId = { read=FOAuthClientId, write=FSetOAuthClientId };
Default Value
""
Remarks
The id of the client assigned when registering the application.
This property is not available at design time.
Data Type
String
OAuthClientProfile Property (GoogleDrive Component)
The type of client that is requesting authorization.
Syntax
__property TcsGoogleDriveOAuthClientProfiles OAuthClientProfile = { read=FOAuthClientProfile, write=FSetOAuthClientProfile };
enum TcsGoogleDriveOAuthClientProfiles { cocpApplication=0, cocpWeb=1 };
Default Value
cocpApplication
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. |
This property is not available at design time.
Data Type
Integer
OAuthClientSecret Property (GoogleDrive Component)
The secret value for the client assigned when registering the application.
Syntax
__property String OAuthClientSecret = { read=FOAuthClientSecret, write=FSetOAuthClientSecret };
Default Value
""
Remarks
The secret value for the client assigned when registering the application.
This property is not available at design time.
Data Type
String
OAuthGrantType Property (GoogleDrive Component)
The OAuth grant type used to acquire an OAuth access token.
Syntax
__property TcsGoogleDriveOAuthGrantTypes OAuthGrantType = { read=FOAuthGrantType, write=FSetOAuthGrantType };
enum TcsGoogleDriveOAuthGrantTypes { cogtAuthorizationCode=0, cogtImplicit=1, cogtPassword=2, cogtClientCredentials=3 };
Default Value
cogtAuthorizationCode
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 |
This property is not available at design time.
Data Type
Integer
OAuthRefreshToken Property (GoogleDrive Component)
Specifies the refresh token received from or sent to the authorization server.
Syntax
__property String OAuthRefreshToken = { read=FOAuthRefreshToken, write=FSetOAuthRefreshToken };
Default Value
""
Remarks
Specifies the refresh token received from or sent to the authorization server. This property is set automatically if a refresh token is retrieved from the token server. If the OAuthAutomaticRefresh configuration setting is set to true, and the OAuthGrantType property is set to a grant that can use refresh tokens.
This property is not available at design time.
Data Type
String
OAuthRequestRefreshToken Property (GoogleDrive Component)
Specifies whether the component will request a refresh token during authorization.
Syntax
__property bool OAuthRequestRefreshToken = { read=FOAuthRequestRefreshToken, write=FSetOAuthRequestRefreshToken };
Default Value
true
Remarks
Specifies whether the component will request a refresh token during authorization. By default, this value is True.
When True, the component will automatically add the necessary scopes or parameters to obtain a refresh token. When False, this property will have no effect. If the necessary scopes or parameters are specified manually, a refresh token can still be obtained.
Note: This property is only applicable when the OAuthGrantType property is set to cogtAuthorizationCode.
This property is not available at design time.
Data Type
Boolean
OAuthReturnURL Property (GoogleDrive Component)
The URL where the user (browser) returns after authenticating.
Syntax
__property String OAuthReturnURL = { read=FOAuthReturnURL, write=FSetOAuthReturnURL };
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 component when using the embedded web server. If the OAuthWebServerPort or OAuthWebServerHost configuration settings is set, then this property should be set to match. If using the Web client profile, this should be set to the place where the authorization code will be parsed out of the response after the user finishes authorizing.
This property is not available at design time.
Data Type
String
OAuthServerAuthURL Property (GoogleDrive Component)
The URL of the authorization server.
Syntax
__property String OAuthServerAuthURL = { read=FOAuthServerAuthURL, write=FSetOAuthServerAuthURL };
Default Value
""
Remarks
The URL of the authorization server.
This property is not available at design time.
Data Type
String
OAuthServerTokenURL Property (GoogleDrive Component)
The URL of the token server used to obtain the access token.
Syntax
__property String OAuthServerTokenURL = { read=FOAuthServerTokenURL, write=FSetOAuthServerTokenURL };
Default Value
""
Remarks
The URL of the token server used to obtain the access token.
This property is not available at design time.
Data Type
String
OAuthWebAuthURL Property (GoogleDrive Component)
The URL to which the user should be re-directed for authorization.
Syntax
__property String OAuthWebAuthURL = { read=FOAuthWebAuthURL };
Default Value
""
Remarks
The URL to which the user should be re-directed for authorization. This field is used to get the URL that the user should be redirected to when using the Web client profile. See introduction section for more information.
This property is read-only and not available at design time.
Data Type
String
OtherHeaders Property (GoogleDrive Component)
This property includes other headers as determined by the user (optional).
Syntax
__property String OtherHeaders = { read=FOtherHeaders, write=FSetOtherHeaders };
Default Value
""
Remarks
This property can be set to a string of headers to be appended to the HTTP request headers created from other properties like ContentType and From.
The headers must follow the format Header: Value as described in the HTTP specifications. Header lines should be separated by CRLF ("\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 component beyond what is provided.
This property is not available at design time.
Data Type
String
Overwrite Property (GoogleDrive Component)
Determines if local files are overwritten.
Syntax
__property bool Overwrite = { read=FOverwrite, write=FSetOverwrite };
Default Value
false
Remarks
This property controls whether local files are overwritten when calling DownloadFile. It is only applicable to local files. The default value is false.
Data Type
Boolean
ParsedHeaderCount Property (GoogleDrive Component)
The number of records in the ParsedHeader arrays.
Syntax
__property int ParsedHeaderCount = { read=FParsedHeaderCount };
Default Value
0
Remarks
This property controls the size of the following arrays:
The array indices start at 0 and end at ParsedHeaderCount - 1.This property is read-only and not available at design time.
Data Type
Integer
ParsedHeaderField Property (GoogleDrive Component)
This property contains the name of the HTTP header (this is the same case as it is delivered).
Syntax
__property String ParsedHeaderField[int ParsedHeaderIndex] = { read=FParsedHeaderField };
Default Value
""
Remarks
This property contains the name of the HTTP Header (this is the same case as it is delivered).
The ParsedHeaderIndex parameter specifies the index of the item in the array. The size of the array is controlled by the ParsedHeaderCount property.
This property is read-only and not available at design time.
Data Type
String
ParsedHeaderValue Property (GoogleDrive Component)
This property contains the header contents.
Syntax
__property String ParsedHeaderValue[int ParsedHeaderIndex] = { read=FParsedHeaderValue };
Default Value
""
Remarks
This property contains the Header contents.
The ParsedHeaderIndex parameter specifies the index of the item in the array. The size of the array is controlled by the ParsedHeaderCount property.
This property is read-only and not available at design time.
Data Type
String
PermissionMarker Property (GoogleDrive Component)
A marker when permissions are paged.
Syntax
__property String PermissionMarker = { read=FPermissionMarker, write=FSetPermissionMarker };
Default Value
""
Remarks
This property returns a marker used to iterate over pages of permissions; it's populated when ListPermissions is called if the results are paged.
Continue to call ListPermissions until this property returns empty string in order to list all permissions.
This property is not available at design time.
Data Type
String
PermissionCount Property (GoogleDrive Component)
The number of records in the Permission arrays.
Syntax
__property int PermissionCount = { read=FPermissionCount, write=FSetPermissionCount };
Default Value
0
Remarks
This property controls the size of the following arrays:
- PermissionAllowFileDiscovery
- PermissionDomain
- PermissionEmail
- PermissionId
- PermissionModOp
- PermissionRole
- PermissionType
This property is not available at design time.
Data Type
Integer
PermissionAllowFileDiscovery Property (GoogleDrive Component)
Whether the permission allows the file or folder to be discovered through search.
Syntax
__property bool PermissionAllowFileDiscovery[int PermissionIndex] = { read=FPermissionAllowFileDiscovery, write=FSetPermissionAllowFileDiscovery };
Default Value
false
Remarks
Whether the permission allows the file or folder to be discovered through search.
This property indicates whether the permission allows the file or folder to which it applies to be discovered through search.
This property is only applicable if the permission's PermissionType is set to 2 (ptDomain) or 3 (ptAnyone).
The PermissionIndex parameter specifies the index of the item in the array. The size of the array is controlled by the PermissionCount property.
This property is not available at design time.
Data Type
Boolean
PermissionDomain Property (GoogleDrive Component)
The domain to which the permission applies.
Syntax
__property String PermissionDomain[int PermissionIndex] = { read=FPermissionDomain, write=FSetPermissionDomain };
Default Value
""
Remarks
The domain to which the permission applies.
This property is used to define the domain to which the permission applies when PermissionType is set to 2 (ptDomain).
The PermissionIndex parameter specifies the index of the item in the array. The size of the array is controlled by the PermissionCount property.
This property is not available at design time.
Data Type
String
PermissionEmail Property (GoogleDrive Component)
The user or group to which the permission applies.
Syntax
__property String PermissionEmail[int PermissionIndex] = { read=FPermissionEmail, write=FSetPermissionEmail };
Default Value
""
Remarks
The user or group to which the permission applies.
This property is used to define the user or group to which the permission applies when PermissionType is set to 0 (ptUser) or 1 (ptGroup).
The PermissionIndex parameter specifies the index of the item in the array. The size of the array is controlled by the PermissionCount property.
This property is not available at design time.
Data Type
String
PermissionId Property (GoogleDrive Component)
The Id of the permission.
Syntax
__property String PermissionId[int PermissionIndex] = { read=FPermissionId, write=FSetPermissionId };
Default Value
""
Remarks
The Id of the permission.
This property holds the Id of the permission.
The PermissionIndex parameter specifies the index of the item in the array. The size of the array is controlled by the PermissionCount property.
This property is not available at design time.
Data Type
String
PermissionModOp Property (GoogleDrive Component)
The operation to perform on the permission.
Syntax
__property TcsGoogleDrivePermissionModOps PermissionModOp[int PermissionIndex] = { read=FPermissionModOp, write=FSetPermissionModOp };
enum TcsGoogleDrivePermissionModOps { moNone=0, moCreate=1, moUpdate=2, moDelete=3 };
Default Value
moNone
Remarks
The operation to perform on the permission.
This property is used to specify the operation that the component should perform on the permission when UpdatePermissions is called. Valid values are:
moNone (0) (default) | No-Op (the component 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 UpdatePermissions for more information.
The PermissionIndex parameter specifies the index of the item in the array. The size of the array is controlled by the PermissionCount property.
This property is not available at design time.
Data Type
Integer
PermissionRole Property (GoogleDrive Component)
The role specified by the permission.
Syntax
__property TcsGoogleDrivePermissionRoles PermissionRole[int PermissionIndex] = { read=FPermissionRole, write=FSetPermissionRole };
enum TcsGoogleDrivePermissionRoles { prReader=0, prCommenter=1, prWriter=2, prOwner=3, prFileOrganizer=4, prOrganizer=5 };
Default Value
prReader
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 property.
This property is not available at design time.
Data Type
Integer
PermissionType Property (GoogleDrive Component)
The set of users to which the permission applies.
Syntax
__property TcsGoogleDrivePermissionTypes PermissionType[int PermissionIndex] = { read=FPermissionType, write=FSetPermissionType };
enum TcsGoogleDrivePermissionTypes { ptUser=0, ptGroup=1, ptDomain=2, ptAnyone=3 };
Default Value
ptUser
Remarks
The set of users to which the permission applies.
This property defines the set of users to which the permission role defined in PermissionRole applies.
The PermissionEmail and PermissionDomain properties are used to define the user, group, or domain to which the permission applies. The following table shows which property is associated with which permission type:
Value | Description | Related property |
0 (ptUser - default) | A single user. | PermissionEmail |
1 (ptGroup) | A group. | PermissionEmail |
2 (ptDomain) | A domain. | PermissionDomain |
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 property.
This property is not available at design time.
Data Type
Integer
ProxyAuthScheme Property (GoogleDrive Component)
This property is used to tell the component which type of authorization to perform when connecting to the proxy.
Syntax
__property TcsGoogleDriveProxyAuthSchemes ProxyAuthScheme = { read=FProxyAuthScheme, write=FSetProxyAuthScheme };
enum TcsGoogleDriveProxyAuthSchemes { authBasic=0, authDigest=1, authProprietary=2, authNone=3, authNtlm=4, authNegotiate=5 };
Default Value
authBasic
Remarks
This property is used to tell the component which type of authorization to perform when connecting to the proxy. This is used only when the ProxyUser and ProxyPassword properties are set.
ProxyAuthScheme should be set to authNone (3) when no authentication is expected.
By default, ProxyAuthScheme is authBasic (0), and if the ProxyUser and ProxyPassword properties are set, the component will attempt basic authentication.
If ProxyAuthScheme is set to authDigest (1), digest authentication will be attempted instead.
If ProxyAuthScheme is set to authProprietary (2), then the authorization token will not be generated by the component. Look at the configuration file for the component being used to find more information about manually setting this token.
If ProxyAuthScheme is set to authNtlm (4), NTLM authentication will be used.
For security reasons, setting this property will clear the values of ProxyUser and ProxyPassword.
Data Type
Integer
ProxyAutoDetect Property (GoogleDrive Component)
This property tells the component whether or not to automatically detect and use proxy system settings, if available.
Syntax
__property bool ProxyAutoDetect = { read=FProxyAutoDetect, write=FSetProxyAutoDetect };
Default Value
False
Remarks
This property tells the component whether or not to automatically detect and use proxy system settings, if available. The default value is false.
Data Type
Boolean
ProxyPassword Property (GoogleDrive Component)
This property contains a password if authentication is to be used for the proxy.
Syntax
__property String ProxyPassword = { read=FProxyPassword, write=FSetProxyPassword };
Default Value
""
Remarks
This property contains a password if authentication is to be used for the proxy.
If ProxyAuthScheme is set to Basic Authentication, the ProxyUser and ProxyPassword properties are Base64 encoded and the proxy authentication token will be generated in the form Basic [encoded-user-password].
If ProxyAuthScheme is set to Digest Authentication, the ProxyUser and ProxyPassword properties are used to respond to the Digest Authentication challenge from the server.
If ProxyAuthScheme is set to NTLM Authentication, the ProxyUser and ProxyPassword properties are used to authenticate through NTLM negotiation.
Data Type
String
ProxyPort Property (GoogleDrive Component)
This property contains the Transmission Control Protocol (TCP) port for the proxy Server (default 80).
Syntax
__property int ProxyPort = { read=FProxyPort, write=FSetProxyPort };
Default Value
80
Remarks
This property contains the Transmission Control Protocol (TCP) port for the proxy ProxyServer (default 80). See the description of the ProxyServer property for details.
Data Type
Integer
ProxyServer Property (GoogleDrive Component)
If a proxy Server is given, then the HTTP request is sent to the proxy instead of the server otherwise specified.
Syntax
__property String ProxyServer = { read=FProxyServer, write=FSetProxyServer };
Default Value
""
Remarks
If a proxy ProxyServer is given, then the HTTP request is sent to the proxy instead of the server otherwise specified.
If the ProxyServer property is set to a domain name, a DNS request is initiated. Upon successful termination of the request, the ProxyServer property is set to the corresponding address. If the search is not successful, an error is returned.
Data Type
String
ProxySSL Property (GoogleDrive Component)
This property determines when to use a Secure Sockets Layer (SSL) for the connection to the proxy.
Syntax
__property TcsGoogleDriveProxySSLs ProxySSL = { read=FProxySSL, write=FSetProxySSL };
enum TcsGoogleDriveProxySSLs { psAutomatic=0, psAlways=1, psNever=2, psTunnel=3 };
Default Value
psAutomatic
Remarks
This property determines 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 component will use the psTunnel option. If the URL is an http URL, the component 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
Integer
ProxyUser Property (GoogleDrive Component)
This property contains a username if authentication is to be used for the proxy.
Syntax
__property String ProxyUser = { read=FProxyUser, write=FSetProxyUser };
Default Value
""
Remarks
This property contains a username if authentication is to be used for the proxy.
If ProxyAuthScheme is set to Basic Authentication, the ProxyUser and ProxyPassword properties are Base64 encoded and the proxy authentication token will be generated in the form Basic [encoded-user-password].
If ProxyAuthScheme is set to Digest Authentication, the ProxyUser and ProxyPassword properties are used to respond to the Digest Authentication challenge from the server.
If ProxyAuthScheme is set to NTLM Authentication, the ProxyUser and ProxyPassword properties are used to authenticate through NTLM negotiation.
Data Type
String
QueryParamCount Property (GoogleDrive Component)
The number of records in the QueryParam arrays.
Syntax
__property int QueryParamCount = { read=FQueryParamCount, write=FSetQueryParamCount };
Default Value
0
Remarks
This property controls the size of the following arrays:
The array indices start at 0 and end at QueryParamCount - 1.This property is not available at design time.
Data Type
Integer
QueryParamName Property (GoogleDrive Component)
The name of the query parameter.
Syntax
__property String QueryParamName[int QueryParamIndex] = { read=FQueryParamName, write=FSetQueryParamName };
Default Value
""
Remarks
The name of the query parameter.
This property specifies the name of the query parameter.
The QueryParamIndex parameter specifies the index of the item in the array. The size of the array is controlled by the QueryParamCount property.
This property is not available at design time.
Data Type
String
QueryParamValue Property (GoogleDrive Component)
The value of the query parameter.
Syntax
__property String QueryParamValue[int QueryParamIndex] = { read=FQueryParamValue, write=FSetQueryParamValue };
Default Value
""
Remarks
The value of the query parameter.
This property specifies the value of the query parameter. The component will automatically URL-encode this value when sending the request.
The QueryParamIndex parameter specifies the index of the item in the array. The size of the array is controlled by the QueryParamCount property.
This property is not available at design time.
Data Type
String
ResourceData Property (GoogleDrive Component)
The data that was downloaded, or that should be uploaded.
Syntax
__property String ResourceData = { read=FResourceData, write=FSetResourceData }; __property DynamicArray<Byte> ResourceDataB = { read=FResourceDataB, write=FSetResourceDataB };
Default Value
""
Remarks
This property is populated with file data after calling DownloadFile if LocalFile is not set.
This property can also be set before calling UploadFile; its data will be uploaded if LocalFile is not set.
This property is not available at design time.
Data Type
Byte Array
ResourceMarker Property (GoogleDrive Component)
A marker indicating what page of resources to return next.
Syntax
__property String ResourceMarker = { read=FResourceMarker, write=FSetResourceMarker };
Default Value
""
Remarks
This property will be populated when ListResources is called if the results are paged and there are more pages. To list all resources, continue to call ListResources until this property returns empty string.
Refer to ListResources for more information.
Note that resources are never paged when calling ListParents or GetResourceInfo.
This property is not available at design time.
Data Type
String
ResourceCount Property (GoogleDrive Component)
The number of records in the Resource arrays.
Syntax
__property int ResourceCount = { read=FResourceCount, write=FSetResourceCount };
Default Value
0
Remarks
This property controls the size of the following arrays:
- ResourceContentAccessible
- ResourceCreatedTime
- ResourceDescription
- ResourceExtension
- ResourceId
- ResourceMD5Checksum
- ResourceMIMEType
- ResourceModifiedTime
- ResourceName
- ResourceOriginalName
- ResourceOwner
- ResourceOwnerEmail
- ResourceParentIds
- ResourceSharedDriveId
- ResourceSize
- ResourceStarred
- ResourceTrashed
- ResourceType
- ResourceViewed
- ResourceViewLink
This property is not available at design time.
Data Type
Integer
ResourceContentAccessible Property (GoogleDrive Component)
Whether the resource's content is accessible to less-privileged users.
Syntax
__property bool ResourceContentAccessible[int ResourceIndex] = { read=FResourceContentAccessible, write=FSetResourceContentAccessible };
Default Value
false
Remarks
Whether the resource's content is accessible to less-privileged users.
This property indicates whether the resource's content is accessible. If the resource is not accessible, it cannot be copied, downloaded, or printed by a users unless they have at least "writer" permissions.
The ResourceIndex parameter specifies the index of the item in the array. The size of the array is controlled by the ResourceCount property.
This property is not available at design time.
Data Type
Boolean
ResourceCreatedTime Property (GoogleDrive Component)
The creation date of the resource.
Syntax
__property String ResourceCreatedTime[int ResourceIndex] = { read=FResourceCreatedTime, write=FSetResourceCreatedTime };
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 component only uses it as input when UploadFile is called; it is ignored when calling UpdateResource.
The ResourceIndex parameter specifies the index of the item in the array. The size of the array is controlled by the ResourceCount property.
This property is not available at design time.
Data Type
String
ResourceDescription Property (GoogleDrive Component)
A short description of the resource.
Syntax
__property String ResourceDescription[int ResourceIndex] = { read=FResourceDescription, write=FSetResourceDescription };
Default Value
""
Remarks
A short description of the resource.
This property specifies a short description of the resource.
The ResourceIndex parameter specifies the index of the item in the array. The size of the array is controlled by the ResourceCount property.
This property is not available at design time.
Data Type
String
ResourceExtension Property (GoogleDrive Component)
The file extension of the resource.
Syntax
__property String ResourceExtension[int ResourceIndex] = { read=FResourceExtension };
Default Value
""
Remarks
The file extension of the resource.
This property indicates the file extension of the resource. It cannot be set, and is empty for folder resources. To specify the extension when creating a new file resource include it when calling UploadFile.
The ResourceIndex parameter specifies the index of the item in the array. The size of the array is controlled by the ResourceCount property.
This property is read-only and not available at design time.
Data Type
String
ResourceId Property (GoogleDrive Component)
The Id of the resource.
Syntax
__property String ResourceId[int ResourceIndex] = { read=FResourceId, write=FSetResourceId };
Default Value
""
Remarks
The Id of the resource.
This property holds the Id of the resource.
This property must be set before calling UpdateResource.
The ResourceIndex parameter specifies the index of the item in the array. The size of the array is controlled by the ResourceCount property.
This property is not available at design time.
Data Type
String
ResourceMD5Checksum Property (GoogleDrive Component)
The MD5 checksum of the file resource.
Syntax
__property String ResourceMD5Checksum[int ResourceIndex] = { read=FResourceMD5Checksum };
Default Value
""
Remarks
The MD5 checksum of the file resource.
This property holds the MD5 checksum of the resource, if it is a file resource.
The ResourceIndex parameter specifies the index of the item in the array. The size of the array is controlled by the ResourceCount property.
This property is read-only and not available at design time.
Data Type
String
ResourceMIMEType Property (GoogleDrive Component)
The MIME type of the resource.
Syntax
__property String ResourceMIMEType[int ResourceIndex] = { read=FResourceMIMEType, write=FSetResourceMIMEType };
Default Value
""
Remarks
The MIME type of the resource.
This property specifies the MIME type of the resource.
When calling UploadFile, this property is ignored in favor of the MimeType parameter of UploadFile.
When calling UpdateResource, this property is only submitted if new file data is being uploaded.
Some Google Drive MIME types:
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 property.
This property is not available at design time.
Data Type
String
ResourceModifiedTime Property (GoogleDrive Component)
The last modified date of the resource.
Syntax
__property String ResourceModifiedTime[int ResourceIndex] = { read=FResourceModifiedTime, write=FSetResourceModifiedTime };
Default Value
""
Remarks
The last modified date of the resource.
This property holds a DateTime string representing the last modified date of the resource. This is a combined date-time value (formatted according to RFC 3339).
The ResourceIndex parameter specifies the index of the item in the array. The size of the array is controlled by the ResourceCount property.
This property is not available at design time.
Data Type
String
ResourceName Property (GoogleDrive Component)
The name of the resource.
Syntax
__property String ResourceName[int ResourceIndex] = { read=FResourceName, write=FSetResourceName };
Default Value
""
Remarks
The name of the resource.
This property specifies the name of the resource.
The ResourceIndex parameter specifies the index of the item in the array. The size of the array is controlled by the ResourceCount property.
This property is not available at design time.
Data Type
String
ResourceOriginalName Property (GoogleDrive Component)
The original name of the file resource.
Syntax
__property String ResourceOriginalName[int ResourceIndex] = { read=FResourceOriginalName };
Default Value
""
Remarks
The original name of the file resource.
This property specifies the original name of a file resource if the file was uploaded manually, or if the name was set programmatically through the API.
Updating ResourceName will not change this value.
The ResourceIndex parameter specifies the index of the item in the array. The size of the array is controlled by the ResourceCount property.
This property is read-only and not available at design time.
Data Type
String
ResourceOwner Property (GoogleDrive Component)
The name of the resource's owner.
Syntax
__property String ResourceOwner[int ResourceIndex] = { read=FResourceOwner };
Default Value
""
Remarks
The name of the resource's owner.
This property holds the name of resource's owner.
The ResourceIndex parameter specifies the index of the item in the array. The size of the array is controlled by the ResourceCount property.
This property is read-only and not available at design time.
Data Type
String
ResourceOwnerEmail Property (GoogleDrive Component)
The email address of the resource's owner.
Syntax
__property String ResourceOwnerEmail[int ResourceIndex] = { read=FResourceOwnerEmail };
Default Value
""
Remarks
The email address of the resource's owner.
This property holds the email address of the resource's owner.
The ResourceIndex parameter specifies the index of the item in the array. The size of the array is controlled by the ResourceCount property.
This property is read-only and not available at design time.
Data Type
String
ResourceParentIds Property (GoogleDrive Component)
The Ids of the resource's parent folders.
Syntax
__property String ResourceParentIds[int ResourceIndex] = { read=FResourceParentIds, write=FSetResourceParentIds };
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 component only uses it as input when UploadFile is called. To modify a resource's parents in any other case, use the AddParents, RemoveParents, and MoveResource methods.
The ResourceIndex parameter specifies the index of the item in the array. The size of the array is controlled by the ResourceCount property.
This property is not available at design time.
Data Type
String
ResourceSharedDriveId Property (GoogleDrive Component)
The Id of the shared drive the resource is in.
Syntax
__property String ResourceSharedDriveId[int ResourceIndex] = { read=FResourceSharedDriveId };
Default Value
""
Remarks
The Id of the shared drive the resource is in.
This property holds the Id of the shared drive that the resource is in, if applicable.
The ResourceIndex parameter specifies the index of the item in the array. The size of the array is controlled by the ResourceCount property.
This property is read-only and not available at design time.
Data Type
String
ResourceSize Property (GoogleDrive Component)
The size of the file resource in bytes.
Syntax
__property __int64 ResourceSize[int ResourceIndex] = { read=FResourceSize };
Default Value
0
Remarks
The size of the file resource in bytes.
This property holds the size of a file resource in bytes. This is only applicable to files.
The ResourceIndex parameter specifies the index of the item in the array. The size of the array is controlled by the ResourceCount property.
This property is read-only and not available at design time.
Data Type
Long64
ResourceStarred Property (GoogleDrive Component)
Whether the resource is starred.
Syntax
__property bool ResourceStarred[int ResourceIndex] = { read=FResourceStarred, write=FSetResourceStarred };
Default Value
false
Remarks
Whether the resource is starred.
This property indicates whether the resource is starred by the current user.
The ResourceIndex parameter specifies the index of the item in the array. The size of the array is controlled by the ResourceCount property.
This property is not available at design time.
Data Type
Boolean
ResourceTrashed Property (GoogleDrive Component)
Whether the resource is in the trash.
Syntax
__property bool ResourceTrashed[int ResourceIndex] = { read=FResourceTrashed, write=FSetResourceTrashed };
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 component only uses it as input when UpdateResource is called; it is ignored when calling UploadFile.
The ResourceIndex parameter specifies the index of the item in the array. The size of the array is controlled by the ResourceCount property.
This property is not available at design time.
Data Type
Boolean
ResourceType Property (GoogleDrive Component)
The resource's type.
Syntax
__property TcsGoogleDriveResourceTypes ResourceType[int ResourceIndex] = { read=FResourceType };
enum TcsGoogleDriveResourceTypes { gdrtFile=0, gdrtFolder=1 };
Default Value
gdrtFile
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 ResourceType property can be used to determine if a resource is a folder, a file, or a revision of a file.
To list, delete, and update folders use the ListResources, DeleteResource, and UpdateResource methods.
The ResourceIndex parameter specifies the index of the item in the array. The size of the array is controlled by the ResourceCount property.
This property is read-only and not available at design time.
Data Type
Integer
ResourceViewed Property (GoogleDrive Component)
Whether the resource has been viewed.
Syntax
__property bool ResourceViewed[int ResourceIndex] = { read=FResourceViewed };
Default Value
false
Remarks
Whether the resource has been viewed.
This property indicates whether the resource has been viewed by the current user.
The ResourceIndex parameter specifies the index of the item in the array. The size of the array is controlled by the ResourceCount property.
This property is read-only and not available at design time.
Data Type
Boolean
ResourceViewLink Property (GoogleDrive Component)
A link for opening the resource in a relevant Google editor or viewer in a browser.
Syntax
__property String ResourceViewLink[int ResourceIndex] = { read=FResourceViewLink };
Default Value
""
Remarks
A link for opening the resource in a relevant Google editor or viewer in a browser.
This property holds the link to the resource. The link may be used to view the resource in a browser or relevant editor.
The ResourceIndex parameter specifies the index of the item in the array. The size of the array is controlled by the ResourceCount property.
This property is read-only and not available at design time.
Data Type
String
ResumeURL Property (GoogleDrive Component)
The resumable upload URL.
Syntax
__property String ResumeURL = { read=FResumeURL, write=FSetResumeURL };
Default Value
""
Remarks
This property holds the URL of the resumable upload session. This is populated by the component automatically when UseResumableUpload is set to true and UploadFile is called to initiate a new upload.
This must be set in order to resume an interrupted upload. See UploadFile for details.
This property is not available at design time.
Data Type
String
SharedDrive Property (GoogleDrive Component)
The shared drive to list file and folder resources for.
Syntax
__property String SharedDrive = { read=FSharedDrive, write=FSetSharedDrive };
Default Value
""
Remarks
When ListResourcesScope is set to lrsSharedDrive (2), this property must be set to a shared drive resource Id before calling ListResources or ListChildren.
This property may also be set to a shared drive resource Id before calling GetCurrentChangeMarker or ListChanges in order to list changes to the specified shared drive and its contents.
Refer to ListResources or ListChanges for more information.
This property is not available at design time.
Data Type
String
SharedDriveMarker Property (GoogleDrive Component)
A marker when shared drives are paged.
Syntax
__property String SharedDriveMarker = { read=FSharedDriveMarker, write=FSetSharedDriveMarker };
Default Value
""
Remarks
This property returns a marker used to iterate over pages of shared drives; it's populated when ListSharedDrives is called if the results are paged.
Continue to call ListSharedDrives until this property returns empty string in order to list all shared drives.
This property is not available at design time.
Data Type
String
SharedDriveCount Property (GoogleDrive Component)
The number of records in the SharedDrive arrays.
Syntax
__property int SharedDriveCount = { read=FSharedDriveCount };
Default Value
0
Remarks
This property controls the size of the following arrays:
- SharedDriveCapabilities
- SharedDriveCreatedTime
- SharedDriveHidden
- SharedDriveId
- SharedDriveName
- SharedDriveRestrictions
This property is read-only and not available at design time.
Data Type
Integer
SharedDriveCapabilities Property (GoogleDrive Component)
The capabilities that the current user has for the shared drive.
Syntax
__property int SharedDriveCapabilities[int SharedDriveIndex] = { read=FSharedDriveCapabilities };
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 property.
This property is read-only and not available at design time.
Data Type
Integer
SharedDriveCreatedTime Property (GoogleDrive Component)
The creation date of the shared drive.
Syntax
__property String SharedDriveCreatedTime[int SharedDriveIndex] = { read=FSharedDriveCreatedTime };
Default Value
""
Remarks
The creation date of the shared drive.
This property holds a DateTime string representing the creation date of the shared drive. This is a combined date-time value (formatted according to RFC 3339).
The SharedDriveIndex parameter specifies the index of the item in the array. The size of the array is controlled by the SharedDriveCount property.
This property is read-only and not available at design time.
Data Type
String
SharedDriveHidden Property (GoogleDrive Component)
Whether the shared drive is hidden from default view.
Syntax
__property bool SharedDriveHidden[int SharedDriveIndex] = { read=FSharedDriveHidden };
Default Value
false
Remarks
Whether the shared drive is hidden from default view.
This property specifies whether the shared drive is hidden from default view. To hide or unhide a shared drive, call the ToggleSharedDriveHidden method.
If a shared drive is hidden, it will not show up in the Google Drive UI by default (but is still otherwise accessible). Google Drive tracks this setting separately for each user; i.e., each member of a shared drive can choose whether the shared drive should be hidden or not.
The SharedDriveIndex parameter specifies the index of the item in the array. The size of the array is controlled by the SharedDriveCount property.
This property is read-only and not available at design time.
Data Type
Boolean
SharedDriveId Property (GoogleDrive Component)
The Id of the shared drive.
Syntax
__property String SharedDriveId[int SharedDriveIndex] = { read=FSharedDriveId };
Default Value
""
Remarks
The Id of the shared drive.
This property holds the Id of the shared drive.
The SharedDriveIndex parameter specifies the index of the item in the array. The size of the array is controlled by the SharedDriveCount property.
This property is read-only and not available at design time.
Data Type
String
SharedDriveName Property (GoogleDrive Component)
The name of the shared drive.
Syntax
__property String SharedDriveName[int SharedDriveIndex] = { read=FSharedDriveName };
Default Value
""
Remarks
The name of the shared drive.
This property reflects the name of the shared drive.
The UpdateSharedDrive method can be used to rename the shared drive if the current user is allowed to do so (i.e., if the SharedDriveCapabilities property has the 0x08000 flag set).
The SharedDriveIndex parameter specifies the index of the item in the array. The size of the array is controlled by the SharedDriveCount property.
This property is read-only and not available at design time.
Data Type
String
SharedDriveRestrictions Property (GoogleDrive Component)
The restrictions that apply to the shared drive.
Syntax
__property int SharedDriveRestrictions[int SharedDriveIndex] = { read=FSharedDriveRestrictions };
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 UpdateSharedDrive method can be used to change any of the shared drive's restrictions that the current user is allowed to alter (indicated by the presence of the 0x00002, 0x00004, and/or 0x00010 flags in the SharedDriveCapabilities property).
The SharedDriveIndex parameter specifies the index of the item in the array. The size of the array is controlled by the SharedDriveCount property.
This property is read-only and not available at design time.
Data Type
Integer
SSLAcceptServerCertEffectiveDate Property (GoogleDrive Component)
This is the date on which this certificate becomes valid.
Syntax
__property String SSLAcceptServerCertEffectiveDate = { read=FSSLAcceptServerCertEffectiveDate };
Default Value
""
Remarks
This is the date on which this certificate becomes valid. Before this date, it is not valid. The date is localized to the system's time zone. The following example illustrates the format of an encoded date:
23-Jan-2000 15:00:00.
This property is read-only.
Data Type
String
SSLAcceptServerCertExpirationDate Property (GoogleDrive Component)
This is the date the certificate expires.
Syntax
__property String SSLAcceptServerCertExpirationDate = { read=FSSLAcceptServerCertExpirationDate };
Default Value
""
Remarks
This is the date the certificate expires. After this date, the certificate will no longer be valid. The date is localized to the system's time zone. The following example illustrates the format of an encoded date:
23-Jan-2001 15:00:00.
This property is read-only.
Data Type
String
SSLAcceptServerCertExtendedKeyUsage Property (GoogleDrive Component)
This is a comma-delimited list of extended key usage identifiers.
Syntax
__property String SSLAcceptServerCertExtendedKeyUsage = { read=FSSLAcceptServerCertExtendedKeyUsage };
Default Value
""
Remarks
This is a comma-delimited list of extended key usage identifiers. These are the same as ASN.1 object identifiers (OIDs).
This property is read-only.
Data Type
String
SSLAcceptServerCertFingerprint Property (GoogleDrive Component)
This is the hex-encoded, 16-byte MD5 fingerprint of the certificate.
Syntax
__property String SSLAcceptServerCertFingerprint = { read=FSSLAcceptServerCertFingerprint };
Default Value
""
Remarks
This is the hex-encoded, 16-byte MD5 fingerprint of the certificate. This property is primarily used for keys which do not have a corresponding X.509 public certificate, such as PEM keys that only contain a private key. It is commonly used for SSH keys.
The following example illustrates the format: bc:2a:72:af:fe:58:17:43:7a:5f:ba:5a:7c:90:f7:02
This property is read-only.
Data Type
String
SSLAcceptServerCertFingerprintSHA1 Property (GoogleDrive Component)
This is the hex-encoded, 20-byte SHA-1 fingerprint of the certificate.
Syntax
__property String SSLAcceptServerCertFingerprintSHA1 = { read=FSSLAcceptServerCertFingerprintSHA1 };
Default Value
""
Remarks
This is the hex-encoded, 20-byte SHA-1 fingerprint of the certificate. This property is primarily used for keys which do not have a corresponding X.509 public certificate, such as PEM keys that only contain a private key. It is commonly used for SSH keys.
The following example illustrates the format: 30:7b:fa:38:65:83:ff:da:b4:4e:07:3f:17:b8:a4:ed:80:be:ff:84
This property is read-only.
Data Type
String
SSLAcceptServerCertFingerprintSHA256 Property (GoogleDrive Component)
This is the hex-encoded, 32-byte SHA-256 fingerprint of the certificate.
Syntax
__property String SSLAcceptServerCertFingerprintSHA256 = { read=FSSLAcceptServerCertFingerprintSHA256 };
Default Value
""
Remarks
This is the hex-encoded, 32-byte SHA-256 fingerprint of the certificate. This property is primarily used for keys which do not have a corresponding X.509 public certificate, such as PEM keys that only contain a private key. It is commonly used for SSH keys.
The following example illustrates the format: 6a:80:5c:33:a9:43:ea:b0:96:12:8a:64:96:30:ef:4a:8a:96:86:ce:f4:c7:be:10:24:8e:2b:60:9e:f3:59:53
This property is read-only.
Data Type
String
SSLAcceptServerCertIssuer Property (GoogleDrive Component)
This is the issuer of the certificate.
Syntax
__property String SSLAcceptServerCertIssuer = { read=FSSLAcceptServerCertIssuer };
Default Value
""
Remarks
This is the issuer of the certificate. This property contains a string representation of the name of the issuing authority for the certificate.
This property is read-only.
Data Type
String
SSLAcceptServerCertPrivateKey Property (GoogleDrive Component)
This is the private key of the certificate (if available).
Syntax
__property String SSLAcceptServerCertPrivateKey = { read=FSSLAcceptServerCertPrivateKey };
Default Value
""
Remarks
This is the private key of the certificate (if available). The key is provided as PEM/Base64-encoded data.
Note: The SSLAcceptServerCertPrivateKey may be available but not exportable. In this case, SSLAcceptServerCertPrivateKey returns an empty string.
This property is read-only.
Data Type
String
SSLAcceptServerCertPrivateKeyAvailable Property (GoogleDrive Component)
This property shows whether a PrivateKey is available for the selected certificate.
Syntax
__property bool SSLAcceptServerCertPrivateKeyAvailable = { read=FSSLAcceptServerCertPrivateKeyAvailable };
Default Value
false
Remarks
This property shows whether a SSLAcceptServerCertPrivateKey is available for the selected certificate. If SSLAcceptServerCertPrivateKeyAvailable is True, the certificate may be used for authentication purposes (e.g., server authentication).
This property is read-only.
Data Type
Boolean
SSLAcceptServerCertPrivateKeyContainer Property (GoogleDrive Component)
This is the name of the PrivateKey container for the certificate (if available).
Syntax
__property String SSLAcceptServerCertPrivateKeyContainer = { read=FSSLAcceptServerCertPrivateKeyContainer };
Default Value
""
Remarks
This is the name of the SSLAcceptServerCertPrivateKey container for the certificate (if available). This functionality is available only on Windows platforms.
This property is read-only.
Data Type
String
SSLAcceptServerCertPublicKey Property (GoogleDrive Component)
This is the public key of the certificate.
Syntax
__property String SSLAcceptServerCertPublicKey = { read=FSSLAcceptServerCertPublicKey };
Default Value
""
Remarks
This is the public key of the certificate. The key is provided as PEM/Base64-encoded data.
This property is read-only.
Data Type
String
SSLAcceptServerCertPublicKeyAlgorithm Property (GoogleDrive Component)
This property contains the textual description of the certificate's public key algorithm.
Syntax
__property String SSLAcceptServerCertPublicKeyAlgorithm = { read=FSSLAcceptServerCertPublicKeyAlgorithm };
Default Value
""
Remarks
This property contains the textual description of the certificate's public key algorithm. The property contains either the name of the algorithm (e.g., "RSA" or "RSA_DH") or an object identifier (OID) string representing the algorithm.
This property is read-only.
Data Type
String
SSLAcceptServerCertPublicKeyLength Property (GoogleDrive Component)
This is the length of the certificate's public key (in bits).
Syntax
__property int SSLAcceptServerCertPublicKeyLength = { read=FSSLAcceptServerCertPublicKeyLength };
Default Value
0
Remarks
This is the length of the certificate's public key (in bits). Common values are 512, 1024, and 2048.
This property is read-only.
Data Type
Integer
SSLAcceptServerCertSerialNumber Property (GoogleDrive Component)
This is the serial number of the certificate encoded as a string.
Syntax
__property String SSLAcceptServerCertSerialNumber = { read=FSSLAcceptServerCertSerialNumber };
Default Value
""
Remarks
This is the serial number of the certificate encoded as a string. The number is encoded as a series of hexadecimal digits, with each pair representing a byte of the serial number.
This property is read-only.
Data Type
String
SSLAcceptServerCertSignatureAlgorithm Property (GoogleDrive Component)
The property contains the text description of the certificate's signature algorithm.
Syntax
__property String SSLAcceptServerCertSignatureAlgorithm = { read=FSSLAcceptServerCertSignatureAlgorithm };
Default Value
""
Remarks
The property contains the text description of the certificate's signature algorithm. The property contains either the name of the algorithm (e.g., "RSA" or "RSA_MD5RSA") or an object identifier (OID) string representing the algorithm.
This property is read-only.
Data Type
String
SSLAcceptServerCertStore Property (GoogleDrive Component)
This is the name of the certificate store for the client certificate.
Syntax
__property String SSLAcceptServerCertStore = { read=FSSLAcceptServerCertStore, write=FSetSSLAcceptServerCertStore }; __property DynamicArray<Byte> SSLAcceptServerCertStoreB = { read=FSSLAcceptServerCertStoreB, write=FSetSSLAcceptServerCertStoreB };
Default Value
"MY"
Remarks
This is the name of the certificate store for the client certificate.
The SSLAcceptServerCertStoreType property denotes the type of the certificate store specified by SSLAcceptServerCertStore. If the store is password protected, specify the password in SSLAcceptServerCertStorePassword.
SSLAcceptServerCertStore is used in conjunction with the SSLAcceptServerCertSubject property to specify client certificates. If SSLAcceptServerCertStore has a value, and SSLAcceptServerCertSubject or SSLAcceptServerCertEncoded is set, a search for a certificate is initiated. Please see the SSLAcceptServerCertSubject property for details.
Designations of certificate stores are platform dependent.
The following designations are the most common User and Machine certificate stores in Windows:
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 PFXFile, this property must be set to the name of the file. When the type is PFXBlob, the property must be set to the binary contents of a PFX file (i.e., PKCS#12 certificate store).
Data Type
Byte Array
SSLAcceptServerCertStorePassword Property (GoogleDrive Component)
If the type of certificate store requires a password, this property is used to specify the password needed to open the certificate store.
Syntax
__property String SSLAcceptServerCertStorePassword = { read=FSSLAcceptServerCertStorePassword, write=FSetSSLAcceptServerCertStorePassword };
Default Value
""
Remarks
If the type of certificate store requires a password, this property is used to specify the password needed to open the certificate store.
Data Type
String
SSLAcceptServerCertStoreType Property (GoogleDrive Component)
This is the type of certificate store for this certificate.
Syntax
__property TcsGoogleDriveSSLAcceptServerCertStoreTypes SSLAcceptServerCertStoreType = { read=FSSLAcceptServerCertStoreType, write=FSetSSLAcceptServerCertStoreType };
enum TcsGoogleDriveSSLAcceptServerCertStoreTypes { cstUser=0, cstMachine=1, cstPFXFile=2, cstPFXBlob=3, cstJKSFile=4, cstJKSBlob=5, cstPEMKeyFile=6, cstPEMKeyBlob=7, cstPublicKeyFile=8, cstPublicKeyBlob=9, cstSSHPublicKeyBlob=10, cstP7BFile=11, cstP7BBlob=12, cstSSHPublicKeyFile=13, cstPPKFile=14, cstPPKBlob=15, cstXMLFile=16, cstXMLBlob=17, cstJWKFile=18, cstJWKBlob=19, cstSecurityKey=20, cstBCFKSFile=21, cstBCFKSBlob=22, cstPKCS11=23, cstAuto=99 };
Default Value
cstUser
Remarks
This is the type of certificate store for this certificate.
The component supports both public and private keys in a variety of formats. When the cstAuto value is used, the component will automatically determine the type. This property can take one of the following values:
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, the necessary data must first be collected using the CertMgr component. The ListStoreCertificates method may be called after setting CertStoreType to cstPKCS11, CertStorePassword to the PIN, and CertStore to the full path of the PKCS#11 DLL. The certificate information returned in the CertList event's CertEncoded parameter may be saved for later use. When using a certificate, pass the previously saved security key information as the SSLAcceptServerCertStore and set SSLAcceptServerCertStorePassword to the PIN. Code Example. SSH Authentication with Security Key:
|
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
Integer
SSLAcceptServerCertSubjectAltNames Property (GoogleDrive Component)
This property contains comma-separated lists of alternative subject names for the certificate.
Syntax
__property String SSLAcceptServerCertSubjectAltNames = { read=FSSLAcceptServerCertSubjectAltNames };
Default Value
""
Remarks
This property contains comma-separated lists of alternative subject names for the certificate.
This property is read-only.
Data Type
String
SSLAcceptServerCertThumbprintMD5 Property (GoogleDrive Component)
This property contains the MD5 hash of the certificate.
Syntax
__property String SSLAcceptServerCertThumbprintMD5 = { read=FSSLAcceptServerCertThumbprintMD5 };
Default Value
""
Remarks
This property contains the MD5 hash of the certificate. It is primarily used for X.509 certificates. If the hash does not already exist, it is automatically computed.
This property is read-only.
Data Type
String
SSLAcceptServerCertThumbprintSHA1 Property (GoogleDrive Component)
This property contains the SHA-1 hash of the certificate.
Syntax
__property String SSLAcceptServerCertThumbprintSHA1 = { read=FSSLAcceptServerCertThumbprintSHA1 };
Default Value
""
Remarks
This property contains the SHA-1 hash of the certificate. It is primarily used for X.509 certificates. If the hash does not already exist, it is automatically computed.
This property is read-only.
Data Type
String
SSLAcceptServerCertThumbprintSHA256 Property (GoogleDrive Component)
This property contains the SHA-256 hash of the certificate.
Syntax
__property String SSLAcceptServerCertThumbprintSHA256 = { read=FSSLAcceptServerCertThumbprintSHA256 };
Default Value
""
Remarks
This property contains the SHA-256 hash of the certificate. It is primarily used for X.509 certificates. If the hash does not already exist, it is automatically computed.
This property is read-only.
Data Type
String
SSLAcceptServerCertUsage Property (GoogleDrive Component)
This property contains the text description of UsageFlags .
Syntax
__property String SSLAcceptServerCertUsage = { read=FSSLAcceptServerCertUsage };
Default Value
""
Remarks
This property contains the text description of SSLAcceptServerCertUsageFlags.
This value will be of one or more of the following strings and will be separated by commas:
- Digital Signature
- Non-Repudiation
- Key Encipherment
- Data Encipherment
- Key Agreement
- Certificate Signing
- CRL Signing
- Encipher Only
If the provider is OpenSSL, the value is a comma-separated list of X.509 certificate extension names.
This property is read-only.
Data Type
String
SSLAcceptServerCertUsageFlags Property (GoogleDrive Component)
This property contains the flags that show intended use for the certificate.
Syntax
__property int SSLAcceptServerCertUsageFlags = { read=FSSLAcceptServerCertUsageFlags };
Default Value
0
Remarks
This property contains the flags that show intended use for the certificate. The value of SSLAcceptServerCertUsageFlags 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 SSLAcceptServerCertUsage property for a text representation of SSLAcceptServerCertUsageFlags.
This functionality currently is not available when the provider is OpenSSL.
This property is read-only.
Data Type
Integer
SSLAcceptServerCertVersion Property (GoogleDrive Component)
This property contains the certificate's version number.
Syntax
__property String SSLAcceptServerCertVersion = { read=FSSLAcceptServerCertVersion };
Default Value
""
Remarks
This property contains the certificate's version number. The possible values are the strings "V1", "V2", and "V3".
This property is read-only.
Data Type
String
SSLAcceptServerCertSubject Property (GoogleDrive Component)
This is the subject of the certificate used for client authentication.
Syntax
__property String SSLAcceptServerCertSubject = { read=FSSLAcceptServerCertSubject, write=FSetSSLAcceptServerCertSubject };
Default Value
""
Remarks
This is the subject of the certificate used for client authentication.
This property must be set after all other certificate properties are set. When this property is set, a search is performed in the current certificate store to locate a certificate with a matching subject.
If a matching certificate is found, the property is set to the full subject of the matching certificate.
If an exact match is not found, the store is searched for subjects containing the value of the property.
If a match is still not found, the property is set to an empty string, and no certificate is selected.
The special value "*" picks a random certificate in the certificate store.
The certificate subject is a comma-separated list of distinguished name fields and values. For instance, "CN=www.server.com, OU=test, C=US, E=support@nsoftware.com". Common fields and their meanings are as follows:
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
SSLAcceptServerCertEncoded Property (GoogleDrive Component)
This is the certificate (PEM/Base64 encoded).
Syntax
__property String SSLAcceptServerCertEncoded = { read=FSSLAcceptServerCertEncoded, write=FSetSSLAcceptServerCertEncoded }; __property DynamicArray<Byte> SSLAcceptServerCertEncodedB = { read=FSSLAcceptServerCertEncodedB, write=FSetSSLAcceptServerCertEncodedB };
Default Value
""
Remarks
This is the certificate (PEM/Base64 encoded). This property is used to assign a specific certificate. The SSLAcceptServerCertStore and SSLAcceptServerCertSubject properties also may be used to specify a certificate.
When SSLAcceptServerCertEncoded is set, a search is initiated in the current SSLAcceptServerCertStore for the private key of the certificate. If the key is found, SSLAcceptServerCertSubject is updated to reflect the full subject of the selected certificate; otherwise, SSLAcceptServerCertSubject is set to an empty string.
This property is not available at design time.
Data Type
Byte Array
SSLCertEffectiveDate Property (GoogleDrive Component)
This is the date on which this certificate becomes valid.
Syntax
__property String SSLCertEffectiveDate = { read=FSSLCertEffectiveDate };
Default Value
""
Remarks
This is the date on which this certificate becomes valid. Before this date, it is not valid. The date is localized to the system's time zone. The following example illustrates the format of an encoded date:
23-Jan-2000 15:00:00.
This property is read-only.
Data Type
String
SSLCertExpirationDate Property (GoogleDrive Component)
This is the date the certificate expires.
Syntax
__property String SSLCertExpirationDate = { read=FSSLCertExpirationDate };
Default Value
""
Remarks
This is the date the certificate expires. After this date, the certificate will no longer be valid. The date is localized to the system's time zone. The following example illustrates the format of an encoded date:
23-Jan-2001 15:00:00.
This property is read-only.
Data Type
String
SSLCertExtendedKeyUsage Property (GoogleDrive Component)
This is a comma-delimited list of extended key usage identifiers.
Syntax
__property String SSLCertExtendedKeyUsage = { read=FSSLCertExtendedKeyUsage };
Default Value
""
Remarks
This is a comma-delimited list of extended key usage identifiers. These are the same as ASN.1 object identifiers (OIDs).
This property is read-only.
Data Type
String
SSLCertFingerprint Property (GoogleDrive Component)
This is the hex-encoded, 16-byte MD5 fingerprint of the certificate.
Syntax
__property String SSLCertFingerprint = { read=FSSLCertFingerprint };
Default Value
""
Remarks
This is the hex-encoded, 16-byte MD5 fingerprint of the certificate. This property is primarily used for keys which do not have a corresponding X.509 public certificate, such as PEM keys that only contain a private key. It is commonly used for SSH keys.
The following example illustrates the format: bc:2a:72:af:fe:58:17:43:7a:5f:ba:5a:7c:90:f7:02
This property is read-only.
Data Type
String
SSLCertFingerprintSHA1 Property (GoogleDrive Component)
This is the hex-encoded, 20-byte SHA-1 fingerprint of the certificate.
Syntax
__property String SSLCertFingerprintSHA1 = { read=FSSLCertFingerprintSHA1 };
Default Value
""
Remarks
This is the hex-encoded, 20-byte SHA-1 fingerprint of the certificate. This property is primarily used for keys which do not have a corresponding X.509 public certificate, such as PEM keys that only contain a private key. It is commonly used for SSH keys.
The following example illustrates the format: 30:7b:fa:38:65:83:ff:da:b4:4e:07:3f:17:b8:a4:ed:80:be:ff:84
This property is read-only.
Data Type
String
SSLCertFingerprintSHA256 Property (GoogleDrive Component)
This is the hex-encoded, 32-byte SHA-256 fingerprint of the certificate.
Syntax
__property String SSLCertFingerprintSHA256 = { read=FSSLCertFingerprintSHA256 };
Default Value
""
Remarks
This is the hex-encoded, 32-byte SHA-256 fingerprint of the certificate. This property is primarily used for keys which do not have a corresponding X.509 public certificate, such as PEM keys that only contain a private key. It is commonly used for SSH keys.
The following example illustrates the format: 6a:80:5c:33:a9:43:ea:b0:96:12:8a:64:96:30:ef:4a:8a:96:86:ce:f4:c7:be:10:24:8e:2b:60:9e:f3:59:53
This property is read-only.
Data Type
String
SSLCertIssuer Property (GoogleDrive Component)
This is the issuer of the certificate.
Syntax
__property String SSLCertIssuer = { read=FSSLCertIssuer };
Default Value
""
Remarks
This is the issuer of the certificate. This property contains a string representation of the name of the issuing authority for the certificate.
This property is read-only.
Data Type
String
SSLCertPrivateKey Property (GoogleDrive Component)
This is the private key of the certificate (if available).
Syntax
__property String SSLCertPrivateKey = { read=FSSLCertPrivateKey };
Default Value
""
Remarks
This is the private key of the certificate (if available). The key is provided as PEM/Base64-encoded data.
Note: The SSLCertPrivateKey may be available but not exportable. In this case, SSLCertPrivateKey returns an empty string.
This property is read-only.
Data Type
String
SSLCertPrivateKeyAvailable Property (GoogleDrive Component)
This property shows whether a PrivateKey is available for the selected certificate.
Syntax
__property bool SSLCertPrivateKeyAvailable = { read=FSSLCertPrivateKeyAvailable };
Default Value
false
Remarks
This property shows whether a SSLCertPrivateKey is available for the selected certificate. If SSLCertPrivateKeyAvailable is True, the certificate may be used for authentication purposes (e.g., server authentication).
This property is read-only.
Data Type
Boolean
SSLCertPrivateKeyContainer Property (GoogleDrive Component)
This is the name of the PrivateKey container for the certificate (if available).
Syntax
__property String SSLCertPrivateKeyContainer = { read=FSSLCertPrivateKeyContainer };
Default Value
""
Remarks
This is the name of the SSLCertPrivateKey container for the certificate (if available). This functionality is available only on Windows platforms.
This property is read-only.
Data Type
String
SSLCertPublicKey Property (GoogleDrive Component)
This is the public key of the certificate.
Syntax
__property String SSLCertPublicKey = { read=FSSLCertPublicKey };
Default Value
""
Remarks
This is the public key of the certificate. The key is provided as PEM/Base64-encoded data.
This property is read-only.
Data Type
String
SSLCertPublicKeyAlgorithm Property (GoogleDrive Component)
This property contains the textual description of the certificate's public key algorithm.
Syntax
__property String SSLCertPublicKeyAlgorithm = { read=FSSLCertPublicKeyAlgorithm };
Default Value
""
Remarks
This property contains the textual description of the certificate's public key algorithm. The property contains either the name of the algorithm (e.g., "RSA" or "RSA_DH") or an object identifier (OID) string representing the algorithm.
This property is read-only.
Data Type
String
SSLCertPublicKeyLength Property (GoogleDrive Component)
This is the length of the certificate's public key (in bits).
Syntax
__property int SSLCertPublicKeyLength = { read=FSSLCertPublicKeyLength };
Default Value
0
Remarks
This is the length of the certificate's public key (in bits). Common values are 512, 1024, and 2048.
This property is read-only.
Data Type
Integer
SSLCertSerialNumber Property (GoogleDrive Component)
This is the serial number of the certificate encoded as a string.
Syntax
__property String SSLCertSerialNumber = { read=FSSLCertSerialNumber };
Default Value
""
Remarks
This is the serial number of the certificate encoded as a string. The number is encoded as a series of hexadecimal digits, with each pair representing a byte of the serial number.
This property is read-only.
Data Type
String
SSLCertSignatureAlgorithm Property (GoogleDrive Component)
The property contains the text description of the certificate's signature algorithm.
Syntax
__property String SSLCertSignatureAlgorithm = { read=FSSLCertSignatureAlgorithm };
Default Value
""
Remarks
The property contains the text description of the certificate's signature algorithm. The property contains either the name of the algorithm (e.g., "RSA" or "RSA_MD5RSA") or an object identifier (OID) string representing the algorithm.
This property is read-only.
Data Type
String
SSLCertStore Property (GoogleDrive Component)
This is the name of the certificate store for the client certificate.
Syntax
__property String SSLCertStore = { read=FSSLCertStore, write=FSetSSLCertStore }; __property DynamicArray<Byte> SSLCertStoreB = { read=FSSLCertStoreB, write=FSetSSLCertStoreB };
Default Value
"MY"
Remarks
This is the name of the certificate store for the client certificate.
The SSLCertStoreType property denotes the type of the certificate store specified by SSLCertStore. If the store is password protected, specify the password in SSLCertStorePassword.
SSLCertStore is used in conjunction with the SSLCertSubject property to specify client certificates. If SSLCertStore has a value, and SSLCertSubject or SSLCertEncoded is set, a search for a certificate is initiated. Please see the SSLCertSubject property for details.
Designations of certificate stores are platform dependent.
The following designations are the most common User and Machine certificate stores in Windows:
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 PFXFile, this property must be set to the name of the file. When the type is PFXBlob, the property must be set to the binary contents of a PFX file (i.e., PKCS#12 certificate store).
Data Type
Byte Array
SSLCertStorePassword Property (GoogleDrive Component)
If the type of certificate store requires a password, this property is used to specify the password needed to open the certificate store.
Syntax
__property String SSLCertStorePassword = { read=FSSLCertStorePassword, write=FSetSSLCertStorePassword };
Default Value
""
Remarks
If the type of certificate store requires a password, this property is used to specify the password needed to open the certificate store.
Data Type
String
SSLCertStoreType Property (GoogleDrive Component)
This is the type of certificate store for this certificate.
Syntax
__property TcsGoogleDriveSSLCertStoreTypes SSLCertStoreType = { read=FSSLCertStoreType, write=FSetSSLCertStoreType };
enum TcsGoogleDriveSSLCertStoreTypes { cstUser=0, cstMachine=1, cstPFXFile=2, cstPFXBlob=3, cstJKSFile=4, cstJKSBlob=5, cstPEMKeyFile=6, cstPEMKeyBlob=7, cstPublicKeyFile=8, cstPublicKeyBlob=9, cstSSHPublicKeyBlob=10, cstP7BFile=11, cstP7BBlob=12, cstSSHPublicKeyFile=13, cstPPKFile=14, cstPPKBlob=15, cstXMLFile=16, cstXMLBlob=17, cstJWKFile=18, cstJWKBlob=19, cstSecurityKey=20, cstBCFKSFile=21, cstBCFKSBlob=22, cstPKCS11=23, cstAuto=99 };
Default Value
cstUser
Remarks
This is the type of certificate store for this certificate.
The component supports both public and private keys in a variety of formats. When the cstAuto value is used, the component will automatically determine the type. This property can take one of the following values:
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, the necessary data must first be collected using the CertMgr component. The ListStoreCertificates method may be called after setting CertStoreType to cstPKCS11, CertStorePassword to the PIN, and CertStore to the full path of the PKCS#11 DLL. The certificate information returned in the CertList event's CertEncoded parameter may be saved for later use. When using a certificate, pass the previously saved security key information as the SSLCertStore and set SSLCertStorePassword to the PIN. Code Example. SSH Authentication with Security Key:
|
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
Integer
SSLCertSubjectAltNames Property (GoogleDrive Component)
This property contains comma-separated lists of alternative subject names for the certificate.
Syntax
__property String SSLCertSubjectAltNames = { read=FSSLCertSubjectAltNames };
Default Value
""
Remarks
This property contains comma-separated lists of alternative subject names for the certificate.
This property is read-only.
Data Type
String
SSLCertThumbprintMD5 Property (GoogleDrive Component)
This property contains the MD5 hash of the certificate.
Syntax
__property String SSLCertThumbprintMD5 = { read=FSSLCertThumbprintMD5 };
Default Value
""
Remarks
This property contains the MD5 hash of the certificate. It is primarily used for X.509 certificates. If the hash does not already exist, it is automatically computed.
This property is read-only.
Data Type
String
SSLCertThumbprintSHA1 Property (GoogleDrive Component)
This property contains the SHA-1 hash of the certificate.
Syntax
__property String SSLCertThumbprintSHA1 = { read=FSSLCertThumbprintSHA1 };
Default Value
""
Remarks
This property contains the SHA-1 hash of the certificate. It is primarily used for X.509 certificates. If the hash does not already exist, it is automatically computed.
This property is read-only.
Data Type
String
SSLCertThumbprintSHA256 Property (GoogleDrive Component)
This property contains the SHA-256 hash of the certificate.
Syntax
__property String SSLCertThumbprintSHA256 = { read=FSSLCertThumbprintSHA256 };
Default Value
""
Remarks
This property contains the SHA-256 hash of the certificate. It is primarily used for X.509 certificates. If the hash does not already exist, it is automatically computed.
This property is read-only.
Data Type
String
SSLCertUsage Property (GoogleDrive Component)
This property contains the text description of UsageFlags .
Syntax
__property String SSLCertUsage = { read=FSSLCertUsage };
Default Value
""
Remarks
This property contains the text description of SSLCertUsageFlags.
This value will be of one or more of the following strings and will be separated by commas:
- Digital Signature
- Non-Repudiation
- Key Encipherment
- Data Encipherment
- Key Agreement
- Certificate Signing
- CRL Signing
- Encipher Only
If the provider is OpenSSL, the value is a comma-separated list of X.509 certificate extension names.
This property is read-only.
Data Type
String
SSLCertUsageFlags Property (GoogleDrive Component)
This property contains the flags that show intended use for the certificate.
Syntax
__property int SSLCertUsageFlags = { read=FSSLCertUsageFlags };
Default Value
0
Remarks
This property contains the flags that show intended use for the certificate. The value of SSLCertUsageFlags 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 SSLCertUsage property for a text representation of SSLCertUsageFlags.
This functionality currently is not available when the provider is OpenSSL.
This property is read-only.
Data Type
Integer
SSLCertVersion Property (GoogleDrive Component)
This property contains the certificate's version number.
Syntax
__property String SSLCertVersion = { read=FSSLCertVersion };
Default Value
""
Remarks
This property contains the certificate's version number. The possible values are the strings "V1", "V2", and "V3".
This property is read-only.
Data Type
String
SSLCertSubject Property (GoogleDrive Component)
This is the subject of the certificate used for client authentication.
Syntax
__property String SSLCertSubject = { read=FSSLCertSubject, write=FSetSSLCertSubject };
Default Value
""
Remarks
This is the subject of the certificate used for client authentication.
This property must be set after all other certificate properties are set. When this property is set, a search is performed in the current certificate store to locate a certificate with a matching subject.
If a matching certificate is found, the property is set to the full subject of the matching certificate.
If an exact match is not found, the store is searched for subjects containing the value of the property.
If a match is still not found, the property is set to an empty string, and no certificate is selected.
The special value "*" picks a random certificate in the certificate store.
The certificate subject is a comma-separated list of distinguished name fields and values. For instance, "CN=www.server.com, OU=test, C=US, E=support@nsoftware.com". Common fields and their meanings are as follows:
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
SSLCertEncoded Property (GoogleDrive Component)
This is the certificate (PEM/Base64 encoded).
Syntax
__property String SSLCertEncoded = { read=FSSLCertEncoded, write=FSetSSLCertEncoded }; __property DynamicArray<Byte> SSLCertEncodedB = { read=FSSLCertEncodedB, write=FSetSSLCertEncodedB };
Default Value
""
Remarks
This is the certificate (PEM/Base64 encoded). This property is used to assign a specific certificate. The SSLCertStore and SSLCertSubject properties also may be used to specify a certificate.
When SSLCertEncoded is set, a search is initiated in the current SSLCertStore for the private key of the certificate. If the key is found, SSLCertSubject is updated to reflect the full subject of the selected certificate; otherwise, SSLCertSubject is set to an empty string.
This property is not available at design time.
Data Type
Byte Array
SSLProvider Property (GoogleDrive Component)
This property specifies the Secure Sockets Layer/Transport Layer Security (SSL/TLS) implementation to use.
Syntax
__property TcsGoogleDriveSSLProviders SSLProvider = { read=FSSLProvider, write=FSetSSLProvider };
enum TcsGoogleDriveSSLProviders { sslpAutomatic=0, sslpPlatform=1, sslpInternal=2 };
Default Value
sslpAutomatic
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 component 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. |
In most cases using the default value (Automatic) is recommended. The component will select a provider depending on the current platform.
When Automatic is selected, the platform implementation is used by default. When TLS 1.3 is enabled via SSLEnabledProtocols, the internal implementation is used.
Data Type
Integer
SSLServerCertEffectiveDate Property (GoogleDrive Component)
This is the date on which this certificate becomes valid.
Syntax
__property String SSLServerCertEffectiveDate = { read=FSSLServerCertEffectiveDate };
Default Value
""
Remarks
This is the date on which this certificate becomes valid. Before this date, it is not valid. The date is localized to the system's time zone. The following example illustrates the format of an encoded date:
23-Jan-2000 15:00:00.
This property is read-only.
Data Type
String
SSLServerCertExpirationDate Property (GoogleDrive Component)
This is the date the certificate expires.
Syntax
__property String SSLServerCertExpirationDate = { read=FSSLServerCertExpirationDate };
Default Value
""
Remarks
This is the date the certificate expires. After this date, the certificate will no longer be valid. The date is localized to the system's time zone. The following example illustrates the format of an encoded date:
23-Jan-2001 15:00:00.
This property is read-only.
Data Type
String
SSLServerCertExtendedKeyUsage Property (GoogleDrive Component)
This is a comma-delimited list of extended key usage identifiers.
Syntax
__property String SSLServerCertExtendedKeyUsage = { read=FSSLServerCertExtendedKeyUsage };
Default Value
""
Remarks
This is a comma-delimited list of extended key usage identifiers. These are the same as ASN.1 object identifiers (OIDs).
This property is read-only.
Data Type
String
SSLServerCertFingerprint Property (GoogleDrive Component)
This is the hex-encoded, 16-byte MD5 fingerprint of the certificate.
Syntax
__property String SSLServerCertFingerprint = { read=FSSLServerCertFingerprint };
Default Value
""
Remarks
This is the hex-encoded, 16-byte MD5 fingerprint of the certificate. This property is primarily used for keys which do not have a corresponding X.509 public certificate, such as PEM keys that only contain a private key. It is commonly used for SSH keys.
The following example illustrates the format: bc:2a:72:af:fe:58:17:43:7a:5f:ba:5a:7c:90:f7:02
This property is read-only.
Data Type
String
SSLServerCertFingerprintSHA1 Property (GoogleDrive Component)
This is the hex-encoded, 20-byte SHA-1 fingerprint of the certificate.
Syntax
__property String SSLServerCertFingerprintSHA1 = { read=FSSLServerCertFingerprintSHA1 };
Default Value
""
Remarks
This is the hex-encoded, 20-byte SHA-1 fingerprint of the certificate. This property is primarily used for keys which do not have a corresponding X.509 public certificate, such as PEM keys that only contain a private key. It is commonly used for SSH keys.
The following example illustrates the format: 30:7b:fa:38:65:83:ff:da:b4:4e:07:3f:17:b8:a4:ed:80:be:ff:84
This property is read-only.
Data Type
String
SSLServerCertFingerprintSHA256 Property (GoogleDrive Component)
This is the hex-encoded, 32-byte SHA-256 fingerprint of the certificate.
Syntax
__property String SSLServerCertFingerprintSHA256 = { read=FSSLServerCertFingerprintSHA256 };
Default Value
""
Remarks
This is the hex-encoded, 32-byte SHA-256 fingerprint of the certificate. This property is primarily used for keys which do not have a corresponding X.509 public certificate, such as PEM keys that only contain a private key. It is commonly used for SSH keys.
The following example illustrates the format: 6a:80:5c:33:a9:43:ea:b0:96:12:8a:64:96:30:ef:4a:8a:96:86:ce:f4:c7:be:10:24:8e:2b:60:9e:f3:59:53
This property is read-only.
Data Type
String
SSLServerCertIssuer Property (GoogleDrive Component)
This is the issuer of the certificate.
Syntax
__property String SSLServerCertIssuer = { read=FSSLServerCertIssuer };
Default Value
""
Remarks
This is the issuer of the certificate. This property contains a string representation of the name of the issuing authority for the certificate.
This property is read-only.
Data Type
String
SSLServerCertPrivateKey Property (GoogleDrive Component)
This is the private key of the certificate (if available).
Syntax
__property String SSLServerCertPrivateKey = { read=FSSLServerCertPrivateKey };
Default Value
""
Remarks
This is the private key of the certificate (if available). The key is provided as PEM/Base64-encoded data.
Note: The SSLServerCertPrivateKey may be available but not exportable. In this case, SSLServerCertPrivateKey returns an empty string.
This property is read-only.
Data Type
String
SSLServerCertPrivateKeyAvailable Property (GoogleDrive Component)
This property shows whether a PrivateKey is available for the selected certificate.
Syntax
__property bool SSLServerCertPrivateKeyAvailable = { read=FSSLServerCertPrivateKeyAvailable };
Default Value
false
Remarks
This property shows whether a SSLServerCertPrivateKey is available for the selected certificate. If SSLServerCertPrivateKeyAvailable is True, the certificate may be used for authentication purposes (e.g., server authentication).
This property is read-only.
Data Type
Boolean
SSLServerCertPrivateKeyContainer Property (GoogleDrive Component)
This is the name of the PrivateKey container for the certificate (if available).
Syntax
__property String SSLServerCertPrivateKeyContainer = { read=FSSLServerCertPrivateKeyContainer };
Default Value
""
Remarks
This is the name of the SSLServerCertPrivateKey container for the certificate (if available). This functionality is available only on Windows platforms.
This property is read-only.
Data Type
String
SSLServerCertPublicKey Property (GoogleDrive Component)
This is the public key of the certificate.
Syntax
__property String SSLServerCertPublicKey = { read=FSSLServerCertPublicKey };
Default Value
""
Remarks
This is the public key of the certificate. The key is provided as PEM/Base64-encoded data.
This property is read-only.
Data Type
String
SSLServerCertPublicKeyAlgorithm Property (GoogleDrive Component)
This property contains the textual description of the certificate's public key algorithm.
Syntax
__property String SSLServerCertPublicKeyAlgorithm = { read=FSSLServerCertPublicKeyAlgorithm };
Default Value
""
Remarks
This property contains the textual description of the certificate's public key algorithm. The property contains either the name of the algorithm (e.g., "RSA" or "RSA_DH") or an object identifier (OID) string representing the algorithm.
This property is read-only.
Data Type
String
SSLServerCertPublicKeyLength Property (GoogleDrive Component)
This is the length of the certificate's public key (in bits).
Syntax
__property int SSLServerCertPublicKeyLength = { read=FSSLServerCertPublicKeyLength };
Default Value
0
Remarks
This is the length of the certificate's public key (in bits). Common values are 512, 1024, and 2048.
This property is read-only.
Data Type
Integer
SSLServerCertSerialNumber Property (GoogleDrive Component)
This is the serial number of the certificate encoded as a string.
Syntax
__property String SSLServerCertSerialNumber = { read=FSSLServerCertSerialNumber };
Default Value
""
Remarks
This is the serial number of the certificate encoded as a string. The number is encoded as a series of hexadecimal digits, with each pair representing a byte of the serial number.
This property is read-only.
Data Type
String
SSLServerCertSignatureAlgorithm Property (GoogleDrive Component)
The property contains the text description of the certificate's signature algorithm.
Syntax
__property String SSLServerCertSignatureAlgorithm = { read=FSSLServerCertSignatureAlgorithm };
Default Value
""
Remarks
The property contains the text description of the certificate's signature algorithm. The property contains either the name of the algorithm (e.g., "RSA" or "RSA_MD5RSA") or an object identifier (OID) string representing the algorithm.
This property is read-only.
Data Type
String
SSLServerCertStore Property (GoogleDrive Component)
This is the name of the certificate store for the client certificate.
Syntax
__property String SSLServerCertStore = { read=FSSLServerCertStore }; __property DynamicArray<Byte> SSLServerCertStoreB = { read=FSSLServerCertStoreB };
Default Value
"MY"
Remarks
This is the name of the certificate store for the client certificate.
The SSLServerCertStoreType property denotes the type of the certificate store specified by SSLServerCertStore. If the store is password protected, specify the password in SSLServerCertStorePassword.
SSLServerCertStore is used in conjunction with the SSLServerCertSubject property to specify client certificates. If SSLServerCertStore has a value, and SSLServerCertSubject or SSLServerCertEncoded is set, a search for a certificate is initiated. Please see the SSLServerCertSubject property for details.
Designations of certificate stores are platform dependent.
The following designations are the most common User and Machine certificate stores in Windows:
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 PFXFile, this property must be set to the name of the file. When the type is PFXBlob, 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
Byte Array
SSLServerCertStorePassword Property (GoogleDrive Component)
If the type of certificate store requires a password, this property is used to specify the password needed to open the certificate store.
Syntax
__property String SSLServerCertStorePassword = { read=FSSLServerCertStorePassword };
Default Value
""
Remarks
If the type of certificate store requires a password, this property is used to specify the password needed to open the certificate store.
This property is read-only.
Data Type
String
SSLServerCertStoreType Property (GoogleDrive Component)
This is the type of certificate store for this certificate.
Syntax
__property TcsGoogleDriveSSLServerCertStoreTypes SSLServerCertStoreType = { read=FSSLServerCertStoreType };
enum TcsGoogleDriveSSLServerCertStoreTypes { cstUser=0, cstMachine=1, cstPFXFile=2, cstPFXBlob=3, cstJKSFile=4, cstJKSBlob=5, cstPEMKeyFile=6, cstPEMKeyBlob=7, cstPublicKeyFile=8, cstPublicKeyBlob=9, cstSSHPublicKeyBlob=10, cstP7BFile=11, cstP7BBlob=12, cstSSHPublicKeyFile=13, cstPPKFile=14, cstPPKBlob=15, cstXMLFile=16, cstXMLBlob=17, cstJWKFile=18, cstJWKBlob=19, cstSecurityKey=20, cstBCFKSFile=21, cstBCFKSBlob=22, cstPKCS11=23, cstAuto=99 };
Default Value
cstUser
Remarks
This is the type of certificate store for this certificate.
The component supports both public and private keys in a variety of formats. When the cstAuto value is used, the component will automatically determine the type. This property can take one of the following values:
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, the necessary data must first be collected using the CertMgr component. The ListStoreCertificates method may be called after setting CertStoreType to cstPKCS11, CertStorePassword to the PIN, and CertStore to the full path of the PKCS#11 DLL. The certificate information returned in the CertList event's CertEncoded parameter may be saved for later use. When using a certificate, pass the previously saved security key information as the SSLServerCertStore and set SSLServerCertStorePassword to the PIN. Code Example. SSH Authentication with Security Key:
|
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
Integer
SSLServerCertSubjectAltNames Property (GoogleDrive Component)
This property contains comma-separated lists of alternative subject names for the certificate.
Syntax
__property String SSLServerCertSubjectAltNames = { read=FSSLServerCertSubjectAltNames };
Default Value
""
Remarks
This property contains comma-separated lists of alternative subject names for the certificate.
This property is read-only.
Data Type
String
SSLServerCertThumbprintMD5 Property (GoogleDrive Component)
This property contains the MD5 hash of the certificate.
Syntax
__property String SSLServerCertThumbprintMD5 = { read=FSSLServerCertThumbprintMD5 };
Default Value
""
Remarks
This property contains the MD5 hash of the certificate. It is primarily used for X.509 certificates. If the hash does not already exist, it is automatically computed.
This property is read-only.
Data Type
String
SSLServerCertThumbprintSHA1 Property (GoogleDrive Component)
This property contains the SHA-1 hash of the certificate.
Syntax
__property String SSLServerCertThumbprintSHA1 = { read=FSSLServerCertThumbprintSHA1 };
Default Value
""
Remarks
This property contains the SHA-1 hash of the certificate. It is primarily used for X.509 certificates. If the hash does not already exist, it is automatically computed.
This property is read-only.
Data Type
String
SSLServerCertThumbprintSHA256 Property (GoogleDrive Component)
This property contains the SHA-256 hash of the certificate.
Syntax
__property String SSLServerCertThumbprintSHA256 = { read=FSSLServerCertThumbprintSHA256 };
Default Value
""
Remarks
This property contains the SHA-256 hash of the certificate. It is primarily used for X.509 certificates. If the hash does not already exist, it is automatically computed.
This property is read-only.
Data Type
String
SSLServerCertUsage Property (GoogleDrive Component)
This property contains the text description of UsageFlags .
Syntax
__property String SSLServerCertUsage = { read=FSSLServerCertUsage };
Default Value
""
Remarks
This property contains the text description of SSLServerCertUsageFlags.
This value will be of one or more of the following strings and will be separated by commas:
- Digital Signature
- Non-Repudiation
- Key Encipherment
- Data Encipherment
- Key Agreement
- Certificate Signing
- CRL Signing
- Encipher Only
If the provider is OpenSSL, the value is a comma-separated list of X.509 certificate extension names.
This property is read-only.
Data Type
String
SSLServerCertUsageFlags Property (GoogleDrive Component)
This property contains the flags that show intended use for the certificate.
Syntax
__property int SSLServerCertUsageFlags = { read=FSSLServerCertUsageFlags };
Default Value
0
Remarks
This property contains the flags that show intended use for the certificate. The value of SSLServerCertUsageFlags 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 SSLServerCertUsage property for a text representation of SSLServerCertUsageFlags.
This functionality currently is not available when the provider is OpenSSL.
This property is read-only.
Data Type
Integer
SSLServerCertVersion Property (GoogleDrive Component)
This property contains the certificate's version number.
Syntax
__property String SSLServerCertVersion = { read=FSSLServerCertVersion };
Default Value
""
Remarks
This property contains the certificate's version number. The possible values are the strings "V1", "V2", and "V3".
This property is read-only.
Data Type
String
SSLServerCertSubject Property (GoogleDrive Component)
This is the subject of the certificate used for client authentication.
Syntax
__property String SSLServerCertSubject = { read=FSSLServerCertSubject };
Default Value
""
Remarks
This is the subject of the certificate used for client authentication.
This property must be set after all other certificate properties are set. When this property is set, a search is performed in the current certificate store to locate a certificate with a matching subject.
If a matching certificate is found, the property is set to the full subject of the matching certificate.
If an exact match is not found, the store is searched for subjects containing the value of the property.
If a match is still not found, the property is set to an empty string, and no certificate is selected.
The special value "*" picks a random certificate in the certificate store.
The certificate subject is a comma-separated list of distinguished name fields and values. For instance, "CN=www.server.com, OU=test, C=US, E=support@nsoftware.com". Common fields and their meanings are as follows:
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
SSLServerCertEncoded Property (GoogleDrive Component)
This is the certificate (PEM/Base64 encoded).
Syntax
__property String SSLServerCertEncoded = { read=FSSLServerCertEncoded }; __property DynamicArray<Byte> SSLServerCertEncodedB = { read=FSSLServerCertEncodedB };
Default Value
""
Remarks
This is the certificate (PEM/Base64 encoded). This property is used to assign a specific certificate. The SSLServerCertStore and SSLServerCertSubject properties also may be used to specify a certificate.
When SSLServerCertEncoded is set, a search is initiated in the current SSLServerCertStore for the private key of the certificate. If the key is found, SSLServerCertSubject is updated to reflect the full subject of the selected certificate; otherwise, SSLServerCertSubject is set to an empty string.
This property is read-only and not available at design time.
Data Type
Byte Array
StartByte Property (GoogleDrive Component)
The byte offset from which to start the upload or download.
Syntax
__property __int64 StartByte = { read=FStartByte, write=FSetStartByte };
Default Value
0
Remarks
This property may be set to resume an upload or download; it specifies the offset in the file from which to resume. See UploadFile and DownloadFile for details about resuming uploads and downloads.
This property is not available at design time.
Data Type
Long64
Timeout Property (GoogleDrive Component)
This property includes the timeout for the component.
Syntax
__property int Timeout = { read=FTimeout, write=FSetTimeout };
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 component will wait for the operation to complete before returning control.
The component will use DoEvents to enter an efficient wait loop during any potential waiting period, making sure that all system events are processed immediately as they arrive. This ensures that the host application does not freeze and remains responsive.
If Timeout expires, and the operation is not yet complete, the component raises an exception.
Note: By default, all timeouts are inactivity timeouts, that is, the timeout period is extended by Timeout seconds when any amount of data is successfully sent or received.
The default value for the Timeout property is 60 seconds.
Data Type
Integer
UseResumableUpload Property (GoogleDrive Component)
Whether to use resumable uploads.
Syntax
__property bool UseResumableUpload = { read=FUseResumableUpload, write=FSetUseResumableUpload };
Default Value
false
Remarks
This property controls whether simple or resumable uploads are used when UploadFile is called. The default value is false (simple uploads are used).
Refer to UploadFile for more information.
This property is not available at design time.
Data Type
Boolean
AddParents Method (GoogleDrive Component)
Adds folders to the list of parents for a file or folder.
Syntax
void __fastcall AddParents(String ResourceId, String ParentIds);
Remarks
This method adds one or more folders, specified by ParentIds, to the list of parents for the file or folder specified by ResourceId.
ParentIds should be specified as a comma-separated list of one or more resource Ids.
Note that resources within a shared drive must always have exactly one parent, and that only shared drive members with the "file organizer" or "organizer" roles can move files and folders within a shared drive.
AddQueryParam Method (GoogleDrive Component)
Adds a query parameter to the QueryParams properties.
Syntax
void __fastcall AddQueryParam(String Name, String Value);
Remarks
This method is used to add a query parameter to the QueryParams properties. Name specifies the name of the parameter, and Value specifies the value of the parameter.
All specified Values will be URL encoded by the component automatically. Consult the service documentation for details on the available parameters.
AddSharedDriveMember Method (GoogleDrive Component)
Creates a new shared drive member.
Syntax
String __fastcall AddSharedDriveMember(String SharedDriveId, int Role, int PermissionType, String Email);
Remarks
This is a convenience method that adds a new member to the shared drive specified by SharedDriveId by creating a permission on that shared drive. The Id of the newly-created permission is returned.
Role specifies the member's role. Valid values are:
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 UpdatePermissions for more information about how permissions work in general, how permissions relate to shared drive members, and how to manipulate multiple members at once.
string sharedDriveId = "20983euijdsds";
// First, we'll add a new member to the shared drive. The two integer parameters signify:
// * The role type. 2 is the "Writer" role, which provides read and write (but not organize) permissions.
// * The permission type. 0 means this is a single user (versus a group).
// The Id of the new permission we've created on the shared drive--which is what actually causes the user to
// be a member of the shared drive--is returned.
string permId = googledrive.AddSharedDriveMember(sharedDriveId, 2, 0, "fakeuser@example.com");
// At some point later, perhaps this user has abused their privileges and we wish to revoke their writer
// permissions. We change their role to "Commenter", which provides reader and commenting permissions.
googledrive.UpdateSharedDriveMember(sharedDriveId, permId, 1); // 1 is the "Commenter" role.
// Or perhaps we wish to simply remove the user's shared drive membership completely.
googledrive.RemoveSharedDriveMember(sharedDriveId, permId);
Authorize Method (GoogleDrive Component)
Get the authorization string required to access the protected resource.
Syntax
void __fastcall Authorize();
Remarks
This method is used to get an access token that is required to access the protected resource. The method will act differently based on what is set in the OAuthClientProfile property and the OAuthGrantType property. This method is not to be used in conjunction with the Authorization property. It should instead be used when setting the OAuth property.
For more information, see the introduction section.
CalcAuthorization Method (GoogleDrive Component)
Calculates the Authorization header based on provided credentials.
Syntax
void __fastcall CalcAuthorization();
Remarks
This method calculates the Authorization value using the values provided in AuthScheme, User and Password.
In most cases this method does not need to be called. The component will automatically calculate any required authorization values when a method is called such as Get or Post.
This method may be useful in cases where the Authorization value needs to be calculated prior to sending a request.
Config Method (GoogleDrive Component)
Sets or retrieves a configuration setting.
Syntax
String __fastcall Config(String ConfigurationString);
Remarks
Config is a generic method available in every component. It is used to set and retrieve configuration settings for the component.
These settings are similar in functionality to properties, but they are rarely used. In order to avoid "polluting" the property namespace of the component, access to these internal properties is provided through the Config method.
To set a configuration setting named PROPERTY, you must call Config("PROPERTY=VALUE"), where VALUE is the value of the setting expressed as a string. For boolean values, use the strings "True", "False", "0", "1", "Yes", or "No" (case does not matter).
To read (query) the value of a configuration setting, you must call Config("PROPERTY"). The value will be returned as a string.
CopyResource Method (GoogleDrive Component)
Copies a file.
Syntax
String __fastcall CopyResource(String ResourceId, String NewName, String ParentIds);
Remarks
This method copies the file identified by ResourceId and returns the Id of the newly created copy.
The NewName parameter defines the name of the copied file.
The ParentIds parameter should be a comma-separated list of existing folder Ids to use as parents for the copied file. If left blank, the copied file will inherit the same parents of the original.
CreateFolder Method (GoogleDrive Component)
Creates a new folder.
Syntax
String __fastcall CreateFolder(String Name, String ParentIds);
Remarks
This method creates a new folder with the specified Name and returns its Id. ParentIds can be a list of existing folder Ids to use as parents for the new folder, or empty string to create the folder at the root of the drive.
If the IncludeFolderProperties configuration setting is true when this method is called, the component will include the metadata held by the first item in the Resources properties when creating the folder. (Note that the Name and ParentIds passed to this method will take precedence.)
Google treats files and folders in the same way, and folders are included when listing resources. The ResourceType property can be used to determine if a resource is a folder, a file, or a revision of a file.
To list, delete, and update folders use the ListResources, DeleteResource, and UpdateResource methods.
CreateSharedDrive Method (GoogleDrive Component)
Creates a new shared drive.
Syntax
String __fastcall CreateSharedDrive(String Name, String RequestId);
Remarks
This method creates a new shared drive and returns the newly-created shared drive's Id.
Name is the name of the new shared drive.
RequestId is a unique value used by the server to identify an idempotent request by the current user to create a shared drive. (That is, the server ensures that duplicate shared drives are not created if any given user makes repeated shared drive creation requests with the same Name and RequestId.)
DeleteResource Method (GoogleDrive Component)
Deletes the specified file or folder permanently.
Syntax
void __fastcall DeleteResource(String ResourceId);
Remarks
This method deletes the file or folder specified by ResourceId permanently.
Files and folders are not moved to the trash, they are deleted permanently. You can use TrashResource to move files or folders to the trash.
DeleteSharedDrive Method (GoogleDrive Component)
Deletes a shared drive.
Syntax
void __fastcall DeleteSharedDrive(String SharedDriveId);
Remarks
This method deletes the shared drive specified by SharedDriveId.
Note that only members of a shared drive with the prOrganizer (5) role can delete it, and that the shared drive must be empty (or all of its items must be in the trash).
DownloadFile Method (GoogleDrive Component)
Downloads, and optionally converts, a file.
Syntax
void __fastcall DownloadFile(String ResourceId, String MimeType);
Remarks
This method downloads the file specified by ResourceId.
If LocalFile is set, the file will be saved to the specified location; otherwise, the file data will be held by ResourceData.
If the empty string is passed for MimeType, the file will be downloaded as-is. If the file is in one of the Google formats shown in the table below, one of the MIME types shown in the third column can be passed for MimeType instead to convert the file before downloading it.
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 | |
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 | |
application/pdf | ||
CSV (first sheet only) | text/csv | |
Google Drawing | JPEG | image/jpeg |
PNG | image/png | |
SVG | image/svg+xml | |
image/pdf | ||
Google Slides | MS Powerpoint | application/vnd.openxmlformats-officedocument.presentationml.presentation |
application/pdf | ||
Plain text | text/plain | |
Google App Scripts | JSON | application/vnd.google-apps.script+json |
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 component also supports resuming failed downloads by using the StartByte property. If a download is interrupted, set StartByte to the appropriate offset before calling this method to resume the download.
string downloadFile = "../MyFile.zip";
googledrive.LocalFile = downloadFile;
googledrive.DownloadFile(googledrive.Resources[0].Id, "");
//The transfer is interrupted and DownloadFile() above fails. Later, resume the download:
//Get the size of the partially downloaded file
googledrive.StartByte = new FileInfo(downloadFile).Length;
googledrive.DownloadFile(googledrive.Resources[0].Id, "");
Resuming Encrypted File Downloads
Resuming encrypted file downloads is only supported when LocalFile was set in the initial download attempt.
If LocalFile is set when beginning an encrypted download, the component creates a temporary file in TempPath to hold the encrypted data until the download is complete. If the download is interrupted, DownloadTempFile will be populated with the path of the temporary file that holds the partial data.
To resume, DownloadTempFile must be populated, along with StartByte, to allow the remainder of the encrypted data to be downloaded. Once the encrypted data is downloaded it will be decrypted and written to LocalFile.
googledrive.LocalFile = "../MyFile.zip";
googledrive.EncryptionPassword = "password";
googledrive.DownloadFile(googledrive.Resource[0].Id, "");
//The transfer is interrupted and DownloadFile() above fails. Later, resume the download:
//Get the size of the partially download temp file
googledrive.StartByte = new FileInfo(googledrive.Config("DownloadTempFile")).Length;
googledrive.DownloadFile(googledrive.Resource[0].Id, "");
EmptyTrash Method (GoogleDrive Component)
Permanently deletes all of the current user's trashed files.
Syntax
void __fastcall EmptyTrash();
Remarks
This method permanently deletes all of the current user's trashed files by emptying the trash for their "My Drive".
It is not possible to recover trashed files after this method is called!
GetAccountInfo Method (GoogleDrive Component)
Gets information about the current user's account and space usage.
Syntax
void __fastcall GetAccountInfo();
Remarks
This method gets information about the current user's account and space usage, populating the Account object property's properties.
GetCurrentChangeMarker Method (GoogleDrive Component)
Gets the most current change marker.
Syntax
void __fastcall GetCurrentChangeMarker();
Remarks
This method populates NextChangeMarker with the most current change marker available.
Refer to ListChanges for more information.
If SharedDrive is set, this method will get the most current change marker available for that shared drive's changes.
GetPermissionInfo Method (GoogleDrive Component)
Gets information about a specific permission.
Syntax
void __fastcall GetPermissionInfo(String ResourceId, String PermissionId);
Remarks
This method retrieves information about the permission specified by PermissionId on the file, folder, or shared drive specified by ResourceId.
Calling this method will fire the PermissionList event, and will populate the Permissions properties (clearing any previously-held items in the process).
Shared Drive Members
Refer to UpdatePermissions for more information about how permissions work in general, how permissions relate to shared drive members, and how to manipulate multiple members at once.GetResourceInfo Method (GoogleDrive Component)
Gets information about specific files and folders.
Syntax
void __fastcall GetResourceInfo(String ResourceIds);
Remarks
This method retrieves information about the file and folder resources specified by ResourceIds (which should be specified as a comma-separated list of resource Ids).
Calling this method will fire the ResourceList event once for each resource, and will populate the Resources properties (clearing any previously-held items in the process).
Note that, unlike the ListResources and ListChildren methods, this method uses the resource Ids to retrieve information directly. This means that it does not support paged results or complex search queries (the "q" query parameter), does not need to know whether the resources are in shared drives, etc.
GetSharedDriveInfo Method (GoogleDrive Component)
Gets information about a specific shared drive.
Syntax
void __fastcall GetSharedDriveInfo(String SharedDriveId);
Remarks
This method retrieves information about the shared drive specified by SharedDriveId.
Calling this method will fire the SharedDriveList event, and will populate the SharedDrives properties (clearing any previously-held items in the process).
GetUploadStatus Method (GoogleDrive Component)
Gets the status of a resumable upload session.
Syntax
void __fastcall GetUploadStatus();
Remarks
This method gets the status of a resumable upload session. Set ResumeURL before calling this method. After calling this method StartByte will be populated.
Interrupt Method (GoogleDrive Component)
This method interrupts the current method.
Syntax
void __fastcall Interrupt();
Remarks
If there is no method in progress, Interrupt simply returns, doing nothing.
ListChanges Method (GoogleDrive Component)
Lists changes to resources and shared drives.
Syntax
void __fastcall ListChanges();
Remarks
This method lists changes to resources and shared drives.
General Usage
When this method is called, it will use the change marker stored in either ChangeMarker or NextChangeMarker (only one can be populated at a time) to request the next page of changes. This method causes the ChangeList event to fire once for each change, and will also populate the Changes properties.If there are still more changes available to list when this method returns, the ChangeMarker property will be populated. Continue to call this method until ChangeMarker is empty to accumulate all pages of results in the Changes properties. (Once there aren't any more changes available to list, the NextChangeMarker property will be populated instead.)
Calling GetCurrentChangeMarker will immediately populate NextChangeMarker. Regardless of whether it is populated because of a call to GetCurrentChangeMarker or to ListChanges, NextChangeMarker is always populated with a value that (at the time of population) points to the most current state. (Since "the most current state" implies that there are no further changes to list, calling ListChanges immediately after NextChangeMarker is populated will not return any further changes.)
Setting ChangeMarker to "1" will cause ListChanges to list changes beginning with the very first change available.
Example of Listing Changes
// Start listing changes from the beginning, and list a maximum of 10 changes at a time.
googledrive.ChangeMarker = "1";
googledrive.Config("MaxResults=10");
// List changes once.
googledrive.ListChanges();
do {
for (int i = 0; i < googledrive.Changes.Count; i++) {
Console.WriteLine(googledrive.Changes[i].ResourceId);
Console.WriteLine(googledrive.Changes[i].Time);
Console.WriteLine(googledrive.Changes[i].Removed);
}
// Continue to call ListChanges() until ChangeMarker is the empty string (indicating there
// are no more changes to list).
googledrive.ListChanges();
} while (googledrive.ChangeMarker.Length > 0);
// Now NextChangeMarker will be populated. If we were to call ListChanges() again right now,
// nothing would be listed and NextChangeMarker would still be populated.
// Wait 2 minutes and then try to list changes again.
Thread.Sleep(120000);
googledrive.ListChanges();
do {
for (int i = 0; i < googledrive.Changes.Count; i++) {
Console.WriteLine(googledrive.Changes[i].ResourceId);
Console.WriteLine(googledrive.Changes[i].Time);
Console.WriteLine(googledrive.Changes[i].Removed);
}
googledrive.ListChanges();
} while (googledrive.ChangeMarker.Length > 0);
Shared Drive Functionality
When working in the context of shared drives, there are additional properties that can be configured to specify what kinds of changes should returned.If SharedDrive is empty string, then changes for items in shared drives that the user has accessed will be included (in addition to the usual changes for the user's items). Changes to the shared drives themselves which the user is a member of will also be included.
If SharedDrive is populated with a shared drive resource Id, then only changes to items within that shared drive, as well as changes to that shared drive itself, will be returned.
A change's ChangeType will reflect whether it is associated with a file or folder (0), or a shared drive itself (1).
ListChildren Method (GoogleDrive Component)
Lists the child resources of one or more folders.
Syntax
void __fastcall ListChildren(String FolderIds);
Remarks
This is a convenience method that works the same way as ListResources, but limits the results to children of one or more folders specified by FolderIds (which should be specified as a comma-separated list of folder resource Ids).
Calling this method will fire the ResourceList event once for each resource, and will also populate the Children properties.
If there are still more child resources available to list when this method returns, the ChildMarker property will be populated. Continue to call this method until ChildMarker is empty to accumulate all pages of results in the Children properties.
Note that the string "root" may be used as a folder Id to represent the root folder of a drive.
Refer to ListResources for more information about how listing resources works in general, everything there applies to this method too.
// ResourceList event handler.
googledrive.OnResourceList += (s, e) => {
Console.WriteLine(e.Name);
};
// List all of the children of the given folder resource.
do {
googledrive.ListChildren("12978eyuihusd");
for (int i = 0; i < googledrive.Children.Count; i++) {
// Process child resources here.
}
} while (!string.IsNullOrEmpty(googledrive.ChildMarker));
ListParents Method (GoogleDrive Component)
Lists the parent folders of a file or folder.
Syntax
void __fastcall ListParents(String ResourceId);
Remarks
This is a convenience method that simply retrieves the parent Ids of the file or folder specified by ResourceId and passes them to GetResourceInfo.
Refer to GetResourceInfo for more information.
ListPermissions Method (GoogleDrive Component)
Lists the permissions for a file, folder, or shared drive.
Syntax
void __fastcall ListPermissions(String ResourceId);
Remarks
This method is used to list permissions for the file, folder, or shared drive specified by ResourceId.
Calling this method will fire the PermissionList event once for each permission, and will also populate the Permissions properties.
If there are still more permissions available to list when this method returns, the PermissionMarker property will be populated. Continue to call this method until PermissionMarker is empty to accumulate all pages of results in the Permissions properties.
// PermissionList event handler.
googledrive.OnPermissionList += (s, e) => {
Console.WriteLine("Permission Id: " + e.Id);
};
// List all of the permissions on the given resource.
do {
googledrive.ListPermissions("fdjhskdf89o3wi");
for (int i = 0; i < googledrive.Permissions.Count; i++) {
// Process permissions here.
}
} while (!string.IsNullOrEmpty(googledrive.PermissionMarker));
Shared Drive Members
Refer to UpdatePermissions for more information about how permissions work in general, how permissions relate to shared drive members, and how to manipulate multiple members at once.
Shared Drive Capabilities
To determine the effective capabilities the current user has for shared drives that they're a member of, call ListSharedDrives instead and inspect the SharedDriveCapabilities property of the returned items.ListResources Method (GoogleDrive Component)
Lists files and folders.
Syntax
void __fastcall ListResources();
Remarks
This method is used to list file and folders. Calling this method will fire the ResourceList event once for each resource, and will also populate the Resources properties.
If there are still more resources available to list when this method returns, the ResourceMarker property will be populated. Continue to call this method until ResourceMarker is empty to accumulate all pages of results in the Resources properties.
Listing Resources
By default, all files and folders in the scope specified by the ListResourcesScope property will be returned. The ListResourcesMode configuration setting can be used to specify that only files or only folders should be returned. Refer to the "Result Scopes" section, below, for more information about what the results for each scope are comprised of.To simply list the children or parents of specific resources, use ListChildren or ListParents. To retrieve information about specific resources, use GetResourceInfo.
For more complex queries, refer to the Google Drive API documentation for information on how to construct a search query, then use the AddQueryParam method to add a query parameter named "q" to the QueryParams properties before calling this method.
Result Scopes
There are a number of different search scopes which the results of this method can be drawn from, some of which are exclusive to shared drives.When ListResources is called with ListResourcesScope set to the default of lrsUser (0), the results will consist of items that are in the current user's "My Drive" and "Shared with me" spaces.
If ListResourcesScope is set to lrsDomain (1), the results will instead consist of items which have been shared to the current user's domain, whether or not the user has actually accessed them.
(To clarify, items shared to a user's domain are only added to their "Shared with me" space once the user accesses them for the first time. So, items shared to a user's domain that they have not actually accessed before would not show up when ListResourcesScope is set to lrsUser (0), but would show up when it is set to lrsDomain (1).)
When ListResourcesScope is set to lrsSharedDrive (2), the SharedDrive property must be set to the resource Id of a shared drive, and the results of this method will consist only of items within that shared drive.
When ListResourcesScope is set to lrsAllDrives (3), the results will consist of anything in the user's "My Drive" and "Shared with me" spaces, and all items in all shared drives which the user is a member of.
Note: Under some circumstances, if a user is a member of many shared drives, using the lrsAllDrives (3) will not yield a complete set of results (even with paged results). This is a direct limitation of the Google Drive API, and the only solution is to use a narrower scope. When using the lrsAllDrives (3) scope, you should check the SearchIncomplete configuration setting after calling ListResources; it will return "True" if the result set is incomplete.
How Shared Drives Work
Shared drives are, more than anything else, very similar to a normal user account. Once this is understood, it becomes much easier to understand how shared drives fit into the overall Google Drive architecture.Just like a real user, a shared drive itself owns the files in its storage space (this is why the permissions for members of a shared drive use the "file organizer" and "organizer" roles instead of the "owner" role). Also like a real user, a shared drive's files can be explicitly shared with other users (even if they aren't members of the shared drive), and with the overall domain.
The difference, of course, is that a shared drive has a defined set of members, all of which have access to everything in the shared drive (though with varying capabilities). Refer to UpdatePermissions, AddSharedDriveMember, UpdateSharedDriveMember, and RemoveSharedDriveMember for more information.
// ResourceList event handler.
googledrive.OnResourceList += (s, e) => {
Console.WriteLine(e.Name);
};
// List all of the current user's resources.
googledrive.ListResourcesScope = GoogledriveListResourcesScopes.lrsUser;
do {
googledrive.ListResources();
for (int i = 0; i < googledrive.Resources.Count; i++) {
// Process resources here.
}
} while (!string.IsNullOrEmpty(googledrive.ResourceMarker));
// List all of the resources in the specified shared drive.
googledrive.SharedDrive = "wfsr789vusijfv";
googledrive.ListResourcesScope = GoogledriveListResourcesScopes.lrsSharedDrive;
do {
googledrive.ListResources();
for (int i = 0; i < googledrive.Resources.Count; i++) {
// Process resources here.
}
} while (!string.IsNullOrEmpty(googledrive.ResourceMarker));
ListRevisions Method (GoogleDrive Component)
List the revisions of a file.
Syntax
void __fastcall ListRevisions(String FileId);
Remarks
This method will list the revisions of the specified file. Calling this method will fire the ResourceList event once for each revision, and will also populate the Resources properties. The Revision ID will be help in the ResourceId property.
If the Revision ID is set to the RevisionId configuration setting, the following methods can be used to interact with the specific revision:
After these methods are no longer needed, it is recommended to clear to the RevisionId configuration setting to avoid unattended changes to functionality.
ListSharedDrives Method (GoogleDrive Component)
Lists shared drives that the current user is a member of.
Syntax
void __fastcall ListSharedDrives();
Remarks
This method lists the shared drives which the current user is a member of.
Calling this method will fire the SharedDriveList event once for each shared drive, and will also populate the SharedDrives properties.
If there are still more shared drives available to list when this method returns, the SharedDriveMarker property will be populated. Continue to call this method until SharedDriveMarker is empty to accumulate all pages of results in the SharedDrives properties.
// SharedDriveList event handler.
googledrive.OnSharedDriveList += (s, e) => {
Console.WriteLine(e.Name);
};
// List all shared drives the current user is a member of.
do {
googledrive.ListSharedDrives();
for (int i = 0; i < googledrive.SharedDrives.Count; i++) {
// Process shared drives here.
}
} while (!string.IsNullOrEmpty(googledrive.SharedDriveMarker));
MoveResource Method (GoogleDrive Component)
Moves a file or folder.
Syntax
void __fastcall MoveResource(String ResourceId, String NewParentIds);
Remarks
This method "moves" an existing file or folder specified by ResourceId to the folders specified by NewParentIds (which should be specified as a comma-separated list of folder resource Ids).
After this method returns, the folders specified by NewParentIds will be the only parents of in the resource's parent list. If you wish to add additional parents for the resource without removing its existing parents, use AddParents instead.
Note that resources within a shared drive must always have exactly one parent, and that only shared drive members with the "file organizer" or "organizer" roles can move files and folders within a shared drive.
RemoveParents Method (GoogleDrive Component)
Removes folders from the list of parents for a file or folder.
Syntax
void __fastcall RemoveParents(String ResourceId, String ParentIds);
Remarks
This method removes one or more folders, specified by ParentIds, from the list of parents for the file or folder specified by ResourceId.
ParentIds should be specified as a comma-separated list of one or more resource Ids.
Note that resources within a shared drive must always have exactly one parent, and that only shared drive members with the "file organizer" or "organizer" roles can move files and folders within a shared drive.
RemoveSharedDriveMember Method (GoogleDrive Component)
Removes an existing shared drive member.
Syntax
void __fastcall RemoveSharedDriveMember(String SharedDriveId, String PermissionId);
Remarks
This is a convenience method that removes an existing member of a shared drive (specified by SharedDriveId) by deleting their associated permission (specified by PermissionId).
Refer to UpdatePermissions for more information about how permissions work in general, how permissions relate to shared drive members, and how to manipulate multiple members at once.
string sharedDriveId = "20983euijdsds";
// First, we'll add a new member to the shared drive. The two integer parameters signify:
// * The role type. 2 is the "Writer" role, which provides read and write (but not organize) permissions.
// * The permission type. 0 means this is a single user (versus a group).
// The Id of the new permission we've created on the shared drive--which is what actually causes the user to
// be a member of the shared drive--is returned.
string permId = googledrive.AddSharedDriveMember(sharedDriveId, 2, 0, "fakeuser@example.com");
// At some point later, perhaps this user has abused their privileges and we wish to revoke their writer
// permissions. We change their role to "Commenter", which provides reader and commenting permissions.
googledrive.UpdateSharedDriveMember(sharedDriveId, permId, 1); // 1 is the "Commenter" role.
// Or perhaps we wish to simply remove the user's shared drive membership completely.
googledrive.RemoveSharedDriveMember(sharedDriveId, permId);
Reset Method (GoogleDrive Component)
Resets the component to its initial state.
Syntax
void __fastcall Reset();
Remarks
This method resets the component to its initial state.
RestoreResource Method (GoogleDrive Component)
Restores a file or folder from the trash.
Syntax
void __fastcall RestoreResource(String ResourceId);
Remarks
This method restores the file or folder specified by ResourceId from the trash.
SendCustomRequest Method (GoogleDrive Component)
Sends a custom request to the Google Drive API.
Syntax
void __fastcall SendCustomRequest(String HttpMethod, String RequestPath, String RequestBody);
Remarks
This method can be used to send arbitrary requests to the Google Drive API.
Valid values for HttpMethod are:
- GET (default if empty)
- HEAD
- POST
- PUT
- PATCH
- DELETE
The value passed for RequestPath must already be URL-encoded in a manner acceptable to the Google Drive API. The RequestBody parameter may be empty if not needed.
Usage
When this method is called, the component does the following:
- Builds a request URL, including query parameters, as follows:
- The specified RequestPath is appended to the Google Drive API endpoint, https://www.googleapis.com/drive/v3.
- All query parameters in the QueryParams properties are added to the request URL.
- Sends the request using the specified HttpMethod, the request URL build in step 1, the header information held by Authorization and OtherHeaders, and the given RequestBody (if non-empty).
- Stores the response headers in the ParsedHeaders properties, and the response body in the specified LocalFile, or ResourceData (using the same logic as DownloadFile).
If the response body is JSON data, the XPath, XText, and other X* configuration settings can then be used to navigate and extract information from it.
ToggleSharedDriveHidden Method (GoogleDrive Component)
Hides or unhides a shared drive.
Syntax
void __fastcall ToggleSharedDriveHidden(String SharedDriveId, bool Hidden);
Remarks
This method hides or unhides the shared drive specified by SharedDriveId.
If a shared drive is hidden, it will not show up in the Google Drive UI by default (but is still otherwise accessible). Google Drive tracks this setting separately for each user; i.e., each member of a shared drive can choose whether the shared drive should be hidden or not.
TrashResource Method (GoogleDrive Component)
Moves the specified file or folder to the trash.
Syntax
void __fastcall TrashResource(String ResourceId);
Remarks
This method moves the file or folder specified by ResourceId to the trash. The resource may be restored from the trash by calling RestoreResource.
To permanently delete a resource, call DeleteResource. To empty the trash (thus permanently deleting all trashed items), call EmptyTrash.
UpdatePermissions Method (GoogleDrive Component)
Create, update, and delete permissions on a file, folder, or shared drive.
Syntax
void __fastcall UpdatePermissions(String ResourceId);
Remarks
This method is used to create, update, and delete permissions for the file, folder, or shared drive specified by ResourceId.
Each item in the Permissions properties has a PermissionModOp property which can be set to one of the following values:
moNone (0) (default) | No-Op (the component 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 component will iterate through the Permissions properties and execute the requested operation for each permission.
For each permission operation which completes successfully, the component will change its PermissionModOp property back to moNone (0).
Important: The component executes permission operations one-by-one due to how the Google Drive API works. If the component encounters an issue during one of the operations, it will fail with an error, and won't attempt to execute any remaining permission items' operations. The error message will indicate the index of the permission item which caused the error.
Usage
ListPermissions must be called before using this method in order to populate the Permissions properties with a resource's existing permissions. (When creating new permissions, calling ListPermissions first is optional, but still recommended to ensure that the component reflects the latest information.)To create new permissions, add new items to the Permissions properties by incrementing the PermissionCount property as necessary.
For each permission being created or updated, set its properties to the desired values. The PermissionModOp property should be set to a value other than moNone (0) for any permission that should be created, updated, or deleted.
Once the permission items have been set up as desired, call this method.
// For simplicity's sake, assume that this file currently has no permissions on it.
string fileId = "awd0s79uocijl23wf";
// Add permissions for a couple of users to the file.
googledrive.Permissions.Add(new GDrivePermission() {
Email = "fakeuser1@example.com",
Role = GDrivePermissionRoles.prReader,
ModOp = GDrivePermissionModOps.moCreate
});
googledrive.Permissions.Add(new GDrivePermission() {
Email = "fakeuser2@example.com",
Role = GDrivePermissionRoles.prWriter,
ModOp = GDrivePermissionModOps.moCreate
});
googledrive.UpdatePermissions(fileId);
// Now we'll update the permissions on the file, removing one of the users and
// changing the other's role to "Commenter". Always list the permissions first
// to ensure that the latest data is loaded into the component.
googledrive.ListPermissions(fileId);
googledrive.Permissions[0].ModOp = GDrivePermissionModOps.moDelete;
googledrive.Permissions[1].Role = GDrivePermissionRoles.prCommenter;
googledrive.Permissions[1].ModOp = GDrivePermissionModOps.moUpdate;
// Now commit the changes.
googledrive.UpdatePermissions(fileId);
Transferring Ownership
When creating or updating a permission with the prOwner (3) role on a file or folder, the old owner will have their role downgraded to prWriter (2). The TransferOwnership configuration setting must be set to "True" before calling UpdatePermissions to acknowledge this side effect.Note that this does not apply to shared drives themselves, or resources in shared drives. It also does not apply when moving resources into or out of shared drives.
Shared Drive Permissions
The permissions on a shared drive itself determine what users are members of the shared drive, and what capabilities they have within the shared drive. Said another way, creating, updating, and deleting the permissions on a shared drive will create, update the capabilities of, and delete shared drive memberships.Since members are determined by the permissions on a shared drive, this method can of course be used to manipulate one or more shared drive members at once. For simpler use cases which only need to modify one member at a time, the AddSharedDriveMember, UpdateSharedDriveMember, and RemoveSharedDriveMember convenience methods can be used.
Note: Only the ptUser (0) and ptGroup (1) permission types are valid for permissions on a shared drive itself.
Just like in a regular user's drive, permissions can also be applied to files within a shared drive to explicitly share them with specific users (whether they're members of the shared drive or not).
UpdateResource Method (GoogleDrive Component)
Updates a file or folder.
Syntax
void __fastcall UpdateResource(String ResourceId);
Remarks
This method updates the metadata for the file or folder resource identified by ResourceId. For file resources, the file data can optionally be updated as well.
Usage
There must be a GDriveResource properties whose ResourceId property matches the specified ResourceId value before this method is called.- If necessary, call GetResourceInfo or ListResources to ensure an item with the resource's latest information is present in the Resources properties.
- Modify the item's Resource* properties as desired; the following properties are supported:
- ResourceContentAccessible
- ResourceDescription
- ResourceMIMEType (only updated for files, if not empty and new file data is uploaded)
- ResourceModifiedTime (only updated if not empty)
- ResourceName
- ResourceStarred
- ResourceTrashed
- For file resources, you may set LocalFile or ResourceData if you wish to update the file data on the server. (Refer to UploadFile for more information about simple vs. resumable uploads and encrypting the file data before uploading.)
- Finally, call this method to update the resource.
// Load the latest information about the resource into the Resources collection.
string resId = "2309urjdojwefs0d09u";
googledrive.GetResourceInfo(resId);
// We'll update the file resource's name, description, and content.
googledrive.ResourceData = "new file content";
googledrive.Resources[0].Name = "CoolStuff2.txt";
googledrive.Resources[0].Description = "This is a text file with cool stuff in it";
googledrive.UpdateResource(resId);
UpdateSharedDrive Method (GoogleDrive Component)
Updates a shared drive.
Syntax
void __fastcall UpdateSharedDrive(String SharedDriveId, String NewName, int SetRestrictions, int UnsetRestrictions);
Remarks
This method updates the name of and/or restrictions applied to the shared drive specified by SharedDriveId.
If the current user is allowed to rename the shared drive (i.e., if the SharedDriveCapabilities property has the 0x08000 flag set), then a new name can be provided using the NewName parameter. If the user is not allowed to rename the shared drive, or wishes to preserve its current name, pass empty string for NewName.
Similarly, if the current user is allowed to alter one or more of the shared drive's SharedDriveRestrictions (i.e., if the SharedDriveCapabilities property has the 0x00002, 0x00004, and/or 0x00010 flags set), then the desired restrictions can be set or unset by including their associated flags, listed below, in the values passed for the SetRestrictions and UnsetRestrictions parameters.
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.
UpdateSharedDriveMember Method (GoogleDrive Component)
Updates an existing shared drive member's role.
Syntax
void __fastcall UpdateSharedDriveMember(String SharedDriveId, String PermissionId, int Role);
Remarks
This is a convenience method that updates the role of an existing member of a shared drive (specified by SharedDriveId) by modifying their associated permission (specified by PermissionId).
Role specifies the member's role. Valid values are:
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 UpdatePermissions for more information about how permissions work in general, how permissions relate to shared drive members, and how to manipulate multiple members at once.
string sharedDriveId = "20983euijdsds";
// First, we'll add a new member to the shared drive. The two integer parameters signify:
// * The role type. 2 is the "Writer" role, which provides read and write (but not organize) permissions.
// * The permission type. 0 means this is a single user (versus a group).
// The Id of the new permission we've created on the shared drive--which is what actually causes the user to
// be a member of the shared drive--is returned.
string permId = googledrive.AddSharedDriveMember(sharedDriveId, 2, 0, "fakeuser@example.com");
// At some point later, perhaps this user has abused their privileges and we wish to revoke their writer
// permissions. We change their role to "Commenter", which provides reader and commenting permissions.
googledrive.UpdateSharedDriveMember(sharedDriveId, permId, 1); // 1 is the "Commenter" role.
// Or perhaps we wish to simply remove the user's shared drive membership completely.
googledrive.RemoveSharedDriveMember(sharedDriveId, permId);
UploadFile Method (GoogleDrive Component)
Uploads, and optionally converts, a new file.
Syntax
String __fastcall UploadFile(String FileName, String MimeType);
Remarks
This method uploads a new file and returns the Id of the newly-created file resource.
If LocalFile is set the file will be uploaded from the specified path. If LocalFile is not set the data in ResourceData will be used.
Usage
The name specified by the FileName parameter should include a file extension.If MimeType is "", the file will be uploaded as-is and its MIME type will be automatically determined. The file can be converted to one of the Google formats by explicitly setting MimeType to one of the MIME types in the table below.
Before calling this method, always set ResourceCount to 0 to clear the stored resource data. Then, if you wish to set file metadata and/or assign parent Ids when the file is uploaded, set ResourceCount to 1 and set the desired properties. (Note that the name and MIME type passed to this method will take precedence.)
To encrypt the file before uploading it, set EncryptionAlgorithm and EncryptionPassword.
Finally, call this method to upload the file, along with any metadata that may be set.
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 component uses the simple upload mechanism.
googledrive.LocalFile = "../MyFile.zip";
googledrive.UploadFile("MyFile.zip", "");
Resumable
To enable resumable uploads set UseResumableUpload to true. This is recommended for large files. The component will automatically fragment the specified file into smaller pieces and upload each individually. FragmentSize may be set to specify the size of the fragment if desired. The default fragment size is 10 MB.
When UseResumableUpload is set to true and UploadFile is called, a resumable upload session is started by the component. ResumeURL is populated with a URL identifying the session (this value may be needed for additional operations if the upload does not complete normally).
During a resumable upload, the FragmentComplete event fires after each fragment is uploaded to indicate overall progress. The component also updates StartByte as necessary to indicate the current offset in the file.
If the upload is interrupted for any reason, resuming it is easy. First, verify that ResumeURL and StartByte are populated (if the same instance of the component is used, they should already be populated, and no special action should be needed). Then call UploadFile again to resume the upload at the specified StartByte offset.
Note that if the upload is not resumed after some time the upload session will expire. GetUploadStatus may be used to check the status of a resumable upload.
googledrive.LocalFile = "../MyFile.zip";
googledrive.UploadFile("MyFile.zip", "");
//The transfer is interrupted and UploadFile() above fails. Later, resume the download.
//Using the same instance StartByte and ResumeURL are already populated from the previous
//upload attempt.
googledrive.UploadFile("MyFile.zip", "");
ChangeList Event (GoogleDrive Component)
Fires once for each change when ListChanges is called.
Syntax
typedef struct { String ResourceId; String SharedDriveId; bool Removed; String Time; int ChangeType; } TcsGoogleDriveChangeListEventParams; typedef void __fastcall (__closure *TcsGoogleDriveChangeListEvent)(System::TObject* Sender, TcsGoogleDriveChangeListEventParams *e); __property TcsGoogleDriveChangeListEvent OnChangeList = { read=FOnChangeList, write=FOnChangeList };
Remarks
This event fires once for each change returned when ListChanges is called.
ResourceId is the Id of the file or folder to which the change applies.
SharedDriveId is the Id of the shared drive associated with the change.
Removed indicates whether the file or shared drive has been removed from the view of the change list. For example, if a file was permanently deleted or access to it was revoked, this would return 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 ListChanges for more information.
EndTransfer Event (GoogleDrive Component)
This event fires when a document finishes transferring.
Syntax
typedef struct { int Direction; } TcsGoogleDriveEndTransferEventParams; typedef void __fastcall (__closure *TcsGoogleDriveEndTransferEvent)(System::TObject* Sender, TcsGoogleDriveEndTransferEventParams *e); __property TcsGoogleDriveEndTransferEvent OnEndTransfer = { read=FOnEndTransfer, write=FOnEndTransfer };
Remarks
The EndTransfer event is fired when the document text finishes transferring from the server to the local host.
The Direction parameter shows whether the client (0) or the server (1) is sending the data.
Error Event (GoogleDrive Component)
Fired when information is available about errors during data delivery.
Syntax
typedef struct { int ErrorCode; String Description; } TcsGoogleDriveErrorEventParams; typedef void __fastcall (__closure *TcsGoogleDriveErrorEvent)(System::TObject* Sender, TcsGoogleDriveErrorEventParams *e); __property TcsGoogleDriveErrorEvent OnError = { read=FOnError, write=FOnError };
Remarks
The Error event is fired in case of exceptional conditions during message processing. Normally the component raises an exception.
The ErrorCode parameter contains an error code, and the Description parameter contains a textual description of the error. For a list of valid error codes and their descriptions, please refer to the Error Codes section.
FragmentComplete Event (GoogleDrive Component)
Fires after each fragment of a resumable upload is completed.
Syntax
typedef struct { int FragmentNumber; int FragmentCount; bool Interrupt; } TcsGoogleDriveFragmentCompleteEventParams; typedef void __fastcall (__closure *TcsGoogleDriveFragmentCompleteEvent)(System::TObject* Sender, TcsGoogleDriveFragmentCompleteEventParams *e); __property TcsGoogleDriveFragmentCompleteEvent OnFragmentComplete = { read=FOnFragmentComplete, write=FOnFragmentComplete };
Remarks
When UseResumableUpload is true and UploadFile is called, this event will fire after each fragment is uploaded, providing an indication of overall upload progress.
FragmentNumber is the number of the current fragment that has completed. This value starts at 1.
FragmentCount is the total number of fragments that will be uploaded.
Interrupt can be set to true to interrupt the upload. The upload may be resumed later.
Header Event (GoogleDrive Component)
This event is fired every time a header line comes in.
Syntax
typedef struct { String Field; String Value; } TcsGoogleDriveHeaderEventParams; typedef void __fastcall (__closure *TcsGoogleDriveHeaderEvent)(System::TObject* Sender, TcsGoogleDriveHeaderEventParams *e); __property TcsGoogleDriveHeaderEvent OnHeader = { read=FOnHeader, write=FOnHeader };
Remarks
The Field parameter contains the name of the HTTP header (which is the same as it is delivered). The Value parameter contains the header contents.
If the header line being retrieved is a continuation header line, then the Field parameter contains "" (empty string).
Log Event (GoogleDrive Component)
This event fires once for each log message.
Syntax
typedef struct { int LogLevel; String Message; String LogType; } TcsGoogleDriveLogEventParams; typedef void __fastcall (__closure *TcsGoogleDriveLogEvent)(System::TObject* Sender, TcsGoogleDriveLogEventParams *e); __property TcsGoogleDriveLogEvent OnLog = { read=FOnLog, write=FOnLog };
Remarks
This event fires once for each log message generated by the component. The verbosity is controlled by the LogLevel setting.
LogLevel 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.
LogType identifies the type of log entry. Possible values are as follows:
- "Info"
- "RequestHeaders"
- "ResponseHeaders"
- "RequestBody"
- "ResponseBody"
- "ProxyRequest"
- "ProxyResponse"
- "FirewallRequest"
- "FirewallResponse"
PermissionList Event (GoogleDrive Component)
This event fires once for each permission returned when listing permissions.
Syntax
typedef struct { String Id; int Role; int PermissionType; String Email; String Domain; bool AllowFileDiscovery; } TcsGoogleDrivePermissionListEventParams; typedef void __fastcall (__closure *TcsGoogleDrivePermissionListEvent)(System::TObject* Sender, TcsGoogleDrivePermissionListEventParams *e); __property TcsGoogleDrivePermissionListEvent OnPermissionList = { read=FOnPermissionList, write=FOnPermissionList };
Remarks
When calling ListPermissions this event will fire once for each permission that is returned.
Id is the Id of the permission.
Role is the role of the permission. Possible values are:
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.
Progress Event (GoogleDrive Component)
Fires during an upload or download to indicate transfer progress.
Syntax
typedef struct { int Direction; __int64 BytesTransferred; __int64 TotalBytes; int PercentDone; } TcsGoogleDriveProgressEventParams; typedef void __fastcall (__closure *TcsGoogleDriveProgressEvent)(System::TObject* Sender, TcsGoogleDriveProgressEventParams *e); __property TcsGoogleDriveProgressEvent OnProgress = { read=FOnProgress, write=FOnProgress };
Remarks
This event fires during an upload or download to indicate the progress of the transfer of the entire request. By default, this event will fire each time PercentDone increases by one percent; the ProgressStep configuration setting can be used to alter this behavior.
Direction indicates whether the transfer is an upload (0) or a download (1).
BytesTransferred reflects the number of bytes that have been transferred so far, or 0 if the transfer is starting (however, see note below).
TotalBytes reflects the total number of bytes that are to be transferred, or -1 if the total is unknown. This amount includes the size of everything in the request like HTTP headers.
PercentDone reflects the overall progress of the transfer, or -1 if the progress cannot be calculated.
Note: By default, the component tracks transfer progress absolutely. If a transfer is interrupted and later resumed, the values reported by this event upon and after resumption will account for the data that was transferred before the interruption.
For example, if 10MB of data was successfully transferred before the interruption, then this event will fire with a BytesTransferred value of 10485760 (10MB) when the transfer is first resumed, and then continue to fire with successively greater values as usual.
This behavior can be changed by disabling the ProgressAbsolute configuration setting, in which case the component will treat resumed transfers as "new" transfers. In this case, the BytesTransferred parameter will always be 0 the first time this event fires, regardless of whether the transfer is new or being resumed.
ResourceList Event (GoogleDrive Component)
Fires once for each resource returned when listing resources.
Syntax
typedef struct { String Id; String Name; String Extension; String Description; int ResourceType; String SharedDriveId; String CreatedTime; String ModifiedTime; __int64 Size; bool Trashed; } TcsGoogleDriveResourceListEventParams; typedef void __fastcall (__closure *TcsGoogleDriveResourceListEvent)(System::TObject* Sender, TcsGoogleDriveResourceListEventParams *e); __property TcsGoogleDriveResourceListEvent OnResourceList = { read=FOnResourceList, write=FOnResourceList };
Remarks
This event fires once for each resource returned when ListResources, ListChildren, ListParents, or GetResourceInfo is called.
Id is the Id of the resource.
Name holds the resource's name.
Extension is the file extension.
Description holds a short description of the resource (if any).
ResourceType indicates whether the resource is a file or folder. Possible values are:
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.
SharedDriveList Event (GoogleDrive Component)
Fires once for each shared drive returned when listing shared drives.
Syntax
typedef struct { String Id; String Name; String CreatedTime; bool Hidden; int Capabilities; int Restrictions; } TcsGoogleDriveSharedDriveListEventParams; typedef void __fastcall (__closure *TcsGoogleDriveSharedDriveListEvent)(System::TObject* Sender, TcsGoogleDriveSharedDriveListEventParams *e); __property TcsGoogleDriveSharedDriveListEvent OnSharedDriveList = { read=FOnSharedDriveList, write=FOnSharedDriveList };
Remarks
This event fires once for each shared drive returned when ListSharedDrives is called.
Id is the Id of the shared drive.
Name holds the shared drive's name.
CreatedTime holds a DateTime string representing the creation date of the resource. This is a combined date-time value (formatted according to RFC 3339).
Hidden indicates whether the shared drive is hidden from default view (i.e., whether it is shown by default in the Google Drive UI).
Capabilities describes the effective capabilities that the current user has for the shared drive. The value is a bit field comprised of one or more of the following, OR'ed together:
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. |
SSLServerAuthentication Event (GoogleDrive Component)
Fired after the server presents its certificate to the client.
Syntax
typedef struct { String CertEncoded; DynamicArray<Byte> CertEncodedB; String CertSubject; String CertIssuer; String Status; bool Accept; } TcsGoogleDriveSSLServerAuthenticationEventParams; typedef void __fastcall (__closure *TcsGoogleDriveSSLServerAuthenticationEvent)(System::TObject* Sender, TcsGoogleDriveSSLServerAuthenticationEventParams *e); __property TcsGoogleDriveSSLServerAuthenticationEvent OnSSLServerAuthentication = { read=FOnSSLServerAuthentication, write=FOnSSLServerAuthentication };
Remarks
During this event, the client can decide whether or not to continue with the connection process. The Accept parameter is a recommendation on whether to continue or close the connection. This is just a suggestion: application software must use its own logic to determine whether or not to continue.
When Accept is False, Status shows why the verification failed (otherwise, Status contains the string OK). If it is decided to continue, you can override and accept the certificate by setting the Accept parameter to True.
SSLStatus Event (GoogleDrive Component)
Fired when secure connection progress messages are available.
Syntax
typedef struct { String Message; } TcsGoogleDriveSSLStatusEventParams; typedef void __fastcall (__closure *TcsGoogleDriveSSLStatusEvent)(System::TObject* Sender, TcsGoogleDriveSSLStatusEventParams *e); __property TcsGoogleDriveSSLStatusEvent OnSSLStatus = { read=FOnSSLStatus, write=FOnSSLStatus };
Remarks
The event is fired for informational and logging purposes only. This event tracks the progress of the connection.
StartTransfer Event (GoogleDrive Component)
This event fires when a document starts transferring (after the headers).
Syntax
typedef struct { int Direction; } TcsGoogleDriveStartTransferEventParams; typedef void __fastcall (__closure *TcsGoogleDriveStartTransferEvent)(System::TObject* Sender, TcsGoogleDriveStartTransferEventParams *e); __property TcsGoogleDriveStartTransferEvent OnStartTransfer = { read=FOnStartTransfer, write=FOnStartTransfer };
Remarks
The StartTransfer event is fired when the document text starts transferring from the server to the local host.
The Direction parameter shows whether the client (0) or the server (1) is sending the data.
Transfer Event (GoogleDrive Component)
This event is fired while a document transfers (delivers document).
Syntax
typedef struct { int Direction; __int64 BytesTransferred; int PercentDone; String Text; DynamicArray<Byte> TextB; } TcsGoogleDriveTransferEventParams; typedef void __fastcall (__closure *TcsGoogleDriveTransferEvent)(System::TObject* Sender, TcsGoogleDriveTransferEventParams *e); __property TcsGoogleDriveTransferEvent OnTransfer = { read=FOnTransfer, write=FOnTransfer };
Remarks
The Text parameter contains the portion of the document text being received. It is empty if data are being posted to the server.
The BytesTransferred parameter contains the number of bytes transferred in this Direction since the beginning of the document text (excluding HTTP response headers).
The Direction parameter shows whether the client (0) or the server (1) is sending the data.
The PercentDone parameter shows the progress of the transfer in the corresponding direction. If PercentDone can not be calculated the value will be -1.
Note: Events are not re-entrant. Performing time-consuming operations within this event will prevent it from firing again in a timely manner and may affect overall performance.
Config Settings (GoogleDrive Component)
The component 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 component, access to these internal properties is provided through the Config method.GoogleDrive Config Settings
By default, this setting is enabled, allowing all pages of results to be accumulated in the appropriate collection properties.
- 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
Note that this setting is ignored if a MIME type is explicitly passed to the DownloadFile method.
When downloading encrypted data with LocalFile set, the component will automatically create a temporary file at TempPath to hold the encrypted file contents. When the download is complete, the data is decrypted to LocalFile.
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 DownloadFile for details.
- jpg or jpeg - image/jpeg
- pdf - application/pdf
- png (default) - image/png
- svg - image/svg+xml
Note that this setting is ignored if a MIME type is explicitly passed to the DownloadFile method.
This setting accepts a hex encoded value.
This setting accepts a hex encoded value.
- 0 (default) - PBKDF1
- 1 - PBKDF2
The default value is 10485760 (10MB).
Valid values for i are from 0 to (ResourceCount - 1).
When set to false (default), the RequestedFields configuration setting is set added to the request is set to "default". When set to true, the RequestedFields configuration setting is set to "*" which will return all the fields. Further specifications can be made in the RequestedFields configuration setting.
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.
- 0 (default) - Files and folders
- 1 - Files only
- 2 - Folders only
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.
Acceptable values are from 1 to 1000 inclusive. The default is -1, which causes the server's default (100) to be used.
Acceptable values are from 1 to 100, inclusive. The default is -1, which causes the server's default (10) to be used.
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).
If this setting is enabled (default), then when a transfer is interrupted and later resumed, the values reported by the Progress event will account for the data that was successfully transferred before the interruption.
If this setting is disabled, then the component will treat resumed transfers as "new" transfers, and the values reported by the Progress event will start at 0 rather than from the number of bytes already transferred.
Refer to the Progress event for more information.
The default value, 1, will cause the Progress event to fire each time the event's PercentDone parameter value increases by one percent. Setting this setting to 0 will cause the Progress event to fire every time data is transferred.
Note that the Progress 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 component will behave as if this setting were 0 for the duration of the transfer.
By default, the rcfgIncludeAllFields; configuration setting will be set to the special keyword "default" which will tell the component to get the default fields for the component. It can be set to a specific value for the fields parameter (ex. "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 is changed, then the value of the RequestedFields setting will be changed as well. More information can be found in the description of the IncludeAllFields setting. Additionally, if the "fields" parameter is set using the AddQueryParam then the values in the QueryParams properties will take precedent.
Valid values for i are from 0 to (ResourceCount - 1).
Modified Methods
Note: Only have this setting set when it is required. Once it is no longer needed, be sure to set clear this setting.
When ListResourcesScope is set to lrsAllDrives (3), this setting will return "True" after calling ListResources or ListChildren 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 ListResourcesScope or by specifying a search query.
- 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
Note that this setting is ignored if a MIME type is explicitly passed to the DownloadFile method.
- odp - application/vnd.oasis.opendocument.presentation
- pdf - application/pdf
- pptx (default) - application/vnd.openxmlformats-officedocument.presentationml.presentation
- txt - text/plain
Note that this setting is ignored if a MIME type is explicitly passed to the DownloadFile method.
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.
- GetPermissionInfo
- ListPermissions
- UpdatePermissions
- AddSharedDriveMember
- UpdateSharedDriveMember
- RemoveSharedDriveMember
- GetSharedDriveInfo
- ListSharedDrives
- UpdateSharedDrive (both for renaming and changing restrictions)
The current element is specified through the XPath configuration setting. This configuration setting is read-only.
The current element is specified through the XPath configuration setting. This configuration setting is read-only.
The current element is specified through the XPath configuration setting. This configuration setting is read-only.
The current element is specified through the XPath configuration setting. This configuration setting is read-only.
The current element is specified through the XPath configuration setting. This configuration setting is read-only.
When XPath is set to a valid path, XElement points to the name of the element, with XText, XParent, XSubTree, XChildCount, XChildName[i], and 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 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. |
For example, assume the following XML and JSON responses.
XML:
<firstlevel> <one>value</one> <two> <item>first</item> <item>second</item> </two> <three>value three</three> </firstlevel>
JSON:
{ "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.
The current element is specified through the XPath configuration setting. This configuration setting is read-only.
The current element is specified in the XPath configuration setting. This configuration setting is read-only.
OAuth Config Settings
Bearer (default) | When the access token returned by the server is a Bearer type, the authorization string returned by Authorize will be in the format "Bearer access_token". This can be supplied as the value of the HTTP Authorization header. |
For example, when using the Authorization Code grant type, the OAuthRefreshToken property should be set to a valid refresh token. When using the Client Credential grant type however, the component does not need any additional properties set as it can already get a new access token without user interaction.
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.
To parse the payload for specific claims, see OAuthJWTXPath.
The current element is specified in the OAuthJWTXPath configuration setting. This configuration setting is read-only.
The current element is specified in the OAuthJWTXPath configuration setting. This configuration setting is read-only.
The current element is specified in the OAuthJWTXPath configuration setting. This configuration setting is read-only.
The current element is specified in the OAuthJWTXPath configuration setting. This configuration setting is read-only.
The current element is specified in the OAuthJWTXPath configuration setting. This configuration setting is read-only.
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. |
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.
The current element is specified in the OAuthJWTXPath configuration setting. This configuration setting is read-only.
The current element is specified in the OAuthJWTXPath configuration setting. This configuration setting is read-only.
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.
for (int i = 0; i < int.Parse(component.Config("OAuthParamCount")); i++)
{
string name = component.Config("OAuthParamName[" + i + "]");
string value = component.Config("OAuthParamValue[" + i + "]");
}
- 1 (Plain)
- 2 (S256/SHA256 - default)
.NET
Gmail gmail = new Gmail();
gmail.Config("OAuthTransferredRequest=on");
gmail.Authorize();
Console.WriteLine(gmail.Config("OAuthTransferredRequest"));
C++
Gmail gmail;
gmail.Config("OAuthTransferredRequest=on");
gmail.Authorize();
printf("%s\r\n", gmail.Config("OAuthTransferredRequest"));
This setting can also be set to activate or deactivate the web server. Under normal circumstances, this would not be required as the component will automatically start and stop the web server when Authorize is called. In certain cases, it is required to start the webserver before calling Authorize. For example, if the OAuthReturnURL 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 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.
The OAuthWebServerCertStoreType property specifies the type of the certificate store specified by OAuthWebServerCertStore. If the store is password protected, specify the password in OAuthWebServerCertStorePassword.
OAuthWebServerCertStore is used in conjunction with the 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 PFXFile, this property must be set to the name of the file. When the type is PFXBlob, 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 is set to true.
Note: This is only applicable when OAuthWebServerSSLEnabled is set to true.
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. |
The special value "*" picks a random certificate in the certificate store.
The certificate subject is a comma-separated list of distinguished name fields and values. For instance, "CN=www.server.com, OU=test, C=US, E=support@nsoftware.com". Common fields and their meanings are as follows:
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 is set to true.
The default value is localhost.
HTTP Config Settings
When True, the component adds an Accept-Encoding header to the outgoing request. The value for this header can be controlled by the AcceptEncoding configuration setting. The default value for this header is "gzip, deflate".
The default value is True.
If set to True (default), the component will automatically use HTTP/1.1 if the server does not support HTTP/2. If set to False, the component raises an exception if the server does not support HTTP/2.
The default value is True.
This property is provided so that the HTTP component can be extended with other security schemes in addition to the authorization schemes already implemented by the component.
The AuthScheme 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 property in the form "Basic [encoded-user-password]".
The default value is False.
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 component raises an exception.
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 Redirect event is fired for every URL the product is redirected to. In the case of automatic redirections, the 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 component raises an exception instead.
Following are the valid options:
- 0 - Never
- 1 - Always
- 2 - Same Scheme
- "1.0"
- "1.1" (default)
- "2.0"
- "3.0"
When using HTTP/2 ("2.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 component 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 after calling a method. The 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.
The format of the date value for IfModifiedSince is detailed in the HTTP specs. For example:
Sat, 29 Oct 2017 19:43:31 GMT.
The default value for KeepAlive is false.
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).
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 component beyond what is provided.
.NET
Http http = new Http();
http.Config("TransferredRequest=on");
http.PostData = "body";
http.Post("http://someserver.com");
Console.WriteLine(http.Config("TransferredRequest"));
C++
HTTP http;
http.Config("TransferredRequest=on");
http.SetPostData("body", 5);
http.Post("http://someserver.com");
printf("%s\r\n", http.Config("TransferredRequest"));
Note: Some servers (such as the ASP.NET Development Server) may not support chunked encoding.
The default value is False and the hostname will always be used exactly as specified. Note: The CodePage setting must be set to a value capable of interpreting the specified host name. For instance, to specify UTF-8, set CodePage to 65001.
When True (default), the component will check for the existence of a Proxy auto-config URL, and if found, will determine the appropriate proxy to use.
Override the default with the name and version of your software.
TCPClient Config Settings
If the FirewallHost setting is set to a Domain Name, a DNS request is initiated. Upon successful termination of the request, the 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 components that do not directly expose Firewall properties.
Note: This setting is provided for use by components that do not directly expose Firewall properties.
Note: This configuration setting is provided for use by components that do not directly expose Firewall properties.
0 | No firewall (default setting). |
1 | Connect through a tunneling proxy. FirewallPort is set to 80. |
2 | Connect through a SOCKS4 Proxy. FirewallPort is set to 1080. |
3 | Connect through a SOCKS5 Proxy. FirewallPort is set to 1080. |
10 | Connect through a SOCKS4A Proxy. FirewallPort is set to 1080. |
Note: This setting is provided for use by components that do not directly expose Firewall properties.
Note: This setting is provided for use by components that do not directly expose Firewall properties.
Note: This value is not applicable in macOS.
In the case that Linger is True (default), two scenarios determine how long the connection will linger. In the first, if 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 is a positive value, the system will attempt to send pending data until the specified 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 component 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.
In multihomed hosts (machines with more than one IP interface), setting LocalHost to the value of an interface will make the component initiate connections (or accept in the case of server components) only through that interface.
If the component is connected, the LocalHost 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).
Setting this to 0 (default) enables the system to choose a port at random. The chosen port will be shown by LocalPort after the connection is established.
LocalPort 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.
If an EOL string is found in the input stream before MaxLineLength bytes are received, the DataIn event is fired with the EOL parameter set to True, and the buffer is reset.
If no EOL is found, and MaxLineLength bytes are accumulated in the buffer, the DataIn event is fired with the EOL parameter set to False, and the buffer is reset.
The minimum value for MaxLineLength is 256 bytes. The default value is 2048 bytes.
www.google.com;www.nsoftware.com
Note: This value is not applicable in Java.
By default, this configuration setting is set to False.
0 | IPv4 only |
1 | IPv6 only |
2 | IPv6 with IPv4 fallback |
SSL Config Settings
When enabled, SSL packet logs are output using the SSLStatus event, which will fire each time an SSL packet is sent or received.
Enabling this configuration setting has no effect if SSLProvider is set to Platform.
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.
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.
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".
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.
If set to True, the component 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 component is the same.
-----BEGIN CERTIFICATE----- MIIEKzCCAxOgAwIBAgIRANTET4LIkxdH6P+CFIiHvTowDQYJKoZIhvcNAQELBQAw ... Intermedaite Cert ... eWHV5OW1K53o/atv59sOiW5K3crjFhsBOd5Q+cJJnU+SWinPKtANXMht+EDvYY2w F0I1XhM+pKj7FjDr+XNj -----END CERTIFICATE----- \r \n -----BEGIN CERTIFICATE----- MIIEFjCCAv6gAwIBAgIQetu1SMxpnENAnnOz1P+PtTANBgkqhkiG9w0BAQUFADBp ... Root Cert ... d8q23djXZbVYiIfE9ebr4g3152BlVCHZ2GyPdjhIuLeH21VbT/dyEHHA -----END CERTIFICATE-----
When set to 0 (default), the CRL check will not be performed by the component. 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.
When set to 0 (default), the component 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.
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 SSLStatus 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 is currently not supported. This functionality is instead made available through the OpenSSLCipherList configuration setting.
The value of this configuration setting is a newline-separated (CR/LF) list of certificates. For instance:
-----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-----
By default, the enabled cipher suites will include all available ciphers ("*").
The special value "*" means that the component will pick all of the supported cipher suites. If 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 SSLProvider is set to Platform include the following:
obj.config("SSLEnabledCipherSuites=*");
obj.config("SSLEnabledCipherSuites=CALG_AES_256");
obj.config("SSLEnabledCipherSuites=CALG_AES_256;CALG_3DES");
Possible values when SSLProvider 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
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 SSLProvider 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), only the following cipher suites are supported:
- TLS_AES_256_GCM_SHA384
- TLS_CHACHA20_POLY1305_SHA256
- TLS_AES_128_GCM_SHA256
SSLEnabledCipherSuites is used together with SSLCipherStrength.
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 component will use the internal TLS implementation when the SSLProvider is set to Automatic for all editions.
In editions that are designed to run on Windows, SSLProvider 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 and other similar SSL configuration settings are not supported.
- If 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 component when the SSLProvider is set to internal. To use SSL 2.0 or SSL 3.0, the platform security API must have the protocols enabled and SSLProvider needs to be set to platform.
This configuration setting is applicable only when SSLProvider is set to Internal.
If set to True, all certificates returned by the server will be present in the Encoded parameter of the SSLServerAuthentication event. This includes the leaf certificate, any intermediate certificate, and the root certificate.
When set, the component 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 component will only append, it will not overwrite previous values.
Note: This configuration setting is applicable only when SSLProvider is set to Internal.
Note: For server components (e.g., TCPServer), this is a per-connection configuration setting accessed by passing the ConnectionId. For example:
server.Config("SSLNegotiatedCipher[connId]");
Note: For server components (e.g., TCPServer), this is a per-connection configuration setting accessed by passing the ConnectionId. For example:
server.Config("SSLNegotiatedCipherStrength[connId]");
Note: For server components (e.g., TCPServer), this is a per-connection configuration setting accessed by passing the ConnectionId. For example:
server.Config("SSLNegotiatedCipherSuite[connId]");
Note: For server components (e.g., TCPServer), this is a per-connection configuration setting accessed by passing the ConnectionId. For example:
server.Config("SSLNegotiatedKeyExchange[connId]");
Note: For server components (e.g., TCPServer), this is a per-connection configuration setting accessed by passing the ConnectionId. For example:
server.Config("SSLNegotiatedKeyExchangeStrength[connId]");
Note: For server components (e.g., TCPServer), this is a per-connection configuration setting accessed by passing the ConnectionId. For example:
server.Config("SSLNegotiatedVersion[connId]");
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.
The value of this configuration setting is a newline-separated (CR/LF) list of certificates. For instance:
-----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-----
When specified the component 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 component raises an exception.
The format of this value is a comma-separated list of hash-signature combinations. For instance:
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.
The default value is ecdhe_secp256r1,ecdhe_secp384r1,ecdhe_secp521r1.
When using TLS 1.2 and SSLProvider 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)
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"
- "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 ecdhe_x25519,ecdhe_x448,ecdhe_secp256r1,ecdhe_secp384r1,ecdhe_secp521r1,ffdhe_2048,ffdhe_3072,ffdhe_4096,ffdhe_6144,ffdhe_8192
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)
Socket Config Settings
Note: This option is not valid for User Datagram Protocol (UDP) ports.
Some TCP/IP implementations do not support variable buffer sizes. If that is the case, when the component is activated the InBufferSize reverts to its defined size. The same happens if you attempt to make it too large or too small.
Some TCP/IP implementations do not support variable buffer sizes. If that is the case, when the component 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
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 |
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 |
- 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.
This setting only works on these components: AS3Receiver, AS3Sender, Atom, Client(3DS), FTP, FTPServer, IMAP, OFTPClient, SSHClient, SCP, Server(3DS), Sexec, SFTP, SFTPServer, SSHServer, TCPClient, TCPServer.
FIPS mode can be enabled by setting the UseFIPSCompliantAPI configuration setting to true. This is a static setting that applies to all instances of all components of the toolkit within the process. It is recommended to enable or disable this setting once before the component has been used to establish a connection. Enabling FIPS while an instance of the component is active and connected may result in unexpected behavior.
For more details, please see the FIPS 140-2 Compliance article.
Note: This setting is applicable only on Windows.
Note: Enabling FIPS compliance requires a special license; please contact sales@nsoftware.com for details.
Setting this configuration setting to true tells the component to use the internal implementation instead of using the system security libraries.
This setting is set to false by default on all platforms.
Trappable Errors (GoogleDrive Component)
Common Errors
600 | A server error occurred, and/or the component 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 or 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 LocalFile already exists and Overwrite is false. |
609 | The component 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 configuration setting is not set. |
611 | An exception occurred while working with the specified LocalFile (or the current value of LocalFile 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 component may also return one of the following error codes, which are inherited from other components.
HTTP Errors
118 | Firewall Error. Error description contains 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 URLScheme is invalid. |
155 | Range operation is not supported by server. |
156 | Invalid cookie index (out of range). |
301 | Interrupted. |
302 | Can't open AttachedFile. |
The component may also return one of the following error codes, which are inherited from other components.
TCPClient Errors
100 | You cannot change the RemotePort at this time. A connection is in progress. |
101 | You cannot change the RemoteHost (Server) at this time. A connection is in progress. |
102 | The RemoteHost 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 LocalPort at this time. A connection is in progress. |
107 | You cannot change the LocalHost at this time. A connection is in progress. |
112 | You cannot change MaxLineLength at this time. A connection is in progress. |
116 | RemotePort cannot be zero. Please specify a valid service port number. |
117 | You cannot change the UseConnection option while the component 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). |