GoogleTasks Control

Properties   Methods   Events   Config Settings   Errors  

The GoogleTasks control provides an easy way to manage tasks in Google. The control includes support for creating, listing and managing tasks and task lists.

Syntax

GoogleTasks

Remarks

This control provides an easy to use interface for Google Tasks using version 1 of the GoogleTasks REST API. To use the control, first set the Authorization property to a valid OAuth token. The Google Tasks control can be used for creating, retrieving, deleting and updating existing tasks or task lists; and several other functionalities supported by the Google Tasks API.

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

The control has the following defaults:

Below is a brief description of the different OAuthClientProfile and OAuthGrantType values that are supported by this control. For a more in-depth description of what needs to be set, refer to the service documentation.

Application Profile

This profile encompasses the most basic grant types that OAuth supports. When this profile is set, all the requests and response handling is done by the control. Depending on the grant type, this may involve launching a browser so a user can login to authenticate with a authorization server. It may also involve starting an embedded web server to receive a response from a redirect.

To start the authentication and authorization process, the Authorize method should be called. If the authorization and authentication was successful, then the OAuthAccessToken property will be populated. Additionally, if a refresh token was provided the OAuthRefreshToken property will be populated as well. These values of the fields are for informational purposes. The control will also cache these tokens along with when the OAuthAccessToken will be expired. When a method that makes requests to the service provider is called or the Authorize method is called the control will automatically check to see if the access token is expired. If it is, it will then automatically try to get a new OAuthAccessToken. If the Authorize method was not used and user interaction would be required, the control will throw an error which can be caught. When user interaction is needed depends on what grant type is set in the OAuthGrantType property. To force the component to only check the access token when the Authorize method is called, the OAuthAutomaticRefresh configuration setting can be set to false.

A brief description of the supported values for the OAuthGrantType property are below. For more information, see the service documentation.

Authorization Code

When using the Authorization Code grant type, the control will use an authorization code to get an access token. For this OAuthGrantType the control expects a OAuthClientId, OAuthClientSecret, OAuthServerAuthURL, and OAuthServerTokenURL to be set. When the Authorize method is called, the component will start the embedded web server and launch the browser so the user can authorize the application. Once the user authorizes, the service provider will redirect them to the embedded web server and the control will parse the authorization code, setting the OAuthAuthorizationCode property, from the redirect. Immediately, the control will make a request to the token server to exchange the authorization code for an access token. The token server will return an access token and possibly a refresh token. If the OAuthRefreshToken property is set, or a refresh token is cached, then the control will not launch the browser and use the refresh token in its request to the token server instead of an authorization code.

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

Implicit

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

When using the Implicit grant type, the control will request the authorization server to get an access token. For this OAuthGrantType the control expects a OAuthClientId, OAuthClientSecret, and OAuthServerAuthURL to be set. When the Authorize method is called, the component will start the embedded web server and launch the browser so the user can authorize the application. Once the user authorizes, the service provider will redirect them to the embedded web server and the control will parse the access token from the redirect.

A disadvantage of the grant type is that can not use a refresh token to silently get a new access token. Most service providers offer a way to silently get a new access token. See the service documentation for specifics. This means the control will not be able to automatically get a fresh token once it expires.

Web Profile

External OAuth Support

Bearer ACCESS_TOKEN_VALUE

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

For Example: Oauth oauth = new Oauth(); oauth.ClientId = "CLIENT_ID"; oauth.ClientSecret = "CLIENT_SECRET"; oauth.AuthorizationScope = "https://www.googleapis.com/auth/tasks"; oauth.ServerAuthURL = "https://accounts.google.com/o/oauth2/auth"; oauth.ServerTokenURL = "https://accounts.google.com/o/oauth2/token"; oauth.GrantType = OauthGrantTypes.ogtAuthorizationCode; gtask.Authorization = oauth.GetAuthorization(); Consult the documentation for the service for more information about supported scope values and more details on OAuth authentication.

Creating a Task List

To create a task list using the GoogleTasks components we use the CreateTaskList method. The CreateTaskList method will create a new task list with a name specified through the Name parameter.

Creating a task list: gtask.CreateTaskList("Monthly tasks");

Listing Task Lists

Information about task lists fetched by the component can be accessed through the TaskLists properties. The TaskLists properties is populated when the ListTaskLists method is called.

By default, the component will fetch one page of 100 task lists when ListTaskLists is called. If additional task lists remain in the folder, the ListTaskListsMarker configuration property will be populated, it contains the nextPageToken that will be included in the next request as a parameter if ListTaskLists is then called again on the same folder, if called the next page of task lists will be fetched. The example below populates the TaskLists properties with all the task lists associated with the account. do { gtask.ListTaskLists(); } while (gtask.Config("ListTaskListsMarker").Length > 0);

The task lists page size may also be changed by using the TaskListPageSize configuration setting.

Deleting a Task List

To delete a task list use the DeleteTaskList method, provide the Id of the task list as the argument. The task list will stay in the TaskLists collection until ListTaskLists method is called again.

Example (Delete Task List)

// List task lists and deleting the task list named "new name" gtask.ListTaskLists(); for (int i = 0; i < gtask.TaskLists.Count; i++) { if (gtask.TaskLists[i].DisplayName == "new name") { gtask.DeleteTaskList(gtask.TaskLists[i].Id); break; } // Note: the component would let you name more than one task list with the same name so the example would delete the first encounter with the task list that has the specified name }

Creating Tasks

Example (Create a new task in a specific task list)

gtask.CreateTask("Ben's task",taskListId); After creating a task with the basic information, select the task to be edited in the Tasks collection, edit its fields and make a call to the UpdateTask method. To edit the newly created task select the first task in the collection.

Example (Update The First Task In a Task List) // Set properties to update gtask.Tasks[0].Title = "John's Friday Task"; gtask.Tasks[0].Notes = "Notes..."; // Update task at index 0 gtask.UpdateTask(0);

Retrieving a Task

Example (Retrieve a Task)

// Retrieve a task by its ID string taskId = "12345"; // Replace with the actual task ID gtask.GetTask(taskListId, taskId); // Access the retrieved task var retrievedTask = gtask.Tasks[gtask.Tasks.Count - 1]; retrievedTask.Title; //task title retrievedTask.Notes; //notes for this task gtask.GetTaskField(gtask.Tasks.Count - 1, "/json/title"); //task title gtask.GetTaskField(gtask.Tasks.Count - 1, "/json/notes"); //notes for this task

Deleting a Task

To delete a task use the DeleteTask method, provide the Id of the task list and the Id of the task as arguments. The task will stay in the Tasks collection until ListTasks method is called again.

Example (Delete Tasks)

// List tasks and delete all tasks containing "John" in their title gtask.ListTasks(taskListId); for (int i = 0; i < gtask.Tasks.Count; i++) { if (gtask.Tasks[i].Title.Contains("John")) { gtask.DeleteTask(taskListId, gcal.Tasks[i].Id); } }

Property List

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

Method List

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

Event List

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

Config Settings

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

Authorization Property (GoogleTasks Control)

An OAuth Authorization String.

Syntax

googletaskscontrol.Authorization[=string]

Default Value

""

Remarks

This property is used to specify an OAuth authorization string. Setting it is a requirement for using the component.

Example

OAuth oauth = new OAuth(); oauth.ClientProfile = OAuthClientProfiles.ocpApplication; oauth.ClientId = "clientId"; oauth.ClientSecret = "clientSecret"; oauth.ServerAuthURL = "https://accounts.google.com/o/oauth2/auth"; oauth.ServerTokenURL = "https://accounts.google.com/o/oauth2/token"; oauth.AuthorizationScope = "https://www.googleapis.com/auth/tasks"; oauth.GrantType = OAuthGrantTypes.ogtAuthorizationCode; gtask.Authorization = oauth.GetAuthorization();

This property is not available at design time.

Data Type

String

FirewallAutoDetect Property (GoogleTasks Control)

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

Syntax

googletaskscontrol.FirewallAutoDetect[=boolean]

Default Value

False

Remarks

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

Data Type

Boolean

FirewallType Property (GoogleTasks Control)

The type of firewall to connect through.

Syntax

googletaskscontrol.FirewallType[=integer]

Possible Values

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

Default Value

0

Remarks

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

Data Type

Integer

FirewallHost Property (GoogleTasks Control)

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

Syntax

googletaskscontrol.FirewallHost[=string]

Default Value

""

Remarks

The name or IP address of the firewall (optional). If a FirewallHost is given, the requested connections will be authenticated through the specified firewall when connecting.

If this property is set to a Domain Name, a DNS request is initiated. Upon successful termination of the request, this property is set to the corresponding address. If the search is not successful, the control fails with an error.

Data Type

String

FirewallPassword Property (GoogleTasks Control)

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

Syntax

googletaskscontrol.FirewallPassword[=string]

Default Value

""

Remarks

A password if authentication is to be used when connecting through the firewall. If FirewallHost is specified, the FirewallUser and FirewallPassword properties are used to connect and authenticate to the given firewall. If the authentication fails, the control fails with an error.

Data Type

String

FirewallPort Property (GoogleTasks Control)

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

Syntax

googletaskscontrol.FirewallPort[=integer]

Default Value

0

Remarks

The Transmission Control Protocol (TCP) port for the firewall FirewallHost. See the description of the FirewallHost property for details.

Note: This property is set automatically when FirewallType is set to a valid value. See the description of the FirewallType property for details.

Data Type

Integer

FirewallUser Property (GoogleTasks Control)

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

Syntax

googletaskscontrol.FirewallUser[=string]

Default Value

""

Remarks

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

Data Type

String

ListTasksMarker Property (GoogleTasks Control)

The page marker for listing tasks.

Syntax

googletaskscontrol.ListTasksMarker[=string]

Default Value

""

Remarks

This property is populated if there are still unlisted tasks after ListTasks is called. It contains the nextPageToken that will be included in the next request as a parameter if ListTasks is called again. This will cause the next page of tasks to be listed and added to the end of the Tasks collection.

Example (List All Tasks in a TaskList):

do { gtask.ListTasks(mainList.Id); } while (gtask.ListTasksMarker.Length > 0);

This property is not available at design time.

Data Type

String

OAuthAccessToken Property (GoogleTasks Control)

The access token returned by the authorization server.

Syntax

googletaskscontrol.OAuthAccessToken[=string]

Default Value

""

Remarks

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

This property is not available at design time.

Data Type

String

OAuthAuthorizationCode Property (GoogleTasks Control)

The authorization code that is exchanged for an access token.

Syntax

googletaskscontrol.OAuthAuthorizationCode[=string]

Default Value

""

Remarks

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

This property is not available at design time.

Data Type

String

OAuthAuthorizationScope Property (GoogleTasks Control)

The scope request or response parameter used during authorization.

Syntax

googletaskscontrol.OAuthAuthorizationScope[=string]

Default Value

""

Remarks

The scope request or response parameter used during authorization.

This property is not available at design time.

Data Type

String

OAuthClientId Property (GoogleTasks Control)

The id of the client assigned when registering the application.

Syntax

googletaskscontrol.OAuthClientId[=string]

Default Value

""

Remarks

The id of the client assigned when registering the application.

This property is not available at design time.

Data Type

String

OAuthClientProfile Property (GoogleTasks Control)

The type of client that is requesting authorization.

Syntax

googletaskscontrol.OAuthClientProfile[=integer]

Possible Values

cocpApplication(0), 
cocpWeb(1)

Default Value

0

Remarks

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

This property is not available at design time.

Data Type

Integer

OAuthClientSecret Property (GoogleTasks Control)

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

Syntax

googletaskscontrol.OAuthClientSecret[=string]

Default Value

""

Remarks

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

This property is not available at design time.

Data Type

String

OAuthGrantType Property (GoogleTasks Control)

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

Syntax

googletaskscontrol.OAuthGrantType[=integer]

Possible Values

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

Default Value

0

Remarks

The OAuth grant type used to acquire an OAuth access token. See the introduction section for more information. Possible values are:

This property is not available at design time.

Data Type

Integer

OAuthRefreshToken Property (GoogleTasks Control)

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

Syntax

googletaskscontrol.OAuthRefreshToken[=string]

Default Value

""

Remarks

Specifies the refresh token received from or sent to the authorization server. This property is set automatically if a refresh token is retrieved from the token server. If the OAuthAutomaticRefresh configuration setting is set to true, and the OAuthGrantType property is set to a grant that can use refresh tokens.

This property is not available at design time.

Data Type

String

OAuthRequestRefreshToken Property (GoogleTasks Control)

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

Syntax

googletaskscontrol.OAuthRequestRefreshToken[=boolean]

Default Value

True

Remarks

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

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

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

This property is not available at design time.

Data Type

Boolean

OAuthReturnURL Property (GoogleTasks Control)

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

Syntax

googletaskscontrol.OAuthReturnURL[=string]

Default Value

""

Remarks

The URL where the user (browser) returns after authenticating. This property is mapped to the redirect_uri parameter when making a request to the authorization server. Typically, this is automatically set by the control when using the embedded web server. If the OAuthWebServerPort or OAuthWebServerHost configuration settings is set, then this property should be set to match. If using the Web client profile, this should be set to the place where the authorization code will be parsed out of the response after the user finishes authorizing.

This property is not available at design time.

Data Type

String

OAuthServerAuthURL Property (GoogleTasks Control)

The URL of the authorization server.

Syntax

googletaskscontrol.OAuthServerAuthURL[=string]

Default Value

""

Remarks

The URL of the authorization server.

This property is not available at design time.

Data Type

String

OAuthServerTokenURL Property (GoogleTasks Control)

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

Syntax

googletaskscontrol.OAuthServerTokenURL[=string]

Default Value

""

Remarks

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

This property is not available at design time.

Data Type

String

OAuthWebAuthURL Property (GoogleTasks Control)

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

Syntax

googletaskscontrol.OAuthWebAuthURL

Default Value

""

Remarks

The URL to which the user should be re-directed for authorization. This field is used to get the URL that the user should be redirected to when using the Web client profile. See introduction section for more information.

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

Data Type

String

ProxyAuthScheme Property (GoogleTasks Control)

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

Syntax

googletaskscontrol.ProxyAuthScheme[=integer]

Possible Values

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

Default Value

0

Remarks

The type of authorization to perform when connecting to the proxy. This is used only when the ProxyUser and ProxyPassword properties are set.

ProxyAuthScheme should be set to authNone (3) when no authentication is expected.

By default, ProxyAuthScheme is authBasic (0), and if the ProxyUser and ProxyPassword properties are set, the control will attempt basic authentication.

If ProxyAuthScheme is set to authDigest (1), digest authentication will be attempted instead.

If ProxyAuthScheme is set to authProprietary (2), then the authorization token will not be generated by the control. Look at the configuration file for the control being used to find more information about manually setting this token.

If ProxyAuthScheme is set to authNtlm (4), NTLM authentication will be used.

For security reasons, setting this property will clear the values of ProxyUser and ProxyPassword.

Data Type

Integer

ProxyAutoDetect Property (GoogleTasks Control)

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

Syntax

googletaskscontrol.ProxyAutoDetect[=boolean]

Default Value

False

Remarks

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

Data Type

Boolean

ProxyPassword Property (GoogleTasks Control)

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

Syntax

googletaskscontrol.ProxyPassword[=string]

Default Value

""

Remarks

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

If ProxyAuthScheme is set to Basic Authentication, the ProxyUser and ProxyPassword properties are Base64 encoded and the proxy authentication token will be generated in the form Basic [encoded-user-password].

If ProxyAuthScheme is set to Digest Authentication, the ProxyUser and ProxyPassword properties are used to respond to the Digest Authentication challenge from the server.

If ProxyAuthScheme is set to NTLM Authentication, the ProxyUser and ProxyPassword properties are used to authenticate through NTLM negotiation.

Data Type

String

ProxyPort Property (GoogleTasks Control)

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

Syntax

googletaskscontrol.ProxyPort[=integer]

Default Value

80

Remarks

The Transmission Control Protocol (TCP) port for the proxy ProxyServer (default 80). See the description of the ProxyServer property for details.

Data Type

Integer

ProxyServer Property (GoogleTasks Control)

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

Syntax

googletaskscontrol.ProxyServer[=string]

Default Value

""

Remarks

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

If the ProxyServer property is set to a domain name, a DNS request is initiated. Upon successful termination of the request, the ProxyServer property is set to the corresponding address. If the search is not successful, an error is returned.

Data Type

String

ProxySSL Property (GoogleTasks Control)

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

Syntax

googletaskscontrol.ProxySSL[=integer]

Possible Values

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

Default Value

0

Remarks

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

Data Type

Integer

ProxyUser Property (GoogleTasks Control)

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

Syntax

googletaskscontrol.ProxyUser[=string]

Default Value

""

Remarks

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

If ProxyAuthScheme is set to Basic Authentication, the ProxyUser and ProxyPassword properties are Base64 encoded and the proxy authentication token will be generated in the form Basic [encoded-user-password].

If ProxyAuthScheme is set to Digest Authentication, the ProxyUser and ProxyPassword properties are used to respond to the Digest Authentication challenge from the server.

If ProxyAuthScheme is set to NTLM Authentication, the ProxyUser and ProxyPassword properties are used to authenticate through NTLM negotiation.

Data Type

String

SSLAcceptServerCertEffectiveDate Property (GoogleTasks Control)

The date on which this certificate becomes valid.

Syntax

googletaskscontrol.SSLAcceptServerCertEffectiveDate

Default Value

""

Remarks

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

23-Jan-2000 15:00:00.

This property is read-only.

Data Type

String

SSLAcceptServerCertExpirationDate Property (GoogleTasks Control)

The date on which the certificate expires.

Syntax

googletaskscontrol.SSLAcceptServerCertExpirationDate

Default Value

""

Remarks

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

23-Jan-2001 15:00:00.

This property is read-only.

Data Type

String

SSLAcceptServerCertExtendedKeyUsage Property (GoogleTasks Control)

A comma-delimited list of extended key usage identifiers.

Syntax

googletaskscontrol.SSLAcceptServerCertExtendedKeyUsage

Default Value

""

Remarks

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

This property is read-only.

Data Type

String

SSLAcceptServerCertFingerprint Property (GoogleTasks Control)

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

Syntax

googletaskscontrol.SSLAcceptServerCertFingerprint

Default Value

""

Remarks

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

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

This property is read-only.

Data Type

String

SSLAcceptServerCertFingerprintSHA1 Property (GoogleTasks Control)

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

Syntax

googletaskscontrol.SSLAcceptServerCertFingerprintSHA1

Default Value

""

Remarks

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

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

This property is read-only.

Data Type

String

SSLAcceptServerCertFingerprintSHA256 Property (GoogleTasks Control)

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

Syntax

googletaskscontrol.SSLAcceptServerCertFingerprintSHA256

Default Value

""

Remarks

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

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

This property is read-only.

Data Type

String

SSLAcceptServerCertIssuer Property (GoogleTasks Control)

The issuer of the certificate.

Syntax

googletaskscontrol.SSLAcceptServerCertIssuer

Default Value

""

Remarks

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

This property is read-only.

Data Type

String

SSLAcceptServerCertPrivateKey Property (GoogleTasks Control)

The private key of the certificate (if available).

Syntax

googletaskscontrol.SSLAcceptServerCertPrivateKey

Default Value

""

Remarks

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

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

This property is read-only.

Data Type

String

SSLAcceptServerCertPrivateKeyAvailable Property (GoogleTasks Control)

Whether a PrivateKey is available for the selected certificate.

Syntax

googletaskscontrol.SSLAcceptServerCertPrivateKeyAvailable

Default Value

False

Remarks

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

This property is read-only.

Data Type

Boolean

SSLAcceptServerCertPrivateKeyContainer Property (GoogleTasks Control)

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

Syntax

googletaskscontrol.SSLAcceptServerCertPrivateKeyContainer

Default Value

""

Remarks

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

This property is read-only.

Data Type

String

SSLAcceptServerCertPublicKey Property (GoogleTasks Control)

The public key of the certificate.

Syntax

googletaskscontrol.SSLAcceptServerCertPublicKey

Default Value

""

Remarks

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

This property is read-only.

Data Type

String

SSLAcceptServerCertPublicKeyAlgorithm Property (GoogleTasks Control)

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

Syntax

googletaskscontrol.SSLAcceptServerCertPublicKeyAlgorithm

Default Value

""

Remarks

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

This property is read-only.

Data Type

String

SSLAcceptServerCertPublicKeyLength Property (GoogleTasks Control)

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

Syntax

googletaskscontrol.SSLAcceptServerCertPublicKeyLength

Default Value

0

Remarks

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

This property is read-only.

Data Type

Integer

SSLAcceptServerCertSerialNumber Property (GoogleTasks Control)

The serial number of the certificate encoded as a string.

Syntax

googletaskscontrol.SSLAcceptServerCertSerialNumber

Default Value

""

Remarks

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

This property is read-only.

Data Type

String

SSLAcceptServerCertSignatureAlgorithm Property (GoogleTasks Control)

The text description of the certificate's signature algorithm.

Syntax

googletaskscontrol.SSLAcceptServerCertSignatureAlgorithm

Default Value

""

Remarks

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

This property is read-only.

Data Type

String

SSLAcceptServerCertStore Property (GoogleTasks Control)

The name of the certificate store for the client certificate.

Syntax

googletaskscontrol.SSLAcceptServerCertStore[=string]

Default Value

"MY"

Remarks

The name of the certificate store for the client certificate.

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

SSLAcceptServerCertStore is used in conjunction with the SSLAcceptServerCertSubject property to specify client certificates. If SSLAcceptServerCertStore has a value, and SSLAcceptServerCertSubject or SSLAcceptServerCertEncoded is set, a search for a certificate is initiated. Please see the SSLAcceptServerCertSubject property for details.

Designations of certificate stores are platform dependent.

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

When the certificate store type is cstPFXFile, this property must be set to the name of the file. When the type is cstPFXBlob, the property must be set to the binary contents of a PFX file (i.e., PKCS#12 certificate store).

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

Data Type

Binary String

SSLAcceptServerCertStorePassword Property (GoogleTasks Control)

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

Syntax

googletaskscontrol.SSLAcceptServerCertStorePassword[=string]

Default Value

""

Remarks

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

Data Type

String

SSLAcceptServerCertStoreType Property (GoogleTasks Control)

The type of certificate store for this certificate.

Syntax

googletaskscontrol.SSLAcceptServerCertStoreType[=integer]

Possible Values

cstUser(0), 
cstMachine(1), 
cstPFXFile(2), 
cstPFXBlob(3), 
cstJKSFile(4), 
cstJKSBlob(5), 
cstPEMKeyFile(6), 
cstPEMKeyBlob(7), 
cstPublicKeyFile(8), 
cstPublicKeyBlob(9), 
cstSSHPublicKeyBlob(10), 
cstP7BFile(11), 
cstP7BBlob(12), 
cstSSHPublicKeyFile(13), 
cstPPKFile(14), 
cstPPKBlob(15), 
cstXMLFile(16), 
cstXMLBlob(17), 
cstJWKFile(18), 
cstJWKBlob(19), 
cstSecurityKey(20), 
cstBCFKSFile(21), 
cstBCFKSBlob(22), 
cstPKCS11(23), 
cstAuto(99)

Default Value

0

Remarks

The type of certificate store for this certificate.

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

Data Type

Integer

SSLAcceptServerCertSubjectAltNames Property (GoogleTasks Control)

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

Syntax

googletaskscontrol.SSLAcceptServerCertSubjectAltNames

Default Value

""

Remarks

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

This property is read-only.

Data Type

String

SSLAcceptServerCertThumbprintMD5 Property (GoogleTasks Control)

The MD5 hash of the certificate.

Syntax

googletaskscontrol.SSLAcceptServerCertThumbprintMD5

Default Value

""

Remarks

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

This property is read-only.

Data Type

String

SSLAcceptServerCertThumbprintSHA1 Property (GoogleTasks Control)

The SHA-1 hash of the certificate.

Syntax

googletaskscontrol.SSLAcceptServerCertThumbprintSHA1

Default Value

""

Remarks

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

This property is read-only.

Data Type

String

SSLAcceptServerCertThumbprintSHA256 Property (GoogleTasks Control)

The SHA-256 hash of the certificate.

Syntax

googletaskscontrol.SSLAcceptServerCertThumbprintSHA256

Default Value

""

Remarks

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

This property is read-only.

Data Type

String

SSLAcceptServerCertUsage Property (GoogleTasks Control)

The text description of UsageFlags .

Syntax

googletaskscontrol.SSLAcceptServerCertUsage

Default Value

""

Remarks

The text description of SSLAcceptServerCertUsageFlags.

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

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

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

This property is read-only.

Data Type

String

SSLAcceptServerCertUsageFlags Property (GoogleTasks Control)

The flags that show intended use for the certificate.

Syntax

googletaskscontrol.SSLAcceptServerCertUsageFlags

Default Value

0

Remarks

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

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

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

This property is read-only.

Data Type

Integer

SSLAcceptServerCertVersion Property (GoogleTasks Control)

The certificate's version number.

Syntax

googletaskscontrol.SSLAcceptServerCertVersion

Default Value

""

Remarks

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

This property is read-only.

Data Type

String

SSLAcceptServerCertSubject Property (GoogleTasks Control)

The subject of the certificate used for client authentication.

Syntax

googletaskscontrol.SSLAcceptServerCertSubject[=string]

Default Value

""

Remarks

The subject of the certificate used for client authentication.

This property must be set after all other certificate properties are set. When this property is set, a search is performed in the current certificate store to locate a certificate with a matching subject.

If a matching certificate is found, the property is set to the full subject of the matching certificate.

If an exact match is not found, the store is searched for subjects containing the value of the property.

If a match is still not found, the property is set to an empty string, and no certificate is selected.

The special value "*" picks a random certificate in the certificate store.

The certificate subject is a comma-separated list of distinguished name fields and values. For instance, "CN=www.server.com, OU=test, C=US, E=support@nsoftware.com". Common fields and their meanings are as follows:

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

Data Type

String

SSLAcceptServerCertEncoded Property (GoogleTasks Control)

The certificate (PEM/Base64 encoded).

Syntax

googletaskscontrol.SSLAcceptServerCertEncoded[=string]

Default Value

""

Remarks

The certificate (PEM/Base64 encoded). This property is used to assign a specific certificate. The SSLAcceptServerCertStore and SSLAcceptServerCertSubject properties also may be used to specify a certificate.

When SSLAcceptServerCertEncoded is set, a search is initiated in the current SSLAcceptServerCertStore for the private key of the certificate. If the key is found, SSLAcceptServerCertSubject is updated to reflect the full subject of the selected certificate; otherwise, SSLAcceptServerCertSubject is set to an empty string.

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

This property is not available at design time.

Data Type

Binary String

SSLCertEffectiveDate Property (GoogleTasks Control)

The date on which this certificate becomes valid.

Syntax

googletaskscontrol.SSLCertEffectiveDate

Default Value

""

Remarks

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

23-Jan-2000 15:00:00.

This property is read-only.

Data Type

String

SSLCertExpirationDate Property (GoogleTasks Control)

The date on which the certificate expires.

Syntax

googletaskscontrol.SSLCertExpirationDate

Default Value

""

Remarks

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

23-Jan-2001 15:00:00.

This property is read-only.

Data Type

String

SSLCertExtendedKeyUsage Property (GoogleTasks Control)

A comma-delimited list of extended key usage identifiers.

Syntax

googletaskscontrol.SSLCertExtendedKeyUsage

Default Value

""

Remarks

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

This property is read-only.

Data Type

String

SSLCertFingerprint Property (GoogleTasks Control)

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

Syntax

googletaskscontrol.SSLCertFingerprint

Default Value

""

Remarks

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

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

This property is read-only.

Data Type

String

SSLCertFingerprintSHA1 Property (GoogleTasks Control)

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

Syntax

googletaskscontrol.SSLCertFingerprintSHA1

Default Value

""

Remarks

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

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

This property is read-only.

Data Type

String

SSLCertFingerprintSHA256 Property (GoogleTasks Control)

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

Syntax

googletaskscontrol.SSLCertFingerprintSHA256

Default Value

""

Remarks

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

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

This property is read-only.

Data Type

String

SSLCertIssuer Property (GoogleTasks Control)

The issuer of the certificate.

Syntax

googletaskscontrol.SSLCertIssuer

Default Value

""

Remarks

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

This property is read-only.

Data Type

String

SSLCertPrivateKey Property (GoogleTasks Control)

The private key of the certificate (if available).

Syntax

googletaskscontrol.SSLCertPrivateKey

Default Value

""

Remarks

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

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

This property is read-only.

Data Type

String

SSLCertPrivateKeyAvailable Property (GoogleTasks Control)

Whether a PrivateKey is available for the selected certificate.

Syntax

googletaskscontrol.SSLCertPrivateKeyAvailable

Default Value

False

Remarks

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

This property is read-only.

Data Type

Boolean

SSLCertPrivateKeyContainer Property (GoogleTasks Control)

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

Syntax

googletaskscontrol.SSLCertPrivateKeyContainer

Default Value

""

Remarks

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

This property is read-only.

Data Type

String

SSLCertPublicKey Property (GoogleTasks Control)

The public key of the certificate.

Syntax

googletaskscontrol.SSLCertPublicKey

Default Value

""

Remarks

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

This property is read-only.

Data Type

String

SSLCertPublicKeyAlgorithm Property (GoogleTasks Control)

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

Syntax

googletaskscontrol.SSLCertPublicKeyAlgorithm

Default Value

""

Remarks

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

This property is read-only.

Data Type

String

SSLCertPublicKeyLength Property (GoogleTasks Control)

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

Syntax

googletaskscontrol.SSLCertPublicKeyLength

Default Value

0

Remarks

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

This property is read-only.

Data Type

Integer

SSLCertSerialNumber Property (GoogleTasks Control)

The serial number of the certificate encoded as a string.

Syntax

googletaskscontrol.SSLCertSerialNumber

Default Value

""

Remarks

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

This property is read-only.

Data Type

String

SSLCertSignatureAlgorithm Property (GoogleTasks Control)

The text description of the certificate's signature algorithm.

Syntax

googletaskscontrol.SSLCertSignatureAlgorithm

Default Value

""

Remarks

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

This property is read-only.

Data Type

String

SSLCertStore Property (GoogleTasks Control)

The name of the certificate store for the client certificate.

Syntax

googletaskscontrol.SSLCertStore[=string]

Default Value

"MY"

Remarks

The name of the certificate store for the client certificate.

The SSLCertStoreType property denotes the type of the certificate store specified by SSLCertStore. If the store is password-protected, specify the password in SSLCertStorePassword.

SSLCertStore is used in conjunction with the SSLCertSubject property to specify client certificates. If SSLCertStore has a value, and SSLCertSubject or SSLCertEncoded is set, a search for a certificate is initiated. Please see the SSLCertSubject property for details.

Designations of certificate stores are platform dependent.

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

When the certificate store type is cstPFXFile, this property must be set to the name of the file. When the type is cstPFXBlob, the property must be set to the binary contents of a PFX file (i.e., PKCS#12 certificate store).

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

Data Type

Binary String

SSLCertStorePassword Property (GoogleTasks Control)

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

Syntax

googletaskscontrol.SSLCertStorePassword[=string]

Default Value

""

Remarks

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

Data Type

String

SSLCertStoreType Property (GoogleTasks Control)

The type of certificate store for this certificate.

Syntax

googletaskscontrol.SSLCertStoreType[=integer]

Possible Values

cstUser(0), 
cstMachine(1), 
cstPFXFile(2), 
cstPFXBlob(3), 
cstJKSFile(4), 
cstJKSBlob(5), 
cstPEMKeyFile(6), 
cstPEMKeyBlob(7), 
cstPublicKeyFile(8), 
cstPublicKeyBlob(9), 
cstSSHPublicKeyBlob(10), 
cstP7BFile(11), 
cstP7BBlob(12), 
cstSSHPublicKeyFile(13), 
cstPPKFile(14), 
cstPPKBlob(15), 
cstXMLFile(16), 
cstXMLBlob(17), 
cstJWKFile(18), 
cstJWKBlob(19), 
cstSecurityKey(20), 
cstBCFKSFile(21), 
cstBCFKSBlob(22), 
cstPKCS11(23), 
cstAuto(99)

Default Value

0

Remarks

The type of certificate store for this certificate.

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

Data Type

Integer

SSLCertSubjectAltNames Property (GoogleTasks Control)

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

Syntax

googletaskscontrol.SSLCertSubjectAltNames

Default Value

""

Remarks

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

This property is read-only.

Data Type

String

SSLCertThumbprintMD5 Property (GoogleTasks Control)

The MD5 hash of the certificate.

Syntax

googletaskscontrol.SSLCertThumbprintMD5

Default Value

""

Remarks

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

This property is read-only.

Data Type

String

SSLCertThumbprintSHA1 Property (GoogleTasks Control)

The SHA-1 hash of the certificate.

Syntax

googletaskscontrol.SSLCertThumbprintSHA1

Default Value

""

Remarks

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

This property is read-only.

Data Type

String

SSLCertThumbprintSHA256 Property (GoogleTasks Control)

The SHA-256 hash of the certificate.

Syntax

googletaskscontrol.SSLCertThumbprintSHA256

Default Value

""

Remarks

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

This property is read-only.

Data Type

String

SSLCertUsage Property (GoogleTasks Control)

The text description of UsageFlags .

Syntax

googletaskscontrol.SSLCertUsage

Default Value

""

Remarks

The text description of SSLCertUsageFlags.

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

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

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

This property is read-only.

Data Type

String

SSLCertUsageFlags Property (GoogleTasks Control)

The flags that show intended use for the certificate.

Syntax

googletaskscontrol.SSLCertUsageFlags

Default Value

0

Remarks

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

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

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

This property is read-only.

Data Type

Integer

SSLCertVersion Property (GoogleTasks Control)

The certificate's version number.

Syntax

googletaskscontrol.SSLCertVersion

Default Value

""

Remarks

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

This property is read-only.

Data Type

String

SSLCertSubject Property (GoogleTasks Control)

The subject of the certificate used for client authentication.

Syntax

googletaskscontrol.SSLCertSubject[=string]

Default Value

""

Remarks

The subject of the certificate used for client authentication.

This property must be set after all other certificate properties are set. When this property is set, a search is performed in the current certificate store to locate a certificate with a matching subject.

If a matching certificate is found, the property is set to the full subject of the matching certificate.

If an exact match is not found, the store is searched for subjects containing the value of the property.

If a match is still not found, the property is set to an empty string, and no certificate is selected.

The special value "*" picks a random certificate in the certificate store.

The certificate subject is a comma-separated list of distinguished name fields and values. For instance, "CN=www.server.com, OU=test, C=US, E=support@nsoftware.com". Common fields and their meanings are as follows:

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

Data Type

String

SSLCertEncoded Property (GoogleTasks Control)

The certificate (PEM/Base64 encoded).

Syntax

googletaskscontrol.SSLCertEncoded[=string]

Default Value

""

Remarks

The certificate (PEM/Base64 encoded). This property is used to assign a specific certificate. The SSLCertStore and SSLCertSubject properties also may be used to specify a certificate.

When SSLCertEncoded is set, a search is initiated in the current SSLCertStore for the private key of the certificate. If the key is found, SSLCertSubject is updated to reflect the full subject of the selected certificate; otherwise, SSLCertSubject is set to an empty string.

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

This property is not available at design time.

Data Type

Binary String

SSLProvider Property (GoogleTasks Control)

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

Syntax

googletaskscontrol.SSLProvider[=integer]

Possible Values

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

Default Value

0

Remarks

This property specifies the SSL/TLS implementation to use. In most cases the default value of 0 (Automatic) is recommended and should not be changed. When set to 0 (Automatic), the control will select whether to use the platform implementation or the internal implementation depending on the operating system as well as the TLS version being used.

Possible values are as follows:

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

When Automatic is selected, the platform implementation is used by default. When TLS 1.3 is enabled via SSLEnabledProtocols, the internal implementation is used.

Data Type

Integer

SSLServerCertEffectiveDate Property (GoogleTasks Control)

The date on which this certificate becomes valid.

Syntax

googletaskscontrol.SSLServerCertEffectiveDate

Default Value

""

Remarks

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

23-Jan-2000 15:00:00.

This property is read-only.

Data Type

String

SSLServerCertExpirationDate Property (GoogleTasks Control)

The date on which the certificate expires.

Syntax

googletaskscontrol.SSLServerCertExpirationDate

Default Value

""

Remarks

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

23-Jan-2001 15:00:00.

This property is read-only.

Data Type

String

SSLServerCertExtendedKeyUsage Property (GoogleTasks Control)

A comma-delimited list of extended key usage identifiers.

Syntax

googletaskscontrol.SSLServerCertExtendedKeyUsage

Default Value

""

Remarks

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

This property is read-only.

Data Type

String

SSLServerCertFingerprint Property (GoogleTasks Control)

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

Syntax

googletaskscontrol.SSLServerCertFingerprint

Default Value

""

Remarks

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

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

This property is read-only.

Data Type

String

SSLServerCertFingerprintSHA1 Property (GoogleTasks Control)

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

Syntax

googletaskscontrol.SSLServerCertFingerprintSHA1

Default Value

""

Remarks

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

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

This property is read-only.

Data Type

String

SSLServerCertFingerprintSHA256 Property (GoogleTasks Control)

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

Syntax

googletaskscontrol.SSLServerCertFingerprintSHA256

Default Value

""

Remarks

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

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

This property is read-only.

Data Type

String

SSLServerCertIssuer Property (GoogleTasks Control)

The issuer of the certificate.

Syntax

googletaskscontrol.SSLServerCertIssuer

Default Value

""

Remarks

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

This property is read-only.

Data Type

String

SSLServerCertPrivateKey Property (GoogleTasks Control)

The private key of the certificate (if available).

Syntax

googletaskscontrol.SSLServerCertPrivateKey

Default Value

""

Remarks

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

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

This property is read-only.

Data Type

String

SSLServerCertPrivateKeyAvailable Property (GoogleTasks Control)

Whether a PrivateKey is available for the selected certificate.

Syntax

googletaskscontrol.SSLServerCertPrivateKeyAvailable

Default Value

False

Remarks

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

This property is read-only.

Data Type

Boolean

SSLServerCertPrivateKeyContainer Property (GoogleTasks Control)

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

Syntax

googletaskscontrol.SSLServerCertPrivateKeyContainer

Default Value

""

Remarks

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

This property is read-only.

Data Type

String

SSLServerCertPublicKey Property (GoogleTasks Control)

The public key of the certificate.

Syntax

googletaskscontrol.SSLServerCertPublicKey

Default Value

""

Remarks

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

This property is read-only.

Data Type

String

SSLServerCertPublicKeyAlgorithm Property (GoogleTasks Control)

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

Syntax

googletaskscontrol.SSLServerCertPublicKeyAlgorithm

Default Value

""

Remarks

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

This property is read-only.

Data Type

String

SSLServerCertPublicKeyLength Property (GoogleTasks Control)

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

Syntax

googletaskscontrol.SSLServerCertPublicKeyLength

Default Value

0

Remarks

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

This property is read-only.

Data Type

Integer

SSLServerCertSerialNumber Property (GoogleTasks Control)

The serial number of the certificate encoded as a string.

Syntax

googletaskscontrol.SSLServerCertSerialNumber

Default Value

""

Remarks

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

This property is read-only.

Data Type

String

SSLServerCertSignatureAlgorithm Property (GoogleTasks Control)

The text description of the certificate's signature algorithm.

Syntax

googletaskscontrol.SSLServerCertSignatureAlgorithm

Default Value

""

Remarks

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

This property is read-only.

Data Type

String

SSLServerCertStore Property (GoogleTasks Control)

The name of the certificate store for the client certificate.

Syntax

googletaskscontrol.SSLServerCertStore

Default Value

"MY"

Remarks

The name of the certificate store for the client certificate.

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

SSLServerCertStore is used in conjunction with the SSLServerCertSubject property to specify client certificates. If SSLServerCertStore has a value, and SSLServerCertSubject or SSLServerCertEncoded is set, a search for a certificate is initiated. Please see the SSLServerCertSubject property for details.

Designations of certificate stores are platform dependent.

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

When the certificate store type is cstPFXFile, this property must be set to the name of the file. When the type is cstPFXBlob, the property must be set to the binary contents of a PFX file (i.e., PKCS#12 certificate store).

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

This property is read-only.

Data Type

Binary String

SSLServerCertStorePassword Property (GoogleTasks Control)

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

Syntax

googletaskscontrol.SSLServerCertStorePassword

Default Value

""

Remarks

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

This property is read-only.

Data Type

String

SSLServerCertStoreType Property (GoogleTasks Control)

The type of certificate store for this certificate.

Syntax

googletaskscontrol.SSLServerCertStoreType

Possible Values

cstUser(0), 
cstMachine(1), 
cstPFXFile(2), 
cstPFXBlob(3), 
cstJKSFile(4), 
cstJKSBlob(5), 
cstPEMKeyFile(6), 
cstPEMKeyBlob(7), 
cstPublicKeyFile(8), 
cstPublicKeyBlob(9), 
cstSSHPublicKeyBlob(10), 
cstP7BFile(11), 
cstP7BBlob(12), 
cstSSHPublicKeyFile(13), 
cstPPKFile(14), 
cstPPKBlob(15), 
cstXMLFile(16), 
cstXMLBlob(17), 
cstJWKFile(18), 
cstJWKBlob(19), 
cstSecurityKey(20), 
cstBCFKSFile(21), 
cstBCFKSBlob(22), 
cstPKCS11(23), 
cstAuto(99)

Default Value

0

Remarks

The type of certificate store for this certificate.

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

This property is read-only.

Data Type

Integer

SSLServerCertSubjectAltNames Property (GoogleTasks Control)

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

Syntax

googletaskscontrol.SSLServerCertSubjectAltNames

Default Value

""

Remarks

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

This property is read-only.

Data Type

String

SSLServerCertThumbprintMD5 Property (GoogleTasks Control)

The MD5 hash of the certificate.

Syntax

googletaskscontrol.SSLServerCertThumbprintMD5

Default Value

""

Remarks

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

This property is read-only.

Data Type

String

SSLServerCertThumbprintSHA1 Property (GoogleTasks Control)

The SHA-1 hash of the certificate.

Syntax

googletaskscontrol.SSLServerCertThumbprintSHA1

Default Value

""

Remarks

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

This property is read-only.

Data Type

String

SSLServerCertThumbprintSHA256 Property (GoogleTasks Control)

The SHA-256 hash of the certificate.

Syntax

googletaskscontrol.SSLServerCertThumbprintSHA256

Default Value

""

Remarks

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

This property is read-only.

Data Type

String

SSLServerCertUsage Property (GoogleTasks Control)

The text description of UsageFlags .

Syntax

googletaskscontrol.SSLServerCertUsage

Default Value

""

Remarks

The text description of SSLServerCertUsageFlags.

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

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

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

This property is read-only.

Data Type

String

SSLServerCertUsageFlags Property (GoogleTasks Control)

The flags that show intended use for the certificate.

Syntax

googletaskscontrol.SSLServerCertUsageFlags

Default Value

0

Remarks

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

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

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

This property is read-only.

Data Type

Integer

SSLServerCertVersion Property (GoogleTasks Control)

The certificate's version number.

Syntax

googletaskscontrol.SSLServerCertVersion

Default Value

""

Remarks

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

This property is read-only.

Data Type

String

SSLServerCertSubject Property (GoogleTasks Control)

The subject of the certificate used for client authentication.

Syntax

googletaskscontrol.SSLServerCertSubject

Default Value

""

Remarks

The subject of the certificate used for client authentication.

This property must be set after all other certificate properties are set. When this property is set, a search is performed in the current certificate store to locate a certificate with a matching subject.

If a matching certificate is found, the property is set to the full subject of the matching certificate.

If an exact match is not found, the store is searched for subjects containing the value of the property.

If a match is still not found, the property is set to an empty string, and no certificate is selected.

The special value "*" picks a random certificate in the certificate store.

The certificate subject is a comma-separated list of distinguished name fields and values. For instance, "CN=www.server.com, OU=test, C=US, E=support@nsoftware.com". Common fields and their meanings are as follows:

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

This property is read-only.

Data Type

String

SSLServerCertEncoded Property (GoogleTasks Control)

The certificate (PEM/Base64 encoded).

Syntax

googletaskscontrol.SSLServerCertEncoded

Default Value

""

Remarks

The certificate (PEM/Base64 encoded). This property is used to assign a specific certificate. The SSLServerCertStore and SSLServerCertSubject properties also may be used to specify a certificate.

When SSLServerCertEncoded is set, a search is initiated in the current SSLServerCertStore for the private key of the certificate. If the key is found, SSLServerCertSubject is updated to reflect the full subject of the selected certificate; otherwise, SSLServerCertSubject is set to an empty string.

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

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

Data Type

Binary String

TaskListsCount Property (GoogleTasks Control)

The number of records in the TaskList arrays.

Syntax

googletaskscontrol.TaskListsCount[=integer]

Default Value

0

Remarks

This property controls the size of the following arrays:

• TaskListId
• TaskListTitle
• TaskListUpdated

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

This property is not available at design time.

Data Type

Integer

TaskListId Property (GoogleTasks Control)

The unique identifier of the task list.

Syntax

googletaskscontrol.TaskListId(TaskListIndex)

Default Value

""

Remarks

The unique identifier of the task list.

The TaskListIndex parameter specifies the index of the item in the array. The size of the array is controlled by the TaskListsCount property.

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

Data Type

String

TaskListTitle Property (GoogleTasks Control)

Title of the task list.

Syntax

googletaskscontrol.TaskListTitle(TaskListIndex)[=string]

Default Value

""

Remarks

Title of the task list.

The TaskListIndex parameter specifies the index of the item in the array. The size of the array is controlled by the TaskListsCount property.

This property is not available at design time.

Data Type

String

TaskListUpdated Property (GoogleTasks Control)

Last modification time of the task list (as a RFC 3339 timestamp).

Syntax

googletaskscontrol.TaskListUpdated(TaskListIndex)

Default Value

""

Remarks

Last modification time of the task list (as a RFC 3339 timestamp).

The TaskListIndex parameter specifies the index of the item in the array. The size of the array is controlled by the TaskListsCount property.

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

Data Type

String

TasksCount Property (GoogleTasks Control)

The number of records in the Task arrays.

Syntax

googletaskscontrol.TasksCount[=integer]

Default Value

0

Remarks

This property controls the size of the following arrays:

• TaskCompleted
• TaskDeleted
• TaskDue
• TaskHidden
• TaskId
• TaskJSON
• TaskListId
• TaskListTitle
• TaskListUpdated
• TaskNotes
• TaskParentId
• TaskStatus
• TaskTaskListId
• TaskTitle
• TaskUpdated

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

This property is not available at design time.

Data Type

Integer

TaskCompleted Property (GoogleTasks Control)

Completion date of the task (as a RFC 3339 timestamp).

Syntax

googletaskscontrol.TaskCompleted(TaskIndex)

Default Value

""

Remarks

Completion date of the task (as a RFC 3339 timestamp). This field is omitted if the task has not been completed.

The TaskIndex parameter specifies the index of the item in the array. The size of the array is controlled by the TasksCount property.

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

Data Type

String

TaskDeleted Property (GoogleTasks Control)

Flag indicating whether the task has been deleted.

Syntax

googletaskscontrol.TaskDeleted(TaskIndex)

Default Value

False

Remarks

Flag indicating whether the task has been deleted.

The TaskIndex parameter specifies the index of the item in the array. The size of the array is controlled by the TasksCount property.

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

Data Type

Boolean

TaskDue Property (GoogleTasks Control)

Due date of the task (as a RFC 3339 timestamp).

Syntax

googletaskscontrol.TaskDue(TaskIndex)[=string]

Default Value

""

Remarks

Due date of the task (as a RFC 3339 timestamp). Optional. The due date only records date information; the time portion of the timestamp is discarded when setting the due date. It isn't possible to read or write the time that a task is due via the API.

The TaskIndex parameter specifies the index of the item in the array. The size of the array is controlled by the TasksCount property.

This property is not available at design time.

Data Type

String

TaskHidden Property (GoogleTasks Control)

Flag indicating whether the task is hidden.

Syntax

googletaskscontrol.TaskHidden(TaskIndex)

Default Value

False

Remarks

Flag indicating whether the task is hidden. This is the case if the task had been marked completed when the task list was last cleared

The TaskIndex parameter specifies the index of the item in the array. The size of the array is controlled by the TasksCount property.

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

Data Type

Boolean

TaskId Property (GoogleTasks Control)

Unique identifier for the task.

Syntax

googletaskscontrol.TaskId(TaskIndex)

Default Value

""

Remarks

Unique identifier for the task.

The TaskIndex parameter specifies the index of the item in the array. The size of the array is controlled by the TasksCount property.

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

Data Type

String

TaskJSON Property (GoogleTasks Control)

A JSON representation of the task.

Syntax

googletaskscontrol.TaskJSON(TaskIndex)[=string]

Default Value

""

Remarks

A JSON representation of the task. Change this field to set raw JSON content to send on the next update. Other fields values will be ignored in this case.

The TaskIndex parameter specifies the index of the item in the array. The size of the array is controlled by the TasksCount property.

This property is not available at design time.

Data Type

String

TaskNotes Property (GoogleTasks Control)

Notes describing the task.

Syntax

googletaskscontrol.TaskNotes(TaskIndex)[=string]

Default Value

""

Remarks

Notes describing the task. Tasks assigned from Google Docs cannot have notes. Optional. Maximum length allowed: 8192 characters

The TaskIndex parameter specifies the index of the item in the array. The size of the array is controlled by the TasksCount property.

This property is not available at design time.

Data Type

String

TaskParentId Property (GoogleTasks Control)

String indicating the position of the task among its sibling tasks under the same parent task or at the top level.

Syntax

googletaskscontrol.TaskParentId(TaskIndex)

Default Value

""

Remarks

Parent task identifier. This field is omitted if it is a top-level task. Use the "move" method to move the task under a different parent or to the top level. A parent task can never be an assigned task (from Chat Spaces, Docs).

String indicating the position of the task among its sibling tasks under the same parent task or at the top level. If this string is greater than another task's corresponding position string according to lexicographical ordering, the task is positioned after the other task under the same parent task (or at the top level). Use the "move" method to move the task to another position.

The TaskIndex parameter specifies the index of the item in the array. The size of the array is controlled by the TasksCount property.

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

Data Type

String

TaskStatus Property (GoogleTasks Control)

Status of the task Possible values are: 0 (gtsNeedsAction) Default status when task is created.

Syntax

googletaskscontrol.TaskStatus(TaskIndex)[=integer]

Possible Values

gtsNeedsAction(0), 
gtsCompleted(1)

Default Value

0

Remarks

Status of the task

Possible values are:

The TaskIndex parameter specifies the index of the item in the array. The size of the array is controlled by the TasksCount property.

This property is not available at design time.

Data Type

Integer

TaskTaskListId Property (GoogleTasks Control)

The ID of the task list that contains the task.

Syntax

googletaskscontrol.TaskTaskListId(TaskIndex)

Default Value

""

Remarks

The ID of the task list that contains the task.

The TaskIndex parameter specifies the index of the item in the array. The size of the array is controlled by the TasksCount property.

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

Data Type

String

TaskTitle Property (GoogleTasks Control)

Title of the task.

Syntax

googletaskscontrol.TaskTitle(TaskIndex)[=string]

Default Value

""

Remarks

Title of the task.

The TaskIndex parameter specifies the index of the item in the array. The size of the array is controlled by the TasksCount property.

This property is not available at design time.

Data Type

String

TaskUpdated Property (GoogleTasks Control)

Last modification time of the task (as a RFC 3339 timestamp).

Syntax

googletaskscontrol.TaskUpdated(TaskIndex)

Default Value

""

Remarks

Last modification time of the task (as a RFC 3339 timestamp).

The TaskIndex parameter specifies the index of the item in the array. The size of the array is controlled by the TasksCount property.

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

Data Type

String

Authorize Method (GoogleTasks Control)

Get the authorization string required to access the protected resource.

Syntax

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

ClearTaskList Method (GoogleTasks Control)

Clears all completed tasks from the specified task list. The affected tasks will be marked as 'hidden' and no longer be returned by default when retrieving all tasks for a task list.

Syntax

googletaskscontrol.ClearTaskList TaskListId

Remarks

Calling this method does not update the component's tasks collection. The affected tasks will only be removed once ListTasks is called again.

Example (Clear a task list) //Create tasks gtask.CreateTask("Jimmy's task", mainList.Id); gtask.CreateTask("Beth's task", mainList.Id); gtask.CreateTask("Mark's task", mainList.Id); //Update task status to "Completed" gtask.Tasks[0].Status = TGTStatus.gtsCompleted; gtask.Tasks[1].Status = TGTStatus.gtsCompleted; gtask.Tasks[2].Status = TGTStatus.gtsCompleted; gtask.ClearTaskList(mainList.Id); //clear the task list

Config Method (GoogleTasks Control)

Sets or retrieves a configuration setting.

Syntax

googletaskscontrol.Config ConfigurationString

Remarks

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

These settings are similar in functionality to properties, but they are rarely used. In order to avoid "polluting" the property namespace of the control, access to these internal properties is provided through the Config method.

To set a configuration setting named PROPERTY, you must call Config("PROPERTY=VALUE"), where VALUE is the value of the setting expressed as a string. For boolean values, use the strings "True", "False", "0", "1", "Yes", or "No" (case does not matter).

To read (query) the value of a configuration setting, you must call Config("PROPERTY"). The value will be returned as a string.

CreateTask Method (GoogleTasks Control)

Creates a new task.

Syntax

googletaskscontrol.CreateTask Subject, TaskListId

Remarks

Creates a task with the specified details. The subject parameter defines the title or description of the task, while the taskListId parameter identifies the Task List in which the task will be created.

If you need to set additional properties or customize the task further, use the UpdateTask method after creation to modify attributes like title, due date, notes etc.

Example(Create a new task) gtask.CreateTask("Friday Task", taskListId); gtask.ListTasks(taskListId); gtask.Tasks[0].Title = "Friday task 2.0"; gtask.UpdateTask(0);

CreateTaskList Method (GoogleTasks Control)

Creates a new task list.

Syntax

googletaskscontrol.CreateTaskList Name

Remarks

Creates a new task list with the specified name. The name parameter defines the name of the task list.

The name of the task list can be updated after creation by calling the UpdateTaskList method.

Example(Create a new Task list) gtask.CreateTaskList("October task list"); gtask.ListTaskLists();

DeleteTask Method (GoogleTasks Control)

Deletes a task.

Syntax

googletaskscontrol.DeleteTask TaskListId, Id

Remarks

Deletes a task identified by taskListId and id parameters. taskListId parameter identifies the Task list that the task to be deleted belongs to and Id parameter identifies the task to be deleted. The specified task will be permanently removed. This method also deletes the task from the Tasks collection

DeleteTaskList Method (GoogleTasks Control)

Deletes a task list.

Syntax

googletaskscontrol.DeleteTaskList id

Remarks

Deletes a Task list identified by the id parameter. The Task list and all its associated tasks will be removed, this operation also deletes the Task list from the TaskLists collection.

GetTask Method (GoogleTasks Control)

Retrieves the task by Id.

Syntax

googletaskscontrol.GetTask TaskListId, Id

Remarks

This method retrieves a task specified by its ID and adds the task to the beginning of the Tasks list. If the task already exists in the Tasks collection, it will be removed and then added to the beginning, preventing duplication.

Example: gtask.GetTask(taskListId, taskId); GTTaskItem currentTask = gtask.Tasks[0]; currentTask.Title = "New title"; gtask.UpdateTask(currentTaskIndex);

GetTaskField Method (GoogleTasks Control)

Retrieves the task property value by JSONPath.

Syntax

googletaskscontrol.GetTaskField index, JsonPath

Remarks

This method retrieves a specific field within the task's JSON field. The first parameter, index, represents the index of the task in the Tasks collection from which to retrieve the field. The second parameter, JsonPath, is the JSON path to the field you want to retrieve. Please refer to XPath for more details on how to set the Json path. The method returns a string that represents the value of the specified JSON field. For a full list of the fields a task has/can have, please refer to the official documentation of the Google Tasks API documentation.

Example (Access Fields of a Task)

gtask.GetTaskField(0, "/json/title"); // The title of the task

Interrupt Method (GoogleTasks Control)

Interrupt the current method.

Syntax

googletaskscontrol.Interrupt 

Remarks

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

ListTaskLists Method (GoogleTasks Control)

Lists the task lists.

Syntax

googletaskscontrol.ListTaskLists 

Remarks

List all Task lists associated with the current user. The retrieved Task lists are added to the TaskLists collection, which is cleared before being repopulated with the retrieved data. For each Task list retrieved, the TaskListList event is fired.

ListTasks Method (GoogleTasks Control)

Lists the tasks.

Syntax

googletaskscontrol.ListTasks TaskListId

Remarks

Retrieves a list of tasks from the specified Task list, identified by the taskListId parameter. The retrieved Task lists are added to the Tasks collection, which is cleared before being repopulated with the retrieved data. For each Task list retrieved, the TaskList event is fired.

Reset Method (GoogleTasks Control)

This method will reset the control.

Syntax

googletaskscontrol.Reset 

Remarks

This method will reset the control's properties to their default values.

SendCustomRequest Method (GoogleTasks Control)

Send a custom HTTP request.

Syntax

googletaskscontrol.SendCustomRequest HTTPMethod, URL, PostData

Remarks

This method can be used to send a custom HTTP request to the server.

SetTaskField Method (GoogleTasks Control)

Sets the task field value by JSONPath.

Syntax

googletaskscontrol.SetTaskField index, JsonPath, Value, ValueType

Remarks

This method updates a specific field within the event's JSON representation. The parameters for this method are as follows: the first parameter, index, represents the index of the event in the Tasks collection to be edited. The second parameter, JsonPath, specifies the JSON path to the field you want to set. Please refer to XPath for more details on how to set the Json path. The third parameter, Value, is the value to be assigned to the JSON field. The fourth parameter, ValueType, is the type of the value, which must be one of the defined types:

• 0 (Object)
• 1 (Array)
• 2 (String)
• 3 (Number)
• 4 (Bool)
• 5 (Null)
• 6 (Raw)

Example (Set/Edit Fields of a Task before Updating): // Create a task gtask.CreateTask("Friday task", taskListId); gtask.SetTaskField(0, "/json/notes", "Task postponed", 2); // Update notes field gtask.SetTaskField(0, "/json/title", "Saturday task", 2); // Update title field // Update task gtask.UpdateTask(0);

For a full list of the fields a task has/can have, please refer to the official documentation of the Google Tasks API documentation.

UpdateTask Method (GoogleTasks Control)

Updates a task.

Syntax

googletaskscontrol.UpdateTask index

Remarks

This method allows you to update an existing task. The index parameter specifies the position of the task in the Tasks collection. The method uses this index to take all the data from the specified task and update the corresponding task on the server.

To update a task, edit the desired task fields within the Tasks collection. Then, call the UpdateTask method with the index of the task. Note that changing the JSON data will overwrite the entire task, ignoring other field edits made before setting the JSON.

The GTTaskItem type used in the Tasks collection includes the fields of a task. Refer to the GTTaskItem type for a complete list of fields. If you need to add other fields, you can use the SetTaskField method. For a complete list of fields a task can have, please refer to the Google Tasks API overview

UpdateTaskList Method (GoogleTasks Control)

Updates a task list.

Syntax

googletaskscontrol.UpdateTaskList index

Remarks

This method allows you to update an existing Task list. The index parameter specifies the position of the Task list in the TaskLists collection. The method uses this index to take all the data from the specified Task list and update the corresponding Task list on the server.

To update a Task list, edit the desired fields within the TaskLists collection. Then, call the UpdateTaskList method with the index of the Task list. Note that changing the JSON data will overwrite the entire Task list, ignoring other field edits made before setting the JSON.

The GTTaskList type used in the TaskLists collection includes the fields of a Task list. Refer to the GTTaskList type for a complete list of fields. For a complete list of fields a Task list can have, please refer to the Google Tasks API overview

Error Event (GoogleTasks Control)

Fired when information is available about errors during data delivery.

Syntax

Sub googletaskscontrol_Error(ErrorCode As Integer, Description As String)

Remarks

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

The ErrorCode parameter contains an error code, and the Description parameter contains a textual description of the error. For a list of valid error codes and their descriptions, please refer to the Error Codes section.

Log Event (GoogleTasks Control)

Fired once for each log message.

Syntax

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

Remarks

This event is fired once for each log message generated by the control. The verbosity is controlled by the LogLevel setting.

LogLevel indicates the level of message. Possible values are as follows:

The value 1 (Info) logs basic information, including the URL, HTTP version, and status details.

The value 2 (Verbose) logs additional information about the request and response.

The value 3 (Debug) logs the headers and body for both the request and response, as well as additional debug information (if any).

Message is the log entry.

LogType identifies the type of log entry. Possible values are as follows:

• "Info"
• "RequestHeaders"
• "ResponseHeaders"
• "RequestBody"
• "ResponseBody"
• "ProxyRequest"
• "ProxyResponse"
• "FirewallRequest"
• "FirewallResponse"

SSLServerAuthentication Event (GoogleTasks Control)

Fired after the server presents its certificate to the client.

Syntax

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

Remarks

During this event, the client can decide whether or not to continue with the connection process. The Accept parameter is a recommendation on whether to continue or close the connection. This is just a suggestion: application software must use its own logic to determine whether or not to continue.

When Accept is False, Status shows why the verification failed (otherwise, Status contains the string OK). If it is decided to continue, you can override and accept the certificate by setting the Accept parameter to True.

SSLStatus Event (GoogleTasks Control)

Fired when secure connection progress messages are available.

Syntax

Sub googletaskscontrol_SSLStatus(Message As String)

Remarks

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

TaskList Event (GoogleTasks Control)

Fired when a task is retrieved from the server.

Syntax

Sub googletaskscontrol_TaskList(Id As String, TaskListId As String, Subject As String)

Remarks

The TaskList event is fired for each task retrieved from the server when ListTasks is called. This event provides the task's Id, TaskListId and Subject.

TaskListList Event (GoogleTasks Control)

Fired when a task list is retrieved from the server.

Syntax

Sub googletaskscontrol_TaskListList(Id As String, Name As String)

Remarks

The TaskListList event is fired for each task list retrieved from the server when ListTaskLists is called.

Transfer Event (GoogleTasks Control)

Fired while a document transfers (delivers document).

Syntax

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

Remarks

The Text parameter contains the portion of the document text being received. It is empty if data are being posted to the server.

The BytesTransferred parameter contains the number of bytes transferred in this Direction since the beginning of the document text (excluding HTTP response headers).

The Direction parameter shows whether the client (0) or the server (1) is sending the data.

The PercentDone parameter shows the progress of the transfer in the corresponding direction. If PercentDone can not be calculated the value will be -1.

Note: Events are not re-entrant. Performing time-consuming operations within this event will prevent it from firing again in a timely manner and may affect overall performance.

Config Settings (GoogleTasks Control)

GoogleTasks Config Settings

<firstlevel>
  <one>value</one>
  <two>
    <item>first</item>
    <item>second</item>
  </two>
  <three>value three</three>
</firstlevel>

{
  "firstlevel": {
    "one": "value",
    "two": ["first", "second"],
    "three": "value three"
  }
}

OAuth Config Settings

HTTP Config Settings

TCPClient Config Settings

SSL Config Settings

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

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

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

Socket Config Settings

Base Config Settings

Trappable Errors (GoogleTasks Control)

GoogleTasks Errors