GoogleTasks Component

Properties   Methods   Events   Config Settings   Errors  

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

Syntax

cloudcalendars.GoogleTasks

Remarks

This struct provides an easy to use interface for Google Tasks using version 1 of the GoogleTasks REST API. To use the struct, first set the Authorization property to a valid OAuth token. The Google Tasks struct 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 struct 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 struct has the following defaults:

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

Application Profile

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

To start the authentication and authorization process, the Authorize 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 struct 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 struct 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 struct 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 struct will use an authorization code to get an access token. For this OAuthGrantType the struct 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 struct will parse the authorization code, setting the OAuthAuthorizationCode property, from the redirect. Immediately, the struct will make a request to the token server to exchange the authorization code for an access token. The token server will return an access token and possibly a refresh token. If the OAuthRefreshToken property is set, or a refresh token is cached, then the struct will not launch the browser and use the refresh token in its request to the token server instead of an authorization code.

Example: 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 struct will request the authorization server to get an access token. For this OAuthGrantType the struct 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 struct will parse the access token from the redirect.

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

Web Profile

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 struct 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 component with short descriptions. Click on the links for further details.

Method List

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

Event List

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

Config Settings

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

Authorization Property (GoogleTasks Component)

An OAuth Authorization String.

Syntax

func (obj *GoogleTasks) Authorization() (string, error)
func (obj *GoogleTasks) SetAuthorization(value string) error

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();

Data Type

string

FirewallAutoDetect Property (GoogleTasks Component)

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

Syntax

func (obj *GoogleTasks) FirewallAutoDetect() (bool, error)
func (obj *GoogleTasks) SetFirewallAutoDetect(value bool) error

Default Value

false

Remarks

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

Data Type

bool

FirewallType Property (GoogleTasks Component)

The type of firewall to connect through.

Syntax

func (obj *GoogleTasks) FirewallType() (int32, error)
func (obj *GoogleTasks) SetFirewallType(value int32) error

Possible Values

0   // None
1   // Tunnel
2   // SOCKS4
3   // SOCKS5
10   // SOCKS4A

Default Value

0

Remarks

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

Data Type

int32

FirewallHost Property (GoogleTasks Component)

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

Syntax

func (obj *GoogleTasks) FirewallHost() (string, error)
func (obj *GoogleTasks) SetFirewallHost(value string) error

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

Data Type

string

FirewallPassword Property (GoogleTasks Component)

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

Syntax

func (obj *GoogleTasks) FirewallPassword() (string, error)
func (obj *GoogleTasks) SetFirewallPassword(value string) error

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

Data Type

string

FirewallPort Property (GoogleTasks Component)

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

Syntax

func (obj *GoogleTasks) FirewallPort() (int32, error)
func (obj *GoogleTasks) SetFirewallPort(value int32) error

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

int32

FirewallUser Property (GoogleTasks Component)

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

Syntax

func (obj *GoogleTasks) FirewallUser() (string, error)
func (obj *GoogleTasks) SetFirewallUser(value string) error

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

Data Type

string

ListTasksMarker Property (GoogleTasks Component)

The page marker for listing tasks.

Syntax

func (obj *GoogleTasks) ListTasksMarker() (string, error)
func (obj *GoogleTasks) SetListTasksMarker(value string) error

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

Data Type

string

OAuthAccessToken Property (GoogleTasks Component)

The access token returned by the authorization server.

Syntax

func (obj *GoogleTasks) OAuthAccessToken() (string, error)
func (obj *GoogleTasks) SetOAuthAccessToken(value string) error

Default Value

""

Remarks

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

Data Type

string

OAuthAuthorizationCode Property (GoogleTasks Component)

The authorization code that is exchanged for an access token.

Syntax

func (obj *GoogleTasks) OAuthAuthorizationCode() (string, error)
func (obj *GoogleTasks) SetOAuthAuthorizationCode(value string) error

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.

Data Type

string

OAuthAuthorizationScope Property (GoogleTasks Component)

The scope request or response parameter used during authorization.

Syntax

func (obj *GoogleTasks) OAuthAuthorizationScope() (string, error)
func (obj *GoogleTasks) SetOAuthAuthorizationScope(value string) error

Default Value

""

Remarks

The scope request or response parameter used during authorization.

Data Type

string

OAuthClientId Property (GoogleTasks Component)

The id of the client assigned when registering the application.

Syntax

func (obj *GoogleTasks) OAuthClientId() (string, error)
func (obj *GoogleTasks) SetOAuthClientId(value string) error

Default Value

""

Remarks

The id of the client assigned when registering the application.

Data Type

string

OAuthClientProfile Property (GoogleTasks Component)

The type of client that is requesting authorization.

Syntax

func (obj *GoogleTasks) OAuthClientProfile() (int32, error)
func (obj *GoogleTasks) SetOAuthClientProfile(value int32) error

Possible Values

0   // Application
1   // Web

Default Value

0

Remarks

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

Data Type

int32

OAuthClientSecret Property (GoogleTasks Component)

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

Syntax

func (obj *GoogleTasks) OAuthClientSecret() (string, error)
func (obj *GoogleTasks) SetOAuthClientSecret(value string) error

Default Value

""

Remarks

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

Data Type

string

OAuthGrantType Property (GoogleTasks Component)

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

Syntax

func (obj *GoogleTasks) OAuthGrantType() (int32, error)
func (obj *GoogleTasks) SetOAuthGrantType(value int32) error

Possible Values

0   // AuthorizationCode
1   // Implicit
2   // Password
3   // ClientCredentials

Default Value

0

Remarks

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

Data Type

int32

OAuthRefreshToken Property (GoogleTasks Component)

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

Syntax

func (obj *GoogleTasks) OAuthRefreshToken() (string, error)
func (obj *GoogleTasks) SetOAuthRefreshToken(value string) error

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.

Data Type

string

OAuthRequestRefreshToken Property (GoogleTasks Component)

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

Syntax

func (obj *GoogleTasks) OAuthRequestRefreshToken() (bool, error)
func (obj *GoogleTasks) SetOAuthRequestRefreshToken(value bool) error

Default Value

true

Remarks

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

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

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

Data Type

bool

OAuthReturnURL Property (GoogleTasks Component)

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

Syntax

func (obj *GoogleTasks) OAuthReturnURL() (string, error)
func (obj *GoogleTasks) SetOAuthReturnURL(value string) error

Default Value

""

Remarks

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

Data Type

string

OAuthServerAuthURL Property (GoogleTasks Component)

The URL of the authorization server.

Syntax

func (obj *GoogleTasks) OAuthServerAuthURL() (string, error)
func (obj *GoogleTasks) SetOAuthServerAuthURL(value string) error

Default Value

""

Remarks

The URL of the authorization server.

Data Type

string

OAuthServerTokenURL Property (GoogleTasks Component)

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

Syntax

func (obj *GoogleTasks) OAuthServerTokenURL() (string, error)
func (obj *GoogleTasks) SetOAuthServerTokenURL(value string) error

Default Value

""

Remarks

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

Data Type

string

OAuthTimeout Property (GoogleTasks Component)

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

Syntax

func (obj *GoogleTasks) OAuthTimeout() (int32, error)
func (obj *GoogleTasks) SetOAuthTimeout(value int32) error

Default Value

60

Remarks

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

Data Type

int32

OAuthWebAuthURL Property (GoogleTasks Component)

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

Syntax

func (obj *GoogleTasks) OAuthWebAuthURL() (string, error)

Default Value

""

Remarks

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

This property is read-only.

Data Type

string

ProxyAuthScheme Property (GoogleTasks Component)

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

Syntax

func (obj *GoogleTasks) ProxyAuthScheme() (int32, error)
func (obj *GoogleTasks) SetProxyAuthScheme(value int32) error

Possible Values

0   // Basic
1   // Digest
2   // Proprietary
3   // None
4   // Ntlm
5   // Negotiate

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 struct 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 struct. Look at the configuration file for the struct 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

int32

ProxyAutoDetect Property (GoogleTasks Component)

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

Syntax

func (obj *GoogleTasks) ProxyAutoDetect() (bool, error)
func (obj *GoogleTasks) SetProxyAutoDetect(value bool) error

Default Value

false

Remarks

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

Data Type

bool

ProxyPassword Property (GoogleTasks Component)

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

Syntax

func (obj *GoogleTasks) ProxyPassword() (string, error)
func (obj *GoogleTasks) SetProxyPassword(value string) error

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

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

Syntax

func (obj *GoogleTasks) ProxyPort() (int32, error)
func (obj *GoogleTasks) SetProxyPort(value int32) error

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

int32

ProxyServer Property (GoogleTasks Component)

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

Syntax

func (obj *GoogleTasks) ProxyServer() (string, error)
func (obj *GoogleTasks) SetProxyServer(value string) error

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

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

Syntax

func (obj *GoogleTasks) ProxySSL() (int32, error)
func (obj *GoogleTasks) SetProxySSL(value int32) error

Possible Values

0   // Automatic
1   // Always
2   // Never
3   // Tunnel

Default Value

0

Remarks

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

Data Type

int32

ProxyUser Property (GoogleTasks Component)

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

Syntax

func (obj *GoogleTasks) ProxyUser() (string, error)
func (obj *GoogleTasks) SetProxyUser(value string) error

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

The date on which this certificate becomes valid.

Syntax

func (obj *GoogleTasks) SSLAcceptServerCertEffectiveDate() (string, error)

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

The date on which the certificate expires.

Syntax

func (obj *GoogleTasks) SSLAcceptServerCertExpirationDate() (string, error)

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

A comma-delimited list of extended key usage identifiers.

Syntax

func (obj *GoogleTasks) SSLAcceptServerCertExtendedKeyUsage() (string, error)

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

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

Syntax

func (obj *GoogleTasks) SSLAcceptServerCertFingerprint() (string, error)

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

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

Syntax

func (obj *GoogleTasks) SSLAcceptServerCertFingerprintSHA1() (string, error)

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

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

Syntax

func (obj *GoogleTasks) SSLAcceptServerCertFingerprintSHA256() (string, error)

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

The issuer of the certificate.

Syntax

func (obj *GoogleTasks) SSLAcceptServerCertIssuer() (string, error)

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

The private key of the certificate (if available).

Syntax

func (obj *GoogleTasks) SSLAcceptServerCertPrivateKey() (string, error)

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

Whether a PrivateKey is available for the selected certificate.

Syntax

func (obj *GoogleTasks) SSLAcceptServerCertPrivateKeyAvailable() (bool, error)

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

bool

SSLAcceptServerCertPrivateKeyContainer Property (GoogleTasks Component)

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

Syntax

func (obj *GoogleTasks) SSLAcceptServerCertPrivateKeyContainer() (string, error)

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

The public key of the certificate.

Syntax

func (obj *GoogleTasks) SSLAcceptServerCertPublicKey() (string, error)

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

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

Syntax

func (obj *GoogleTasks) SSLAcceptServerCertPublicKeyAlgorithm() (string, error)

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

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

Syntax

func (obj *GoogleTasks) SSLAcceptServerCertPublicKeyLength() (int32, error)

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

int32

SSLAcceptServerCertSerialNumber Property (GoogleTasks Component)

The serial number of the certificate encoded as a string.

Syntax

func (obj *GoogleTasks) SSLAcceptServerCertSerialNumber() (string, error)

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

The text description of the certificate's signature algorithm.

Syntax

func (obj *GoogleTasks) SSLAcceptServerCertSignatureAlgorithm() (string, error)

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

The name of the certificate store for the client certificate.

Syntax

func (obj *GoogleTasks) SSLAcceptServerCertStore() ([]byte, error)
func (obj *GoogleTasks) SetSSLAcceptServerCertStore(value []byte) error

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

Data Type

[]byte

SSLAcceptServerCertStorePassword Property (GoogleTasks Component)

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

Syntax

func (obj *GoogleTasks) SSLAcceptServerCertStorePassword() (string, error)
func (obj *GoogleTasks) SetSSLAcceptServerCertStorePassword(value string) error

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

The type of certificate store for this certificate.

Syntax

func (obj *GoogleTasks) SSLAcceptServerCertStoreType() (int32, error)
func (obj *GoogleTasks) SetSSLAcceptServerCertStoreType(value int32) error

Possible Values

0   // User
1   // Machine
2   // PFXFile
3   // PFXBlob
4   // JKSFile
5   // JKSBlob
6   // PEMKeyFile
7   // PEMKeyBlob
8   // PublicKeyFile
9   // PublicKeyBlob
10   // SSHPublicKeyBlob
11   // P7BFile
12   // P7BBlob
13   // SSHPublicKeyFile
14   // PPKFile
15   // PPKBlob
16   // XMLFile
17   // XMLBlob
18   // JWKFile
19   // JWKBlob
20   // SecurityKey
21   // BCFKSFile
22   // BCFKSBlob
23   // PKCS11
99   // Auto

Default Value

0

Remarks

The type of certificate store for this certificate.

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

Data Type

int32

SSLAcceptServerCertSubjectAltNames Property (GoogleTasks Component)

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

Syntax

func (obj *GoogleTasks) SSLAcceptServerCertSubjectAltNames() (string, error)

Default Value

""

Remarks

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

This property is read-only.

Data Type

string

SSLAcceptServerCertThumbprintMD5 Property (GoogleTasks Component)

The MD5 hash of the certificate.

Syntax

func (obj *GoogleTasks) SSLAcceptServerCertThumbprintMD5() (string, error)

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

The SHA-1 hash of the certificate.

Syntax

func (obj *GoogleTasks) SSLAcceptServerCertThumbprintSHA1() (string, error)

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

The SHA-256 hash of the certificate.

Syntax

func (obj *GoogleTasks) SSLAcceptServerCertThumbprintSHA256() (string, error)

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

The text description of UsageFlags .

Syntax

func (obj *GoogleTasks) SSLAcceptServerCertUsage() (string, error)

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

The flags that show intended use for the certificate.

Syntax

func (obj *GoogleTasks) SSLAcceptServerCertUsageFlags() (int32, error)

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

int32

SSLAcceptServerCertVersion Property (GoogleTasks Component)

The certificate's version number.

Syntax

func (obj *GoogleTasks) SSLAcceptServerCertVersion() (string, error)

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

The subject of the certificate used for client authentication.

Syntax

func (obj *GoogleTasks) SSLAcceptServerCertSubject() (string, error)
func (obj *GoogleTasks) SetSSLAcceptServerCertSubject(value string) error

Default Value

""

Remarks

The subject of the certificate used for client authentication.

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

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

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

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

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

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

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

Data Type

string

SSLAcceptServerCertEncoded Property (GoogleTasks Component)

The certificate (PEM/Base64 encoded).

Syntax

func (obj *GoogleTasks) SSLAcceptServerCertEncoded() ([]byte, error)
func (obj *GoogleTasks) SetSSLAcceptServerCertEncoded(value []byte) error

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.

Data Type

[]byte

SSLCertEffectiveDate Property (GoogleTasks Component)

The date on which this certificate becomes valid.

Syntax

func (obj *GoogleTasks) SSLCertEffectiveDate() (string, error)

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

The date on which the certificate expires.

Syntax

func (obj *GoogleTasks) SSLCertExpirationDate() (string, error)

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

A comma-delimited list of extended key usage identifiers.

Syntax

func (obj *GoogleTasks) SSLCertExtendedKeyUsage() (string, error)

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

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

Syntax

func (obj *GoogleTasks) SSLCertFingerprint() (string, error)

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

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

Syntax

func (obj *GoogleTasks) SSLCertFingerprintSHA1() (string, error)

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

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

Syntax

func (obj *GoogleTasks) SSLCertFingerprintSHA256() (string, error)

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

The issuer of the certificate.

Syntax

func (obj *GoogleTasks) SSLCertIssuer() (string, error)

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

The private key of the certificate (if available).

Syntax

func (obj *GoogleTasks) SSLCertPrivateKey() (string, error)

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

Whether a PrivateKey is available for the selected certificate.

Syntax

func (obj *GoogleTasks) SSLCertPrivateKeyAvailable() (bool, error)

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

bool

SSLCertPrivateKeyContainer Property (GoogleTasks Component)

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

Syntax

func (obj *GoogleTasks) SSLCertPrivateKeyContainer() (string, error)

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

The public key of the certificate.

Syntax

func (obj *GoogleTasks) SSLCertPublicKey() (string, error)

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

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

Syntax

func (obj *GoogleTasks) SSLCertPublicKeyAlgorithm() (string, error)

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

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

Syntax

func (obj *GoogleTasks) SSLCertPublicKeyLength() (int32, error)

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

int32

SSLCertSerialNumber Property (GoogleTasks Component)

The serial number of the certificate encoded as a string.

Syntax

func (obj *GoogleTasks) SSLCertSerialNumber() (string, error)

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

The text description of the certificate's signature algorithm.

Syntax

func (obj *GoogleTasks) SSLCertSignatureAlgorithm() (string, error)

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

The name of the certificate store for the client certificate.

Syntax

func (obj *GoogleTasks) SSLCertStore() ([]byte, error)
func (obj *GoogleTasks) SetSSLCertStore(value []byte) error

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

Data Type

[]byte

SSLCertStorePassword Property (GoogleTasks Component)

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

Syntax

func (obj *GoogleTasks) SSLCertStorePassword() (string, error)
func (obj *GoogleTasks) SetSSLCertStorePassword(value string) error

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

The type of certificate store for this certificate.

Syntax

func (obj *GoogleTasks) SSLCertStoreType() (int32, error)
func (obj *GoogleTasks) SetSSLCertStoreType(value int32) error

Possible Values

0   // User
1   // Machine
2   // PFXFile
3   // PFXBlob
4   // JKSFile
5   // JKSBlob
6   // PEMKeyFile
7   // PEMKeyBlob
8   // PublicKeyFile
9   // PublicKeyBlob
10   // SSHPublicKeyBlob
11   // P7BFile
12   // P7BBlob
13   // SSHPublicKeyFile
14   // PPKFile
15   // PPKBlob
16   // XMLFile
17   // XMLBlob
18   // JWKFile
19   // JWKBlob
20   // SecurityKey
21   // BCFKSFile
22   // BCFKSBlob
23   // PKCS11
99   // Auto

Default Value

0

Remarks

The type of certificate store for this certificate.

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

Data Type

int32

SSLCertSubjectAltNames Property (GoogleTasks Component)

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

Syntax

func (obj *GoogleTasks) SSLCertSubjectAltNames() (string, error)

Default Value

""

Remarks

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

This property is read-only.

Data Type

string

SSLCertThumbprintMD5 Property (GoogleTasks Component)

The MD5 hash of the certificate.

Syntax

func (obj *GoogleTasks) SSLCertThumbprintMD5() (string, error)

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

The SHA-1 hash of the certificate.

Syntax

func (obj *GoogleTasks) SSLCertThumbprintSHA1() (string, error)

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

The SHA-256 hash of the certificate.

Syntax

func (obj *GoogleTasks) SSLCertThumbprintSHA256() (string, error)

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

The text description of UsageFlags .

Syntax

func (obj *GoogleTasks) SSLCertUsage() (string, error)

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

The flags that show intended use for the certificate.

Syntax

func (obj *GoogleTasks) SSLCertUsageFlags() (int32, error)

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

int32

SSLCertVersion Property (GoogleTasks Component)

The certificate's version number.

Syntax

func (obj *GoogleTasks) SSLCertVersion() (string, error)

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

The subject of the certificate used for client authentication.

Syntax

func (obj *GoogleTasks) SSLCertSubject() (string, error)
func (obj *GoogleTasks) SetSSLCertSubject(value string) error

Default Value

""

Remarks

The subject of the certificate used for client authentication.

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

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

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

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

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

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

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

Data Type

string

SSLCertEncoded Property (GoogleTasks Component)

The certificate (PEM/Base64 encoded).

Syntax

func (obj *GoogleTasks) SSLCertEncoded() ([]byte, error)
func (obj *GoogleTasks) SetSSLCertEncoded(value []byte) error

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.

Data Type

[]byte

SSLProvider Property (GoogleTasks Component)

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

Syntax

func (obj *GoogleTasks) SSLProvider() (int32, error)
func (obj *GoogleTasks) SetSSLProvider(value int32) error

Possible Values

0   // Automatic
1   // Platform
2   // Internal

Default Value

0

Remarks

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

Possible values are as follows:

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

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

Data Type

int32

SSLServerCertEffectiveDate Property (GoogleTasks Component)

The date on which this certificate becomes valid.

Syntax

func (obj *GoogleTasks) SSLServerCertEffectiveDate() (string, error)

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

The date on which the certificate expires.

Syntax

func (obj *GoogleTasks) SSLServerCertExpirationDate() (string, error)

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

A comma-delimited list of extended key usage identifiers.

Syntax

func (obj *GoogleTasks) SSLServerCertExtendedKeyUsage() (string, error)

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

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

Syntax

func (obj *GoogleTasks) SSLServerCertFingerprint() (string, error)

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

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

Syntax

func (obj *GoogleTasks) SSLServerCertFingerprintSHA1() (string, error)

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

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

Syntax

func (obj *GoogleTasks) SSLServerCertFingerprintSHA256() (string, error)

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

The issuer of the certificate.

Syntax

func (obj *GoogleTasks) SSLServerCertIssuer() (string, error)

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

The private key of the certificate (if available).

Syntax

func (obj *GoogleTasks) SSLServerCertPrivateKey() (string, error)

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

Whether a PrivateKey is available for the selected certificate.

Syntax

func (obj *GoogleTasks) SSLServerCertPrivateKeyAvailable() (bool, error)

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

bool

SSLServerCertPrivateKeyContainer Property (GoogleTasks Component)

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

Syntax

func (obj *GoogleTasks) SSLServerCertPrivateKeyContainer() (string, error)

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

The public key of the certificate.

Syntax

func (obj *GoogleTasks) SSLServerCertPublicKey() (string, error)

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

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

Syntax

func (obj *GoogleTasks) SSLServerCertPublicKeyAlgorithm() (string, error)

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

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

Syntax

func (obj *GoogleTasks) SSLServerCertPublicKeyLength() (int32, error)

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

int32

SSLServerCertSerialNumber Property (GoogleTasks Component)

The serial number of the certificate encoded as a string.

Syntax

func (obj *GoogleTasks) SSLServerCertSerialNumber() (string, error)

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

The text description of the certificate's signature algorithm.

Syntax

func (obj *GoogleTasks) SSLServerCertSignatureAlgorithm() (string, error)

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

The name of the certificate store for the client certificate.

Syntax

func (obj *GoogleTasks) SSLServerCertStore() ([]byte, error)

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

This property is read-only.

Data Type

[]byte

SSLServerCertStorePassword Property (GoogleTasks Component)

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

Syntax

func (obj *GoogleTasks) SSLServerCertStorePassword() (string, error)

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

The type of certificate store for this certificate.

Syntax

func (obj *GoogleTasks) SSLServerCertStoreType() (int32, error)

Possible Values

0   // User
1   // Machine
2   // PFXFile
3   // PFXBlob
4   // JKSFile
5   // JKSBlob
6   // PEMKeyFile
7   // PEMKeyBlob
8   // PublicKeyFile
9   // PublicKeyBlob
10   // SSHPublicKeyBlob
11   // P7BFile
12   // P7BBlob
13   // SSHPublicKeyFile
14   // PPKFile
15   // PPKBlob
16   // XMLFile
17   // XMLBlob
18   // JWKFile
19   // JWKBlob
20   // SecurityKey
21   // BCFKSFile
22   // BCFKSBlob
23   // PKCS11
99   // Auto

Default Value

0

Remarks

The type of certificate store for this certificate.

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

This property is read-only.

Data Type

int32

SSLServerCertSubjectAltNames Property (GoogleTasks Component)

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

Syntax

func (obj *GoogleTasks) SSLServerCertSubjectAltNames() (string, error)

Default Value

""

Remarks

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

This property is read-only.

Data Type

string

SSLServerCertThumbprintMD5 Property (GoogleTasks Component)

The MD5 hash of the certificate.

Syntax

func (obj *GoogleTasks) SSLServerCertThumbprintMD5() (string, error)

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

The SHA-1 hash of the certificate.

Syntax

func (obj *GoogleTasks) SSLServerCertThumbprintSHA1() (string, error)

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

The SHA-256 hash of the certificate.

Syntax

func (obj *GoogleTasks) SSLServerCertThumbprintSHA256() (string, error)

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

The text description of UsageFlags .

Syntax

func (obj *GoogleTasks) SSLServerCertUsage() (string, error)

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

The flags that show intended use for the certificate.

Syntax

func (obj *GoogleTasks) SSLServerCertUsageFlags() (int32, error)

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

int32

SSLServerCertVersion Property (GoogleTasks Component)

The certificate's version number.

Syntax

func (obj *GoogleTasks) SSLServerCertVersion() (string, error)

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

The subject of the certificate used for client authentication.

Syntax

func (obj *GoogleTasks) SSLServerCertSubject() (string, error)

Default Value

""

Remarks

The subject of the certificate used for client authentication.

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

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

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

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

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

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

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

This property is read-only.

Data Type

string

SSLServerCertEncoded Property (GoogleTasks Component)

The certificate (PEM/Base64 encoded).

Syntax

func (obj *GoogleTasks) SSLServerCertEncoded() ([]byte, error)

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.

This property is read-only.

Data Type

[]byte

TaskListsCount Property (GoogleTasks Component)

The number of records in the TaskList arrays.

Syntax

func (obj *GoogleTasks) TaskListsCount() (int32, error)
func (obj *GoogleTasks) SetTaskListsCount(value int32) error

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.

Data Type

int32

TaskListId Property (GoogleTasks Component)

The unique identifier of the task list.

Syntax

func (obj *GoogleTasks) TaskListId(TaskListIndex int32) (string, error)

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.

Data Type

string

TaskListTitle Property (GoogleTasks Component)

Title of the task list.

Syntax

func (obj *GoogleTasks) TaskListTitle(TaskListIndex int32) (string, error)
func (obj *GoogleTasks) SetTaskListTitle(TaskListIndex int32, value string) error

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.

Data Type

string

TaskListUpdated Property (GoogleTasks Component)

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

Syntax

func (obj *GoogleTasks) TaskListUpdated(TaskListIndex int32) (string, error)

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.

Data Type

string

TasksCount Property (GoogleTasks Component)

The number of records in the Task arrays.

Syntax

func (obj *GoogleTasks) TasksCount() (int32, error)
func (obj *GoogleTasks) SetTasksCount(value int32) error

Default Value

0

Remarks

This property controls the size of the following arrays:

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

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

Data Type

int32

TaskCompleted Property (GoogleTasks Component)

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

Syntax

func (obj *GoogleTasks) TaskCompleted(TaskIndex int32) (string, error)

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.

Data Type

string

TaskDeleted Property (GoogleTasks Component)

Flag indicating whether the task has been deleted.

Syntax

func (obj *GoogleTasks) TaskDeleted(TaskIndex int32) (bool, error)

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.

Data Type

bool

TaskDue Property (GoogleTasks Component)

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

Syntax

func (obj *GoogleTasks) TaskDue(TaskIndex int32) (string, error)
func (obj *GoogleTasks) SetTaskDue(TaskIndex int32, value string) error

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.

Data Type

string

TaskHidden Property (GoogleTasks Component)

Flag indicating whether the task is hidden.

Syntax

func (obj *GoogleTasks) TaskHidden(TaskIndex int32) (bool, error)

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.

Data Type

bool

TaskId Property (GoogleTasks Component)

Unique identifier for the task.

Syntax

func (obj *GoogleTasks) TaskId(TaskIndex int32) (string, error)

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.

Data Type

string

TaskJSON Property (GoogleTasks Component)

A JSON representation of the task.

Syntax

func (obj *GoogleTasks) TaskJSON(TaskIndex int32) (string, error)
func (obj *GoogleTasks) SetTaskJSON(TaskIndex int32, value string) error

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.

Data Type

string

TaskNotes Property (GoogleTasks Component)

Notes describing the task.

Syntax

func (obj *GoogleTasks) TaskNotes(TaskIndex int32) (string, error)
func (obj *GoogleTasks) SetTaskNotes(TaskIndex int32, value string) error

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.

Data Type

string

TaskParentId Property (GoogleTasks Component)

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

Syntax

func (obj *GoogleTasks) TaskParentId(TaskIndex int32) (string, error)

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.

Data Type

string

TaskParentTaskListId Property (GoogleTasks Component)

The ID of the task list that contains the task.

Syntax

func (obj *GoogleTasks) TaskParentTaskListId(TaskIndex int32) (string, error)

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.

Data Type

string

TaskStatus Property (GoogleTasks Component)

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

Syntax

func (obj *GoogleTasks) TaskStatus(TaskIndex int32) (int32, error)
func (obj *GoogleTasks) SetTaskStatus(TaskIndex int32, value int32) error

Possible Values

0   // NeedsAction
1   // Completed

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.

Data Type

int32

TaskTitle Property (GoogleTasks Component)

Title of the task.

Syntax

func (obj *GoogleTasks) TaskTitle(TaskIndex int32) (string, error)
func (obj *GoogleTasks) SetTaskTitle(TaskIndex int32, value string) error

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.

Data Type

string

TaskUpdated Property (GoogleTasks Component)

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

Syntax

func (obj *GoogleTasks) TaskUpdated(TaskIndex int32) (string, error)

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.

Data Type

string

Authorize Method (GoogleTasks Component)

Get the authorization string required to access the protected resource.

Syntax

func (obj *GoogleTasks) Authorize() error

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

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

func (obj *GoogleTasks) ClearTaskList(TaskListId string) error

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

Sets or retrieves a configuration setting.

Syntax

func (obj *GoogleTasks) Config(ConfigurationString string) (string, error)

Remarks

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

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

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

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

CreateTask Method (GoogleTasks Component)

Creates a new task.

Syntax

func (obj *GoogleTasks) CreateTask(Subject string, TaskListId string) error

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

Creates a new task list.

Syntax

func (obj *GoogleTasks) CreateTaskList(Name string) error

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

Deletes a task.

Syntax

func (obj *GoogleTasks) DeleteTask(TaskListId string, Id string) error

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

Deletes a task list.

Syntax

func (obj *GoogleTasks) DeleteTaskList(id string) error

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

Retrieves the task by Id.

Syntax

func (obj *GoogleTasks) GetTask(TaskListId string, Id string) error

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

Retrieves the task property value by JSONPath.

Syntax

func (obj *GoogleTasks) GetTaskField(index int32, JsonPath string) (string, error)

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

Interrupt the current method.

Syntax

func (obj *GoogleTasks) Interrupt() error

Remarks

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

ListTaskLists Method (GoogleTasks Component)

Lists the task lists.

Syntax

func (obj *GoogleTasks) ListTaskLists() error

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

Lists the tasks.

Syntax

func (obj *GoogleTasks) ListTasks(TaskListId string) error

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

This method will reset the class.

Syntax

func (obj *GoogleTasks) Reset() error

Remarks

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

SendCustomRequest Method (GoogleTasks Component)

Send a custom HTTP request.

Syntax

func (obj *GoogleTasks) SendCustomRequest(HTTPMethod string, URL string, PostData string) error

Remarks

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

SetTaskField Method (GoogleTasks Component)

Sets the task field value by JSONPath.

Syntax

func (obj *GoogleTasks) SetTaskField(index int32, JsonPath string, Value string, ValueType int32) error

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

Updates a task.

Syntax

func (obj *GoogleTasks) UpdateTask(index int32) error

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

Updates a task list.

Syntax

func (obj *GoogleTasks) UpdateTaskList(index int32) error

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

Fired when information is available about errors during data delivery.

Syntax

// GoogleTasksErrorEventArgs carries the GoogleTasks Error event's parameters.
type GoogleTasksErrorEventArgs struct {...}

func (args *GoogleTasksErrorEventArgs) ErrorCode() int32
func (args *GoogleTasksErrorEventArgs) Description() string
// GoogleTasksErrorEvent defines the signature of the GoogleTasks Error event's handler function.
type GoogleTasksErrorEvent func(sender *GoogleTasks, args *GoogleTasksErrorEventArgs)

func (obj *GoogleTasks) GetOnErrorHandler() GoogleTasksErrorEvent
func (obj *GoogleTasks) SetOnErrorHandler(handlerFunc GoogleTasksErrorEvent)

Remarks

The Error event is fired in case of exceptional conditions during message processing. Normally the struct 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 Component)

Fired once for each log message.

Syntax

// GoogleTasksLogEventArgs carries the GoogleTasks Log event's parameters.
type GoogleTasksLogEventArgs struct {...}

func (args *GoogleTasksLogEventArgs) LogLevel() int32
func (args *GoogleTasksLogEventArgs) Message() string
func (args *GoogleTasksLogEventArgs) LogType() string
// GoogleTasksLogEvent defines the signature of the GoogleTasks Log event's handler function.
type GoogleTasksLogEvent func(sender *GoogleTasks, args *GoogleTasksLogEventArgs)

func (obj *GoogleTasks) GetOnLogHandler() GoogleTasksLogEvent
func (obj *GoogleTasks) SetOnLogHandler(handlerFunc GoogleTasksLogEvent)

Remarks

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

Fired after the server presents its certificate to the client.

Syntax

// GoogleTasksSSLServerAuthenticationEventArgs carries the GoogleTasks SSLServerAuthentication event's parameters.
type GoogleTasksSSLServerAuthenticationEventArgs struct {...}

func (args *GoogleTasksSSLServerAuthenticationEventArgs) CertEncoded() []byte
func (args *GoogleTasksSSLServerAuthenticationEventArgs) CertSubject() string
func (args *GoogleTasksSSLServerAuthenticationEventArgs) CertIssuer() string
func (args *GoogleTasksSSLServerAuthenticationEventArgs) Status() string
func (args *GoogleTasksSSLServerAuthenticationEventArgs) Accept() bool
func (args *GoogleTasksSSLServerAuthenticationEventArgs) SetAccept(value bool)

// GoogleTasksSSLServerAuthenticationEvent defines the signature of the GoogleTasks SSLServerAuthentication event's handler function.
type GoogleTasksSSLServerAuthenticationEvent func(sender *GoogleTasks, args *GoogleTasksSSLServerAuthenticationEventArgs)

func (obj *GoogleTasks) GetOnSSLServerAuthenticationHandler() GoogleTasksSSLServerAuthenticationEvent
func (obj *GoogleTasks) SetOnSSLServerAuthenticationHandler(handlerFunc GoogleTasksSSLServerAuthenticationEvent)

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

Fired when secure connection progress messages are available.

Syntax

// GoogleTasksSSLStatusEventArgs carries the GoogleTasks SSLStatus event's parameters.
type GoogleTasksSSLStatusEventArgs struct {...}

func (args *GoogleTasksSSLStatusEventArgs) Message() string
// GoogleTasksSSLStatusEvent defines the signature of the GoogleTasks SSLStatus event's handler function.
type GoogleTasksSSLStatusEvent func(sender *GoogleTasks, args *GoogleTasksSSLStatusEventArgs)

func (obj *GoogleTasks) GetOnSSLStatusHandler() GoogleTasksSSLStatusEvent
func (obj *GoogleTasks) SetOnSSLStatusHandler(handlerFunc GoogleTasksSSLStatusEvent)

Remarks

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

TaskList Event (GoogleTasks Component)

Fired when a task is retrieved from the server.

Syntax

// GoogleTasksTaskListEventArgs carries the GoogleTasks TaskList event's parameters.
type GoogleTasksTaskListEventArgs struct {...}

func (args *GoogleTasksTaskListEventArgs) Id() string
func (args *GoogleTasksTaskListEventArgs) TaskListId() string
func (args *GoogleTasksTaskListEventArgs) Subject() string
// GoogleTasksTaskListEvent defines the signature of the GoogleTasks TaskList event's handler function.
type GoogleTasksTaskListEvent func(sender *GoogleTasks, args *GoogleTasksTaskListEventArgs)

func (obj *GoogleTasks) GetOnTaskListHandler() GoogleTasksTaskListEvent
func (obj *GoogleTasks) SetOnTaskListHandler(handlerFunc GoogleTasksTaskListEvent)

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

Fired when a task list is retrieved from the server.

Syntax

// GoogleTasksTaskListListEventArgs carries the GoogleTasks TaskListList event's parameters.
type GoogleTasksTaskListListEventArgs struct {...}

func (args *GoogleTasksTaskListListEventArgs) Id() string
func (args *GoogleTasksTaskListListEventArgs) Name() string
// GoogleTasksTaskListListEvent defines the signature of the GoogleTasks TaskListList event's handler function.
type GoogleTasksTaskListListEvent func(sender *GoogleTasks, args *GoogleTasksTaskListListEventArgs)

func (obj *GoogleTasks) GetOnTaskListListHandler() GoogleTasksTaskListListEvent
func (obj *GoogleTasks) SetOnTaskListListHandler(handlerFunc GoogleTasksTaskListListEvent)

Remarks

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

Transfer Event (GoogleTasks Component)

Fired while a document transfers (delivers document).

Syntax

// GoogleTasksTransferEventArgs carries the GoogleTasks Transfer event's parameters.
type GoogleTasksTransferEventArgs struct {...}

func (args *GoogleTasksTransferEventArgs) Direction() int32
func (args *GoogleTasksTransferEventArgs) BytesTransferred() int64
func (args *GoogleTasksTransferEventArgs) PercentDone() int32
func (args *GoogleTasksTransferEventArgs) Text() []byte
// GoogleTasksTransferEvent defines the signature of the GoogleTasks Transfer event's handler function.
type GoogleTasksTransferEvent func(sender *GoogleTasks, args *GoogleTasksTransferEventArgs)

func (obj *GoogleTasks) GetOnTransferHandler() GoogleTasksTransferEvent
func (obj *GoogleTasks) SetOnTransferHandler(handlerFunc GoogleTasksTransferEvent)

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

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

GoogleTasks Errors