GoogleCalendars Component

Properties   Methods   Events   Config Settings   Errors  

The GoogleCalendars component provides an easy way to manage calendars in Google Calendars. The component includes support for creating, listing, and managing both calendars and events.

Syntax

TccGoogleCalendars

Remarks

This component provides an easy to use interface for Google Calendars using version 3 of the GoogleCalendars REST API. To use the component, first set the Authorization property to a valid OAuth token. The GoogleCalendars component can be used for creating new calendars, retrieving, deleting and updating existing ones; and several other functionalities supported by the Google Calendar API.

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

The component has the following defaults:

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

Application Profile

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

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

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

Authorization Code

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

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

Implicit

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

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

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

Web Profile

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 component to ignore the values set in the OAuth property.

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

Creating a Calendar

To create a calendar using the GoogleCalendars components we make use of the CreateCalendar method. The CreateCalendar method will create a new calendar with a name specified through the Name parameter.

Creating a calendar: gcal.CreateCalendar("My personal Calendar");

After creating a calendar, select the calendar to be edited in the Calendars collection, edit its fields and make a call to the UpdateCalendar method. To edit the newly created calendar select the first calendar in the collection.

Example (Update The First Calendar Of The Collection) // Set properties to update gcal.Calendars[0].Summary = "My personal Calendar 2"; gcal.Calendars[0].Description = "Description"; gcal.UpdateCalendar(0);

Listing Calendars

Information about calendars fetched by the component can be accessed through the Calendars properties. The Calendars properties is populated when the ListCalendars method is called.

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

The calendar page size may also be changed by using the CalendarsPageSize configuration setting.

Creating Events

To create a new event use the CreateEvent method. The newly created event is added at the beginning of the Events properties.

Example (Create a new event in a specific calendar)

gcal.CreateEvent("Friday Meeting", "2024-11-08T16:00:00", "2024-11-08T17:00:00", calID); // calID is the ID of the calendar to which the event will belong to After creating an event with the basic information, select the event to be edited in the Events collection, edit its fields and make a call to the UpdateEvent method. To edit the newly created event select the first event in the collection.

Example (Update The First Event Of The List) // Set properties to update gcal.Events[0].Summary = "Friday Work Meeting"; gcal.Events[0].AttendeesCount = 2; gcal.Events[0].AttendeeIndex = 0; gcal.Events[0].AttendeeEmail = "person1@example.com"; gcal.Events[0].AttendeeComment = "I'll be there"; gcal.Events[0].AttendeeResponseStatus = TGCAttendeeResponseStatus.gcrsAccepted; gcal.Events[0].AttendeeDisplayName = "Attendee1"; gcal.Events[0].AttendeeAdditionalGuests = 1; gcal.Events[0].AttendeeIndex = 1; gcal.Events[0].AttendeeEmail = "person2@example.com"; gcal.Events[0].AttendeeDisplayName = "Attendee2"; gcal.Events[0].AttendeeOptional = true; // Set a reminder 15 minutes before gcal.Events[0].ReminderUseDefault = false; gcal.Events[0].RemindersOverridesCount = 1; gcal.Events[0].RemindersOverrideIndex = 0; gcal.Events[0].RemindersOverrideMethod = TGCRemindersOverrideMethods.gcrmEmail; gcal.Events[0].RemindersOverrideMinutes = 15; gcal.UpdateEvent(0);

Retrieving an Event

Example (Retrieve an Event)

// Retrieve an event by its ID string eventId = "12345"; // Replace with the actual event ID string calendarId = "54321"; gcal.GetEvent(calendarId, eventId); // Access the retrieved event var retrievedEvent = gcal.Events[gcal.Events.Count - 1]; retrievedEvent.Summary; //event name retrievedEvent.StartDateTime; //start dateTime of event retrievedEvent.Description; //description of event gcal.GetEventField(gcal.Events.Count - 1, "/json/summary"); //event name gcal.GetEventField(gcal.Events.Count - 1, "/json/end"); //end dateTime of event

Deleting an Event

To delete an event use the DeleteEvent method, provide the Id of the event and the Id of the calendar as the argument. The event will stay in the Events collection until ListEvents method is called again.

Example (Delete Events

// List events and delete all events containing "Meeting" in their name gcal.ListEvents(calID); for (int i = 0; i < gcal.Events.Count; i++) { if (gcal.Events[i].Summary.Contains("Meeting")) { gcal.DeleteEvent(calID, gcal.Events[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 (GoogleCalendars Component)

An OAuth Authorization String.

Syntax

__property String Authorization = { read=FAuthorization, write=FSetAuthorization };

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.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/calendar"; oauth.ClientProfile = OAuthClientProfiles.ocpApplication; oauth.GrantType = OauthGrantTypes.ogtAuthorizationCode; gcal.Authorization = oauth.GetAuthorization();

This property is not available at design time.

Data Type

String

CalendarsCount Property (GoogleCalendars Component)

The number of records in the Calendar arrays.

Syntax

__property int CalendarsCount = { read=FCalendarsCount, write=FSetCalendarsCount };

Default Value

0

Remarks

This property controls the size of the following arrays:

• CalendarBackgroundColor
• CalendarColorId
• CalendarDescription
• CalendarForegroundColor
• CalendarId
• CalendarLocation
• CalendarSummary

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

This property is not available at design time.

Data Type

Integer

CalendarBackgroundColor Property (GoogleCalendars Component)

The main color of the calendar in the hexadecimal format '#0088aa'.

Syntax

__property String CalendarBackgroundColor[int CalendarIndex] = { read=FCalendarBackgroundColor };

Default Value

""

Remarks

The main color of the calendar in the hexadecimal format '#0088aa'. This property supersedes the index-based colorId property. To set or change this property, you need to specify colorRgbFormat=true in the parameters of the insert, update and patch methods.

The CalendarIndex parameter specifies the index of the item in the array. The size of the array is controlled by the CalendarsCount property.

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

Data Type

String

CalendarColorId Property (GoogleCalendars Component)

The color of the calendar.

Syntax

__property String CalendarColorId[int CalendarIndex] = { read=FCalendarColorId };

Default Value

""

Remarks

The color of the calendar. This is an ID referring to an entry in the calendar section of the colors definition.

The CalendarIndex parameter specifies the index of the item in the array. The size of the array is controlled by the CalendarsCount property.

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

Data Type

String

CalendarDescription Property (GoogleCalendars Component)

Description of the calendar.

Syntax

__property String CalendarDescription[int CalendarIndex] = { read=FCalendarDescription, write=FSetCalendarDescription };

Default Value

""

Remarks

Description of the calendar

The CalendarIndex parameter specifies the index of the item in the array. The size of the array is controlled by the CalendarsCount property.

This property is not available at design time.

Data Type

String

CalendarForegroundColor Property (GoogleCalendars Component)

The foreground color of the calendar in the hexadecimal format '#ffffff'.

Syntax

__property String CalendarForegroundColor[int CalendarIndex] = { read=FCalendarForegroundColor };

Default Value

""

Remarks

The foreground color of the calendar in the hexadecimal format '#ffffff'. This property supersedes the index-based colorId property. To set or change this property, you need to specify colorRgbFormat=true in the parameters of the insert, update and patch methods.

The CalendarIndex parameter specifies the index of the item in the array. The size of the array is controlled by the CalendarsCount property.

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

Data Type

String

CalendarId Property (GoogleCalendars Component)

The unique identifier of the calendar.

Syntax

__property String CalendarId[int CalendarIndex] = { read=FCalendarId };

Default Value

""

Remarks

The unique identifier of the calendar.

The CalendarIndex parameter specifies the index of the item in the array. The size of the array is controlled by the CalendarsCount property.

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

Data Type

String

CalendarLocation Property (GoogleCalendars Component)

Geographic location of the calendar as free-form text.

Syntax

__property String CalendarLocation[int CalendarIndex] = { read=FCalendarLocation, write=FSetCalendarLocation };

Default Value

""

Remarks

Geographic location of the calendar as free-form text.

The CalendarIndex parameter specifies the index of the item in the array. The size of the array is controlled by the CalendarsCount property.

This property is not available at design time.

Data Type

String

CalendarSummary Property (GoogleCalendars Component)

Title of the calendar.

Syntax

__property String CalendarSummary[int CalendarIndex] = { read=FCalendarSummary, write=FSetCalendarSummary };

Default Value

""

Remarks

Title of the calendar.

The CalendarIndex parameter specifies the index of the item in the array. The size of the array is controlled by the CalendarsCount property.

This property is not available at design time.

Data Type

String

ColorsCount Property (GoogleCalendars Component)

The number of records in the Color arrays.

Syntax

__property int ColorsCount = { read=FColorsCount };

Default Value

0

Remarks

This property controls the size of the following arrays:

• ColorBackground
• ColorForeground
• ColorKey
• ColorOfEvent

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

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

Data Type

Integer

ColorBackground Property (GoogleCalendars Component)

The background color associated with this color definition.

Syntax

__property String ColorBackground[int ColorIndex] = { read=FColorBackground };

Default Value

""

Remarks

The background color associated with this color definition.

The ColorIndex parameter specifies the index of the item in the array. The size of the array is controlled by the ColorsCount property.

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

Data Type

String

ColorForeground Property (GoogleCalendars Component)

The foreground color associated with this color definition.

Syntax

__property String ColorForeground[int ColorIndex] = { read=FColorForeground };

Default Value

""

Remarks

The foreground color associated with this color definition.

The ColorIndex parameter specifies the index of the item in the array. The size of the array is controlled by the ColorsCount property.

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

Data Type

String

ColorKey Property (GoogleCalendars Component)

The ID of the color definition.

Syntax

__property String ColorKey[int ColorIndex] = { read=FColorKey };

Default Value

""

Remarks

The ID of the color definition

The ColorIndex parameter specifies the index of the item in the array. The size of the array is controlled by the ColorsCount property.

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

Data Type

String

ColorOfEvent Property (GoogleCalendars Component)

Indicates the color for the events, otherwise - for calendars.

Syntax

__property bool ColorOfEvent[int ColorIndex] = { read=FColorOfEvent };

Default Value

False

Remarks

Indicates the color for the events, otherwise - for calendars

The ColorIndex parameter specifies the index of the item in the array. The size of the array is controlled by the ColorsCount property.

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

Data Type

Boolean

EventsCount Property (GoogleCalendars Component)

The number of records in the Event arrays.

Syntax

__property int EventsCount = { read=FEventsCount, write=FSetEventsCount };

Default Value

0

Remarks

This property controls the size of the following arrays:

• EventAttachmentFileId
• EventAttachmentFileUrl
• EventAttachmentIconLink
• EventAttachmentIndex
• EventAttachmentMimeType
• EventAttachmentsCount
• EventAttachmentTitle
• EventAttendeeAdditionalGuests
• EventAttendeeComment
• EventAttendeeDisplayName
• EventAttendeeEmail
• EventAttendeeId
• EventAttendeeIndex
• EventAttendeeOptional
• EventAttendeeOrganizer
• EventAttendeeResource
• EventAttendeeResponseStatus
• EventAttendeesCount
• EventAttendeeSelf
• EventCalendarId
• EventColorId
• EventCreated
• EventDescription
• EventEndDateTime
• EventEndTimeZone
• EventId
• EventJSON
• EventLocation
• EventOriginalStartDateTime
• EventOriginalStartTimeZone
• EventRecurrence
• EventRecurrenceIndex
• EventRecurrencesCount
• EventRecurringEventId
• EventRemindersOverrideIndex
• EventRemindersOverrideMethod
• EventRemindersOverrideMinutes
• EventRemindersOverridesCount
• EventReminderUseDefault
• EventStartDateTime
• EventStartTimeZone
• EventSummary
• EventTransparency
• EventUpdated
• EventVisibility

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

This property is not available at design time.

Data Type

Integer

EventAttachmentFileId Property (GoogleCalendars Component)

ID of the attached file.

Syntax

__property String EventAttachmentFileId[int EventIndex] = { read=FEventAttachmentFileId };

Default Value

""

Remarks

ID of the attached file. Read-only. For Google Drive files, this is the ID of the corresponding Files resource entry in the Drive API

The EventIndex parameter specifies the index of the item in the array. The size of the array is controlled by the EventsCount property.

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

Data Type

String

EventAttachmentFileUrl Property (GoogleCalendars Component)

URL link to the attachment.

Syntax

__property String EventAttachmentFileUrl[int EventIndex] = { read=FEventAttachmentFileUrl, write=FSetEventAttachmentFileUrl };

Default Value

""

Remarks

URL link to the attachment. For adding Google Drive file attachments use the same format as in alternateLink property of the Files resource in the Drive API. Required when adding an attachment Set to empty string or null to delete.

The EventIndex parameter specifies the index of the item in the array. The size of the array is controlled by the EventsCount property.

This property is not available at design time.

Data Type

String

EventAttachmentIconLink Property (GoogleCalendars Component)

URL link to the attachment's icon.

Syntax

__property String EventAttachmentIconLink[int EventIndex] = { read=FEventAttachmentIconLink, write=FSetEventAttachmentIconLink };

Default Value

""

Remarks

URL link to the attachment's icon. This field can only be modified for custom third-party attachments

The EventIndex parameter specifies the index of the item in the array. The size of the array is controlled by the EventsCount property.

This property is not available at design time.

Data Type

String

EventAttachmentIndex Property (GoogleCalendars Component)

Index of attachment to get or set its properties.

Syntax

__property int EventAttachmentIndex[int EventIndex] = { read=FEventAttachmentIndex, write=FSetEventAttachmentIndex };

Default Value

0

Remarks

Index of attachment to get or set its fields.

Example (Adding an attachment to the event) // Setting the attachment fields gcal.Events[0].AttachmentsCount = 1; gcal.Events[0].AttachmentIndex = 0; gcal.Events[0].AttachmentFileUrl = "Your URL"; gcal.Events[0].AttachmentMimeType = ""; // (e.g. text/plain) gcal.Events[0].AttachmentTitle = "Event notes"; //Updating the event gcal.UpdateEvent(0);

The EventIndex parameter specifies the index of the item in the array. The size of the array is controlled by the EventsCount property.

This property is not available at design time.

Data Type

Integer

EventAttachmentMimeType Property (GoogleCalendars Component)

Internet media type (MIME type) of the attachment.

Syntax

__property String EventAttachmentMimeType[int EventIndex] = { read=FEventAttachmentMimeType, write=FSetEventAttachmentMimeType };

Default Value

""

Remarks

Internet media type (MIME type) of the attachment

The EventIndex parameter specifies the index of the item in the array. The size of the array is controlled by the EventsCount property.

This property is not available at design time.

Data Type

String

EventAttachmentsCount Property (GoogleCalendars Component)

Number of file attachments for the event.

Syntax

__property int EventAttachmentsCount[int EventIndex] = { read=FEventAttachmentsCount, write=FSetEventAttachmentsCount };

Default Value

0

Remarks

Number of file attachments for the event

The EventIndex parameter specifies the index of the item in the array. The size of the array is controlled by the EventsCount property.

This property is not available at design time.

Data Type

Integer

EventAttachmentTitle Property (GoogleCalendars Component)

Attachment title.

Syntax

__property String EventAttachmentTitle[int EventIndex] = { read=FEventAttachmentTitle, write=FSetEventAttachmentTitle };

Default Value

""

Remarks

Attachment title

The EventIndex parameter specifies the index of the item in the array. The size of the array is controlled by the EventsCount property.

This property is not available at design time.

Data Type

String

EventAttendeeAdditionalGuests Property (GoogleCalendars Component)

Number of additional guests associated with the current attendee.

Syntax

__property int EventAttendeeAdditionalGuests[int EventIndex] = { read=FEventAttendeeAdditionalGuests, write=FSetEventAttendeeAdditionalGuests };

Default Value

0

Remarks

Number of additional guests associated with the current attendee.

Example

GCalEvent currentEvent = gcal.Events[0]; //retrieve event after creation //Set properties to update currentEvent.Summary = "Picnic"; currentEvent.AttendeesCount = 1; currentEvent.AttendeeIndex = 0; //set index of attendee currentEvent.AttendeeEmail = "example@example.com"; currentEvent.AttendeeComment = "I'll be there"; currentEvent.AttendeeDisplayName = "Attendee1"; currentEvent.AttendeeAdditionalGuests = 1; //set number of additional guests associated with the attendee gcal.UpdateEvent(0); //update the event

The EventIndex parameter specifies the index of the item in the array. The size of the array is controlled by the EventsCount property.

This property is not available at design time.

Data Type

Integer

EventAttendeeComment Property (GoogleCalendars Component)

The attendee's response comment.

Syntax

__property String EventAttendeeComment[int EventIndex] = { read=FEventAttendeeComment, write=FSetEventAttendeeComment };

Default Value

""

Remarks

The attendee's response comment

The EventIndex parameter specifies the index of the item in the array. The size of the array is controlled by the EventsCount property.

This property is not available at design time.

Data Type

String

EventAttendeeDisplayName Property (GoogleCalendars Component)

The attendee's name, if available.

Syntax

__property String EventAttendeeDisplayName[int EventIndex] = { read=FEventAttendeeDisplayName, write=FSetEventAttendeeDisplayName };

Default Value

""

Remarks

The attendee's name, if available

The EventIndex parameter specifies the index of the item in the array. The size of the array is controlled by the EventsCount property.

This property is not available at design time.

Data Type

String

EventAttendeeEmail Property (GoogleCalendars Component)

Attendee email address.

Syntax

__property String EventAttendeeEmail[int EventIndex] = { read=FEventAttendeeEmail, write=FSetEventAttendeeEmail };

Default Value

""

Remarks

Attendee email address. Set to empty string or null to delete.

The EventIndex parameter specifies the index of the item in the array. The size of the array is controlled by the EventsCount property.

This property is not available at design time.

Data Type

String

EventAttendeeId Property (GoogleCalendars Component)

The attendee's Profile ID, if available.

Syntax

__property String EventAttendeeId[int EventIndex] = { read=FEventAttendeeId };

Default Value

""

Remarks

The attendee's Profile ID, if available

The EventIndex parameter specifies the index of the item in the array. The size of the array is controlled by the EventsCount property.

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

Data Type

String

EventAttendeeIndex Property (GoogleCalendars Component)

Index of attendee to get or set its properties.

Syntax

__property int EventAttendeeIndex[int EventIndex] = { read=FEventAttendeeIndex, write=FSetEventAttendeeIndex };

Default Value

0

Remarks

Index of attendee to get or set its fields.

Example GCalEvent currentEvent = gcal.Events[0]; //retrieve event after creation //Set properties to update currentEvent.Summary = "Birthday party"; currentEvent.AttendeesCount = 2; //this event will have 2 attendees //Set the attendee properties for both attendees currentEvent.AttendeeIndex = 0; //set index of attendee currentEvent.AttendeeEmail = "example@example.com"; currentEvent.AttendeeDisplayName = "Attendee1"; currentEvent.AttendeeAdditionalGuests = 1; currentEvent.AttendeeIndex = 1; //set index of attendee currentEvent.AttendeeEmail = "example2@example.com"; currentEvent.AttendeeComment = "Can't wait!"; currentEvent.AttendeeDisplayName = "Attendee2";

The EventIndex parameter specifies the index of the item in the array. The size of the array is controlled by the EventsCount property.

This property is not available at design time.

Data Type

Integer

EventAttendeeOptional Property (GoogleCalendars Component)

Whether this is an optional attendee.

Syntax

__property bool EventAttendeeOptional[int EventIndex] = { read=FEventAttendeeOptional, write=FSetEventAttendeeOptional };

Default Value

False

Remarks

Whether this is an optional attendee

The EventIndex parameter specifies the index of the item in the array. The size of the array is controlled by the EventsCount property.

This property is not available at design time.

Data Type

Boolean

EventAttendeeOrganizer Property (GoogleCalendars Component)

Whether the attendee is the organizer of the event.

Syntax

__property bool EventAttendeeOrganizer[int EventIndex] = { read=FEventAttendeeOrganizer, write=FSetEventAttendeeOrganizer };

Default Value

False

Remarks

Whether the attendee is the organizer of the event

The EventIndex parameter specifies the index of the item in the array. The size of the array is controlled by the EventsCount property.

This property is not available at design time.

Data Type

Boolean

EventAttendeeResource Property (GoogleCalendars Component)

Whether the attendee is a resource.

Syntax

__property bool EventAttendeeResource[int EventIndex] = { read=FEventAttendeeResource, write=FSetEventAttendeeResource };

Default Value

False

Remarks

Whether the attendee is a resource. Can only be set when the attendee is added to the event for the first time. Subsequent modifications are ignored

The EventIndex parameter specifies the index of the item in the array. The size of the array is controlled by the EventsCount property.

This property is not available at design time.

Data Type

Boolean

EventAttendeeResponseStatus Property (GoogleCalendars Component)

The attendee's response status.

Syntax

__property TccGoogleCalendarsEventAttendeeResponseStatus EventAttendeeResponseStatus[int EventIndex] = { read=FEventAttendeeResponseStatus, write=FSetEventAttendeeResponseStatus };

enum TccGoogleCalendarsEventAttendeeResponseStatus {
  gcrsNeedsAction=0,
  gcrsDeclined=1,
  gcrsTentative=2,
  gcrsAccepted=3
};

Default Value

gcrsNeedsAction

Remarks

The attendee's response status.

Possible values are:

The EventIndex parameter specifies the index of the item in the array. The size of the array is controlled by the EventsCount property.

This property is not available at design time.

Data Type

Integer

EventAttendeesCount Property (GoogleCalendars Component)

When retrieving events, it indicates the number of attendees linked to the event.

Syntax

__property int EventAttendeesCount[int EventIndex] = { read=FEventAttendeesCount, write=FSetEventAttendeesCount };

Default Value

0

Remarks

When retrieving events, it indicates the number of attendees linked to the event. When updating an event, this property is set to the number of attendees the event will have.

The EventIndex parameter specifies the index of the item in the array. The size of the array is controlled by the EventsCount property.

This property is not available at design time.

Data Type

Integer

EventAttendeeSelf Property (GoogleCalendars Component)

Whether this entry represents the calendar on which this copy of the event appears.

Syntax

__property bool EventAttendeeSelf[int EventIndex] = { read=FEventAttendeeSelf };

Default Value

False

Remarks

Whether this entry represents the calendar on which this copy of the event appears. Read-only

The EventIndex parameter specifies the index of the item in the array. The size of the array is controlled by the EventsCount property.

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

Data Type

Boolean

EventCalendarId Property (GoogleCalendars Component)

The ID of the calendar that contains the event.

Syntax

__property String EventCalendarId[int EventIndex] = { read=FEventCalendarId };

Default Value

""

Remarks

The ID of the calendar that contains the event.

The EventIndex parameter specifies the index of the item in the array. The size of the array is controlled by the EventsCount property.

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

Data Type

String

EventColorId Property (GoogleCalendars Component)

The color of the event.

Syntax

__property String EventColorId[int EventIndex] = { read=FEventColorId, write=FSetEventColorId };

Default Value

""

Remarks

The color of the event. This is an ID referring to an entry in the event section of the colors definition.

The EventIndex parameter specifies the index of the item in the array. The size of the array is controlled by the EventsCount property.

This property is not available at design time.

Data Type

String

EventCreated Property (GoogleCalendars Component)

Creation time of the event (as a RFC3339 timestamp).

Syntax

__property String EventCreated[int EventIndex] = { read=FEventCreated };

Default Value

""

Remarks

Creation time of the event (as a RFC3339 timestamp). Read-only.

The EventIndex parameter specifies the index of the item in the array. The size of the array is controlled by the EventsCount property.

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

Data Type

String

EventDescription Property (GoogleCalendars Component)

Description of the event.

Syntax

__property String EventDescription[int EventIndex] = { read=FEventDescription, write=FSetEventDescription };

Default Value

""

Remarks

Description of the event. Can contain HTML.

The EventIndex parameter specifies the index of the item in the array. The size of the array is controlled by the EventsCount property.

This property is not available at design time.

Data Type

String

EventEndDateTime Property (GoogleCalendars Component)

The date, in the format 'yyyy-mm-dd', if this is an all-day event.

Syntax

__property String EventEndDateTime[int EventIndex] = { read=FEventEndDateTime, write=FSetEventEndDateTime };

Default Value

""

Remarks

The date, in the format 'yyyy-mm-dd', if this is an all-day event. The time, as a combined date-time value (formatted according to RFC3339). A time zone offset is required unless a time zone is explicitly specified in EndTimeZone.

The EventIndex parameter specifies the index of the item in the array. The size of the array is controlled by the EventsCount property.

This property is not available at design time.

Data Type

String

EventEndTimeZone Property (GoogleCalendars Component)

The time zone in which the time is specified.

Syntax

__property String EventEndTimeZone[int EventIndex] = { read=FEventEndTimeZone, write=FSetEventEndTimeZone };

Default Value

""

Remarks

The time zone in which the time is specified. (Formatted as an IANA Time Zone Database name, e.g. "Europe/Zurich".) For recurring events this field is required and specifies the time zone in which the recurrence is expanded. For single events this field is optional and indicates a custom time zone for the event end.

The EventIndex parameter specifies the index of the item in the array. The size of the array is controlled by the EventsCount property.

This property is not available at design time.

Data Type

String

EventId Property (GoogleCalendars Component)

Unique identifier for the event.

Syntax

__property String EventId[int EventIndex] = { read=FEventId };

Default Value

""

Remarks

Unique identifier for the event.

The EventIndex parameter specifies the index of the item in the array. The size of the array is controlled by the EventsCount property.

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

Data Type

String

EventJSON Property (GoogleCalendars Component)

A JSON representation of the event.

Syntax

__property String EventJSON[int EventIndex] = { read=FEventJSON, write=FSetEventJSON };

Default Value

""

Remarks

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

The EventIndex parameter specifies the index of the item in the array. The size of the array is controlled by the EventsCount property.

This property is not available at design time.

Data Type

String

EventLocation Property (GoogleCalendars Component)

Geographic location of the event as free-form text.

Syntax

__property String EventLocation[int EventIndex] = { read=FEventLocation, write=FSetEventLocation };

Default Value

""

Remarks

Geographic location of the event as free-form text.

The EventIndex parameter specifies the index of the item in the array. The size of the array is controlled by the EventsCount property.

This property is not available at design time.

Data Type

String

EventOriginalStartDateTime Property (GoogleCalendars Component)

For an instance of a recurring event, this is the time at which this event would start according to the recurrence data in the recurring event identified by recurringEventId.

Syntax

__property String EventOriginalStartDateTime[int EventIndex] = { read=FEventOriginalStartDateTime };

Default Value

""

Remarks

For an instance of a recurring event, this is the time at which this event would start according to the recurrence data in the recurring event identified by recurringEventId. It uniquely identifies the instance within the recurring event series even if the instance was moved to a different time. The date, in the format 'yyyy-mm-dd', if this is an all-day event. The time, as a combined date-time value (formatted according to RFC3339). A time zone offset is required unless a time zone is explicitly specified in StartTimeZone.

The EventIndex parameter specifies the index of the item in the array. The size of the array is controlled by the EventsCount property.

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

Data Type

String

EventOriginalStartTimeZone Property (GoogleCalendars Component)

For an instance of a recurring event, this is the time at which this event would start according to the recurrence data in the recurring event identified by recurringEventId.

Syntax

__property String EventOriginalStartTimeZone[int EventIndex] = { read=FEventOriginalStartTimeZone };

Default Value

""

Remarks

For an instance of a recurring event, this is the time at which this event would start according to the recurrence data in the recurring event identified by recurringEventId. It uniquely identifies the instance within the recurring event series even if the instance was moved to a different time. The time zone in which the time is specified. (Formatted as an IANA Time Zone Database name, e.g. "Europe/Zurich".) For recurring events this field is required and specifies the time zone in which the recurrence is expanded. For single events this field is optional and indicates a custom time zone for the event start.

The EventIndex parameter specifies the index of the item in the array. The size of the array is controlled by the EventsCount property.

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

Data Type

String

EventRecurrence Property (GoogleCalendars Component)

RRULE, EXRULE, RDATE and EXDATE line for a recurring event, as specified in RFC5545.

Syntax

__property String EventRecurrence[int EventIndex] = { read=FEventRecurrence, write=FSetEventRecurrence };

Default Value

""

Remarks

RRULE, EXRULE, RDATE and EXDATE line for a recurring event, as specified in RFC5545. Set to empty string or null to delete.

The EventIndex parameter specifies the index of the item in the array. The size of the array is controlled by the EventsCount property.

This property is not available at design time.

Data Type

String

EventRecurrenceIndex Property (GoogleCalendars Component)

Current recurrence line index Example (Adding recurrence rule to event) //Add recurrence rules gcal.

Syntax

__property int EventRecurrenceIndex[int EventIndex] = { read=FEventRecurrenceIndex, write=FSetEventRecurrenceIndex };

Default Value

0

Remarks

Current recurrence line index

Example (Adding recurrence rule to event) //Add recurrence rules gcal.Events[0].RecurrencesCount = 2; gcal.Events[0].RecurrenceIndex = 0; //set index for first recurrence gcal.Events[0].Recurrence = "RRULE:FREQ=WEEKLY;BYDAY=FR"; //every week on Fridays gcal.Events[0].RecurrenceIndex = 1; //set index for second recurrence gcal.Events[0].Recurrence = "RRULE:FREQ=WEEKLY;BYDAY=MO"; //every week on Mondays

The EventIndex parameter specifies the index of the item in the array. The size of the array is controlled by the EventsCount property.

This property is not available at design time.

Data Type

Integer

EventRecurrencesCount Property (GoogleCalendars Component)

Number of recurrence lines for the event.

Syntax

__property int EventRecurrencesCount[int EventIndex] = { read=FEventRecurrencesCount, write=FSetEventRecurrencesCount };

Default Value

0

Remarks

Number of recurrence lines for the event.

The EventIndex parameter specifies the index of the item in the array. The size of the array is controlled by the EventsCount property.

This property is not available at design time.

Data Type

Integer

EventRecurringEventId Property (GoogleCalendars Component)

For an instance of a recurring event, this is the id of the recurring event to which this instance belongs.

Syntax

__property String EventRecurringEventId[int EventIndex] = { read=FEventRecurringEventId };

Default Value

""

Remarks

For an instance of a recurring event, this is the id of the recurring event to which this instance belongs.

The EventIndex parameter specifies the index of the item in the array. The size of the array is controlled by the EventsCount property.

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

Data Type

String

EventRemindersOverrideIndex Property (GoogleCalendars Component)

Current reminders override index Example //Adding one reminder gcal.

Syntax

__property int EventRemindersOverrideIndex[int EventIndex] = { read=FEventRemindersOverrideIndex, write=FSetEventRemindersOverrideIndex };

Default Value

0

Remarks

Current reminders override index

Example //Adding one reminder gcal.Events[0].ReminderUseDefault = false; gcal.Events[0].RemindersOverridesCount = 1; //set the number of reminder overrides gcal.Events[0].RemindersOverrideIndex = 0; //set index of current reminder gcal.Events[0].RemindersOverrideMethod = TGCRemindersOverrideMethods.gcrmEmail; gcal.Events[0].RemindersOverrideMinutes = 10;

The EventIndex parameter specifies the index of the item in the array. The size of the array is controlled by the EventsCount property.

This property is not available at design time.

Data Type

Integer

EventRemindersOverrideMethod Property (GoogleCalendars Component)

The method used by this reminder.

Syntax

__property TccGoogleCalendarsEventRemindersOverrideMethods EventRemindersOverrideMethod[int EventIndex] = { read=FEventRemindersOverrideMethod, write=FSetEventRemindersOverrideMethod };

enum TccGoogleCalendarsEventRemindersOverrideMethods {
  gcrmEmail=0,
  gcrmPopup=1
};

Default Value

gcrmEmail

Remarks

The method used by this reminder. Required when adding a reminder.

Possible values are:

The EventIndex parameter specifies the index of the item in the array. The size of the array is controlled by the EventsCount property.

This property is not available at design time.

Data Type

Integer

EventRemindersOverrideMinutes Property (GoogleCalendars Component)

Number of minutes before the start of the event when the reminder should trigger.

Syntax

__property int EventRemindersOverrideMinutes[int EventIndex] = { read=FEventRemindersOverrideMinutes, write=FSetEventRemindersOverrideMinutes };

Default Value

0

Remarks

Number of minutes before the start of the event when the reminder should trigger. Valid values are between 0 and 40320 (4 weeks in minutes). Required when adding a reminder. Set to -1 to delete.

Example (Adding a reminder 10 minutes before) //Adding one reminder gcal.Events[0].ReminderUseDefault = false; gcal.Events[0].RemindersOverridesCount = 1; //set the number of reminder overrides gcal.Events[0].RemindersOverrideIndex = 0; //set index of current reminder gcal.Events[0].RemindersOverrideMethod = TGCRemindersOverrideMethods.gcrmEmail; gcal.Events[0].RemindersOverrideMinutes = 10;

The EventIndex parameter specifies the index of the item in the array. The size of the array is controlled by the EventsCount property.

This property is not available at design time.

Data Type

Integer

EventRemindersOverridesCount Property (GoogleCalendars Component)

number of reminders overrides for the event.

Syntax

__property int EventRemindersOverridesCount[int EventIndex] = { read=FEventRemindersOverridesCount, write=FSetEventRemindersOverridesCount };

Default Value

0

Remarks

number of reminders overrides for the event

The EventIndex parameter specifies the index of the item in the array. The size of the array is controlled by the EventsCount property.

This property is not available at design time.

Data Type

Integer

EventReminderUseDefault Property (GoogleCalendars Component)

Whether the default reminders of the calendar apply to the event.

Syntax

__property bool EventReminderUseDefault[int EventIndex] = { read=FEventReminderUseDefault, write=FSetEventReminderUseDefault };

Default Value

False

Remarks

Whether the default reminders of the calendar apply to the event.

The EventIndex parameter specifies the index of the item in the array. The size of the array is controlled by the EventsCount property.

This property is not available at design time.

Data Type

Boolean

EventStartDateTime Property (GoogleCalendars Component)

The date, in the format 'yyyy-mm-dd', if this is an all-day event.

Syntax

__property String EventStartDateTime[int EventIndex] = { read=FEventStartDateTime, write=FSetEventStartDateTime };

Default Value

""

Remarks

The date, in the format 'yyyy-mm-dd', if this is an all-day event. The time, as a combined date-time value (formatted according to RFC3339). A time zone offset is required unless a time zone is explicitly specified in StartTimeZone.

The EventIndex parameter specifies the index of the item in the array. The size of the array is controlled by the EventsCount property.

This property is not available at design time.

Data Type

String

EventStartTimeZone Property (GoogleCalendars Component)

The time zone in which the time is specified.

Syntax

__property String EventStartTimeZone[int EventIndex] = { read=FEventStartTimeZone, write=FSetEventStartTimeZone };

Default Value

""

Remarks

The time zone in which the time is specified. (Formatted as an IANA Time Zone Database name, e.g. "Europe/Zurich".) For recurring events this field is required and specifies the time zone in which the recurrence is expanded. For single events this field is optional and indicates a custom time zone for the event start.

The EventIndex parameter specifies the index of the item in the array. The size of the array is controlled by the EventsCount property.

This property is not available at design time.

Data Type

String

EventSummary Property (GoogleCalendars Component)

Title of the event.

Syntax

__property String EventSummary[int EventIndex] = { read=FEventSummary, write=FSetEventSummary };

Default Value

""

Remarks

Title of the event.

The EventIndex parameter specifies the index of the item in the array. The size of the array is controlled by the EventsCount property.

This property is not available at design time.

Data Type

String

EventTransparency Property (GoogleCalendars Component)

Whether the event blocks time on the calendar.

Syntax

__property TccGoogleCalendarsEventTransparencies EventTransparency[int EventIndex] = { read=FEventTransparency, write=FSetEventTransparency };

enum TccGoogleCalendarsEventTransparencies {
  gctOpaque=0,
  gctTransparent=1
};

Default Value

gctOpaque

Remarks

Whether the event blocks time on the calendar. Optional.

Possible values are:

The EventIndex parameter specifies the index of the item in the array. The size of the array is controlled by the EventsCount property.

This property is not available at design time.

Data Type

Integer

EventUpdated Property (GoogleCalendars Component)

Last modification time of the event (as a RFC3339 timestamp).

Syntax

__property String EventUpdated[int EventIndex] = { read=FEventUpdated };

Default Value

""

Remarks

Last modification time of the event (as a RFC3339 timestamp). Read-only.

The EventIndex parameter specifies the index of the item in the array. The size of the array is controlled by the EventsCount property.

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

Data Type

String

EventVisibility Property (GoogleCalendars Component)

Visibility of the event.

Syntax

__property TccGoogleCalendarsEventVisibilities EventVisibility[int EventIndex] = { read=FEventVisibility, write=FSetEventVisibility };

enum TccGoogleCalendarsEventVisibilities {
  gcvDefault=0,
  gcvPublic=1,
  gcvPrivate=2,
  gcvConfidential=3
};

Default Value

gcvDefault

Remarks

Visibility of the event. Possible values are:

Possible values are:

The EventIndex parameter specifies the index of the item in the array. The size of the array is controlled by the EventsCount property.

This property is not available at design time.

Data Type

Integer

FirewallAutoDetect Property (GoogleCalendars Component)

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

Syntax

__property bool FirewallAutoDetect = { read=FFirewallAutoDetect, write=FSetFirewallAutoDetect };

Default Value

False

Remarks

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

Data Type

Boolean

FirewallType Property (GoogleCalendars Component)

The type of firewall to connect through.

Syntax

__property TccGoogleCalendarsFirewallTypes FirewallType = { read=FFirewallType, write=FSetFirewallType };

enum TccGoogleCalendarsFirewallTypes {
  fwNone=0,
  fwTunnel=1,
  fwSOCKS4=2,
  fwSOCKS5=3,
  fwSOCKS4A=10
};

Default Value

fwNone

Remarks

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

Data Type

Integer

FirewallHost Property (GoogleCalendars Component)

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

Syntax

__property String FirewallHost = { read=FFirewallHost, write=FSetFirewallHost };

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 component raises an exception.

Data Type

String

FirewallPassword Property (GoogleCalendars Component)

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

Syntax

__property String FirewallPassword = { read=FFirewallPassword, write=FSetFirewallPassword };

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 component raises an exception.

Data Type

String

FirewallPort Property (GoogleCalendars Component)

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

Syntax

__property int FirewallPort = { read=FFirewallPort, write=FSetFirewallPort };

Default Value

0

Remarks

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

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

Data Type

Integer

FirewallUser Property (GoogleCalendars Component)

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

Syntax

__property String FirewallUser = { read=FFirewallUser, write=FSetFirewallUser };

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 component raises an exception.

Data Type

String

ListEventsMarker Property (GoogleCalendars Component)

The page marker for listing events.

Syntax

__property String ListEventsMarker = { read=FListEventsMarker, write=FSetListEventsMarker };

Default Value

""

Remarks

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

Example (List All Events in a Calendar):

do { gcal.ListEvents(calendarId); } while (gcal.ListEventsMarker.Length > 0);

This property is not available at design time.

Data Type

String

OAuthAccessToken Property (GoogleCalendars Component)

The access token returned by the authorization server.

Syntax

__property String OAuthAccessToken = { read=FOAuthAccessToken, write=FSetOAuthAccessToken };

Default Value

""

Remarks

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

This property is not available at design time.

Data Type

String

OAuthAuthorizationCode Property (GoogleCalendars Component)

The authorization code that is exchanged for an access token.

Syntax

__property String OAuthAuthorizationCode = { read=FOAuthAuthorizationCode, write=FSetOAuthAuthorizationCode };

Default Value

""

Remarks

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

This property is not available at design time.

Data Type

String

OAuthAuthorizationScope Property (GoogleCalendars Component)

The scope request or response parameter used during authorization.

Syntax

__property String OAuthAuthorizationScope = { read=FOAuthAuthorizationScope, write=FSetOAuthAuthorizationScope };

Default Value

""

Remarks

The scope request or response parameter used during authorization.

This property is not available at design time.

Data Type

String

OAuthClientId Property (GoogleCalendars Component)

The id of the client assigned when registering the application.

Syntax

__property String OAuthClientId = { read=FOAuthClientId, write=FSetOAuthClientId };

Default Value

""

Remarks

The id of the client assigned when registering the application.

This property is not available at design time.

Data Type

String

OAuthClientProfile Property (GoogleCalendars Component)

The type of client that is requesting authorization.

Syntax

__property TccGoogleCalendarsOAuthClientProfiles OAuthClientProfile = { read=FOAuthClientProfile, write=FSetOAuthClientProfile };

enum TccGoogleCalendarsOAuthClientProfiles {
  cocpApplication=0,
  cocpWeb=1
};

Default Value

cocpApplication

Remarks

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

This property is not available at design time.

Data Type

Integer

OAuthClientSecret Property (GoogleCalendars Component)

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

Syntax

__property String OAuthClientSecret = { read=FOAuthClientSecret, write=FSetOAuthClientSecret };

Default Value

""

Remarks

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

This property is not available at design time.

Data Type

String

OAuthGrantType Property (GoogleCalendars Component)

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

Syntax

__property TccGoogleCalendarsOAuthGrantTypes OAuthGrantType = { read=FOAuthGrantType, write=FSetOAuthGrantType };

enum TccGoogleCalendarsOAuthGrantTypes {
  cogtAuthorizationCode=0,
  cogtImplicit=1,
  cogtPassword=2,
  cogtClientCredentials=3
};

Default Value

cogtAuthorizationCode

Remarks

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

This property is not available at design time.

Data Type

Integer

OAuthRefreshToken Property (GoogleCalendars Component)

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

Syntax

__property String OAuthRefreshToken = { read=FOAuthRefreshToken, write=FSetOAuthRefreshToken };

Default Value

""

Remarks

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

This property is not available at design time.

Data Type

String

OAuthRequestRefreshToken Property (GoogleCalendars Component)

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

Syntax

__property bool OAuthRequestRefreshToken = { read=FOAuthRequestRefreshToken, write=FSetOAuthRequestRefreshToken };

Default Value

true

Remarks

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

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

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

This property is not available at design time.

Data Type

Boolean

OAuthReturnURL Property (GoogleCalendars Component)

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

Syntax

__property String OAuthReturnURL = { read=FOAuthReturnURL, write=FSetOAuthReturnURL };

Default Value

""

Remarks

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

This property is not available at design time.

Data Type

String

OAuthServerAuthURL Property (GoogleCalendars Component)

The URL of the authorization server.

Syntax

__property String OAuthServerAuthURL = { read=FOAuthServerAuthURL, write=FSetOAuthServerAuthURL };

Default Value

""

Remarks

The URL of the authorization server.

This property is not available at design time.

Data Type

String

OAuthServerTokenURL Property (GoogleCalendars Component)

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

Syntax

__property String OAuthServerTokenURL = { read=FOAuthServerTokenURL, write=FSetOAuthServerTokenURL };

Default Value

""

Remarks

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

This property is not available at design time.

Data Type

String

OAuthWebAuthURL Property (GoogleCalendars Component)

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

Syntax

__property String OAuthWebAuthURL = { read=FOAuthWebAuthURL };

Default Value

""

Remarks

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

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

Data Type

String

ProxyAuthScheme Property (GoogleCalendars Component)

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

Syntax

__property TccGoogleCalendarsProxyAuthSchemes ProxyAuthScheme = { read=FProxyAuthScheme, write=FSetProxyAuthScheme };

enum TccGoogleCalendarsProxyAuthSchemes {
  authBasic=0,
  authDigest=1,
  authProprietary=2,
  authNone=3,
  authNtlm=4,
  authNegotiate=5
};

Default Value

authBasic

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 component will attempt basic authentication.

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

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

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

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

Data Type

Integer

ProxyAutoDetect Property (GoogleCalendars Component)

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

Syntax

__property bool ProxyAutoDetect = { read=FProxyAutoDetect, write=FSetProxyAutoDetect };

Default Value

False

Remarks

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

Data Type

Boolean

ProxyPassword Property (GoogleCalendars Component)

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

Syntax

__property String ProxyPassword = { read=FProxyPassword, write=FSetProxyPassword };

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

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

Syntax

__property int ProxyPort = { read=FProxyPort, write=FSetProxyPort };

Default Value

80

Remarks

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

Data Type

Integer

ProxyServer Property (GoogleCalendars Component)

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

Syntax

__property String ProxyServer = { read=FProxyServer, write=FSetProxyServer };

Default Value

""

Remarks

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

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

Data Type

String

ProxySSL Property (GoogleCalendars Component)

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

Syntax

__property TccGoogleCalendarsProxySSLs ProxySSL = { read=FProxySSL, write=FSetProxySSL };

enum TccGoogleCalendarsProxySSLs {
  psAutomatic=0,
  psAlways=1,
  psNever=2,
  psTunnel=3
};

Default Value

psAutomatic

Remarks

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

Data Type

Integer

ProxyUser Property (GoogleCalendars Component)

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

Syntax

__property String ProxyUser = { read=FProxyUser, write=FSetProxyUser };

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

The date on which this certificate becomes valid.

Syntax

__property String SSLAcceptServerCertEffectiveDate = { read=FSSLAcceptServerCertEffectiveDate };

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

The date on which the certificate expires.

Syntax

__property String SSLAcceptServerCertExpirationDate = { read=FSSLAcceptServerCertExpirationDate };

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

A comma-delimited list of extended key usage identifiers.

Syntax

__property String SSLAcceptServerCertExtendedKeyUsage = { read=FSSLAcceptServerCertExtendedKeyUsage };

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

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

Syntax

__property String SSLAcceptServerCertFingerprint = { read=FSSLAcceptServerCertFingerprint };

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

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

Syntax

__property String SSLAcceptServerCertFingerprintSHA1 = { read=FSSLAcceptServerCertFingerprintSHA1 };

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

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

Syntax

__property String SSLAcceptServerCertFingerprintSHA256 = { read=FSSLAcceptServerCertFingerprintSHA256 };

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

The issuer of the certificate.

Syntax

__property String SSLAcceptServerCertIssuer = { read=FSSLAcceptServerCertIssuer };

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

The private key of the certificate (if available).

Syntax

__property String SSLAcceptServerCertPrivateKey = { read=FSSLAcceptServerCertPrivateKey };

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

Whether a PrivateKey is available for the selected certificate.

Syntax

__property bool SSLAcceptServerCertPrivateKeyAvailable = { read=FSSLAcceptServerCertPrivateKeyAvailable };

Default Value

false

Remarks

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

This property is read-only.

Data Type

Boolean

SSLAcceptServerCertPrivateKeyContainer Property (GoogleCalendars Component)

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

Syntax

__property String SSLAcceptServerCertPrivateKeyContainer = { read=FSSLAcceptServerCertPrivateKeyContainer };

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

The public key of the certificate.

Syntax

__property String SSLAcceptServerCertPublicKey = { read=FSSLAcceptServerCertPublicKey };

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

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

Syntax

__property String SSLAcceptServerCertPublicKeyAlgorithm = { read=FSSLAcceptServerCertPublicKeyAlgorithm };

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

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

Syntax

__property int SSLAcceptServerCertPublicKeyLength = { read=FSSLAcceptServerCertPublicKeyLength };

Default Value

0

Remarks

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

This property is read-only.

Data Type

Integer

SSLAcceptServerCertSerialNumber Property (GoogleCalendars Component)

The serial number of the certificate encoded as a string.

Syntax

__property String SSLAcceptServerCertSerialNumber = { read=FSSLAcceptServerCertSerialNumber };

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

The text description of the certificate's signature algorithm.

Syntax

__property String SSLAcceptServerCertSignatureAlgorithm = { read=FSSLAcceptServerCertSignatureAlgorithm };

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

The name of the certificate store for the client certificate.

Syntax

__property String SSLAcceptServerCertStore = { read=FSSLAcceptServerCertStore, write=FSetSSLAcceptServerCertStore };
__property DynamicArray<Byte> SSLAcceptServerCertStoreB = { read=FSSLAcceptServerCertStoreB, write=FSetSSLAcceptServerCertStoreB };

Default Value

"MY"

Remarks

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 Array

SSLAcceptServerCertStorePassword Property (GoogleCalendars Component)

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

Syntax

__property String SSLAcceptServerCertStorePassword = { read=FSSLAcceptServerCertStorePassword, write=FSetSSLAcceptServerCertStorePassword };

Default Value

""

Remarks

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

Data Type

String

SSLAcceptServerCertStoreType Property (GoogleCalendars Component)

The type of certificate store for this certificate.

Syntax

__property TccGoogleCalendarsSSLAcceptServerCertStoreTypes SSLAcceptServerCertStoreType = { read=FSSLAcceptServerCertStoreType, write=FSetSSLAcceptServerCertStoreType };

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

Default Value

cstUser

Remarks

The type of certificate store for this certificate.

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

Data Type

Integer

SSLAcceptServerCertSubjectAltNames Property (GoogleCalendars Component)

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

Syntax

__property String SSLAcceptServerCertSubjectAltNames = { read=FSSLAcceptServerCertSubjectAltNames };

Default Value

""

Remarks

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

This property is read-only.

Data Type

String

SSLAcceptServerCertThumbprintMD5 Property (GoogleCalendars Component)

The MD5 hash of the certificate.

Syntax

__property String SSLAcceptServerCertThumbprintMD5 = { read=FSSLAcceptServerCertThumbprintMD5 };

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

The SHA-1 hash of the certificate.

Syntax

__property String SSLAcceptServerCertThumbprintSHA1 = { read=FSSLAcceptServerCertThumbprintSHA1 };

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

The SHA-256 hash of the certificate.

Syntax

__property String SSLAcceptServerCertThumbprintSHA256 = { read=FSSLAcceptServerCertThumbprintSHA256 };

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

The text description of UsageFlags .

Syntax

__property String SSLAcceptServerCertUsage = { read=FSSLAcceptServerCertUsage };

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

The flags that show intended use for the certificate.

Syntax

__property int SSLAcceptServerCertUsageFlags = { read=FSSLAcceptServerCertUsageFlags };

Default Value

0

Remarks

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

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

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

This property is read-only.

Data Type

Integer

SSLAcceptServerCertVersion Property (GoogleCalendars Component)

The certificate's version number.

Syntax

__property String SSLAcceptServerCertVersion = { read=FSSLAcceptServerCertVersion };

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

The subject of the certificate used for client authentication.

Syntax

__property String SSLAcceptServerCertSubject = { read=FSSLAcceptServerCertSubject, write=FSetSSLAcceptServerCertSubject };

Default Value

""

Remarks

The subject of the certificate used for client authentication.

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

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

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

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

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

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

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

Data Type

String

SSLAcceptServerCertEncoded Property (GoogleCalendars Component)

The certificate (PEM/Base64 encoded).

Syntax

__property String SSLAcceptServerCertEncoded = { read=FSSLAcceptServerCertEncoded, write=FSetSSLAcceptServerCertEncoded };
__property DynamicArray<Byte> SSLAcceptServerCertEncodedB = { read=FSSLAcceptServerCertEncodedB, write=FSetSSLAcceptServerCertEncodedB };

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.

This property is not available at design time.

Data Type

Byte Array

SSLCertEffectiveDate Property (GoogleCalendars Component)

The date on which this certificate becomes valid.

Syntax

__property String SSLCertEffectiveDate = { read=FSSLCertEffectiveDate };

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

The date on which the certificate expires.

Syntax

__property String SSLCertExpirationDate = { read=FSSLCertExpirationDate };

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

A comma-delimited list of extended key usage identifiers.

Syntax

__property String SSLCertExtendedKeyUsage = { read=FSSLCertExtendedKeyUsage };

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

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

Syntax

__property String SSLCertFingerprint = { read=FSSLCertFingerprint };

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

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

Syntax

__property String SSLCertFingerprintSHA1 = { read=FSSLCertFingerprintSHA1 };

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

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

Syntax

__property String SSLCertFingerprintSHA256 = { read=FSSLCertFingerprintSHA256 };

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

The issuer of the certificate.

Syntax

__property String SSLCertIssuer = { read=FSSLCertIssuer };

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

The private key of the certificate (if available).

Syntax

__property String SSLCertPrivateKey = { read=FSSLCertPrivateKey };

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

Whether a PrivateKey is available for the selected certificate.

Syntax

__property bool SSLCertPrivateKeyAvailable = { read=FSSLCertPrivateKeyAvailable };

Default Value

false

Remarks

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

This property is read-only.

Data Type

Boolean

SSLCertPrivateKeyContainer Property (GoogleCalendars Component)

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

Syntax

__property String SSLCertPrivateKeyContainer = { read=FSSLCertPrivateKeyContainer };

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

The public key of the certificate.

Syntax

__property String SSLCertPublicKey = { read=FSSLCertPublicKey };

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

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

Syntax

__property String SSLCertPublicKeyAlgorithm = { read=FSSLCertPublicKeyAlgorithm };

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

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

Syntax

__property int SSLCertPublicKeyLength = { read=FSSLCertPublicKeyLength };

Default Value

0

Remarks

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

This property is read-only.

Data Type

Integer

SSLCertSerialNumber Property (GoogleCalendars Component)

The serial number of the certificate encoded as a string.

Syntax

__property String SSLCertSerialNumber = { read=FSSLCertSerialNumber };

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

The text description of the certificate's signature algorithm.

Syntax

__property String SSLCertSignatureAlgorithm = { read=FSSLCertSignatureAlgorithm };

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

The name of the certificate store for the client certificate.

Syntax

__property String SSLCertStore = { read=FSSLCertStore, write=FSetSSLCertStore };
__property DynamicArray<Byte> SSLCertStoreB = { read=FSSLCertStoreB, write=FSetSSLCertStoreB };

Default Value

"MY"

Remarks

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 Array

SSLCertStorePassword Property (GoogleCalendars Component)

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

Syntax

__property String SSLCertStorePassword = { read=FSSLCertStorePassword, write=FSetSSLCertStorePassword };

Default Value

""

Remarks

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

Data Type

String

SSLCertStoreType Property (GoogleCalendars Component)

The type of certificate store for this certificate.

Syntax

__property TccGoogleCalendarsSSLCertStoreTypes SSLCertStoreType = { read=FSSLCertStoreType, write=FSetSSLCertStoreType };

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

Default Value

cstUser

Remarks

The type of certificate store for this certificate.

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

Data Type

Integer

SSLCertSubjectAltNames Property (GoogleCalendars Component)

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

Syntax

__property String SSLCertSubjectAltNames = { read=FSSLCertSubjectAltNames };

Default Value

""

Remarks

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

This property is read-only.

Data Type

String

SSLCertThumbprintMD5 Property (GoogleCalendars Component)

The MD5 hash of the certificate.

Syntax

__property String SSLCertThumbprintMD5 = { read=FSSLCertThumbprintMD5 };

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

The SHA-1 hash of the certificate.

Syntax

__property String SSLCertThumbprintSHA1 = { read=FSSLCertThumbprintSHA1 };

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

The SHA-256 hash of the certificate.

Syntax

__property String SSLCertThumbprintSHA256 = { read=FSSLCertThumbprintSHA256 };

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

The text description of UsageFlags .

Syntax

__property String SSLCertUsage = { read=FSSLCertUsage };

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

The flags that show intended use for the certificate.

Syntax

__property int SSLCertUsageFlags = { read=FSSLCertUsageFlags };

Default Value

0

Remarks

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

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

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

This property is read-only.

Data Type

Integer

SSLCertVersion Property (GoogleCalendars Component)

The certificate's version number.

Syntax

__property String SSLCertVersion = { read=FSSLCertVersion };

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

The subject of the certificate used for client authentication.

Syntax

__property String SSLCertSubject = { read=FSSLCertSubject, write=FSetSSLCertSubject };

Default Value

""

Remarks

The subject of the certificate used for client authentication.

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

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

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

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

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

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

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

Data Type

String

SSLCertEncoded Property (GoogleCalendars Component)

The certificate (PEM/Base64 encoded).

Syntax

__property String SSLCertEncoded = { read=FSSLCertEncoded, write=FSetSSLCertEncoded };
__property DynamicArray<Byte> SSLCertEncodedB = { read=FSSLCertEncodedB, write=FSetSSLCertEncodedB };

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.

This property is not available at design time.

Data Type

Byte Array

SSLProvider Property (GoogleCalendars Component)

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

Syntax

__property TccGoogleCalendarsSSLProviders SSLProvider = { read=FSSLProvider, write=FSetSSLProvider };

enum TccGoogleCalendarsSSLProviders {
  sslpAutomatic=0,
  sslpPlatform=1,
  sslpInternal=2
};

Default Value

sslpAutomatic

Remarks

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

Possible values are as follows:

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

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

Data Type

Integer

SSLServerCertEffectiveDate Property (GoogleCalendars Component)

The date on which this certificate becomes valid.

Syntax

__property String SSLServerCertEffectiveDate = { read=FSSLServerCertEffectiveDate };

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

The date on which the certificate expires.

Syntax

__property String SSLServerCertExpirationDate = { read=FSSLServerCertExpirationDate };

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

A comma-delimited list of extended key usage identifiers.

Syntax

__property String SSLServerCertExtendedKeyUsage = { read=FSSLServerCertExtendedKeyUsage };

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

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

Syntax

__property String SSLServerCertFingerprint = { read=FSSLServerCertFingerprint };

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

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

Syntax

__property String SSLServerCertFingerprintSHA1 = { read=FSSLServerCertFingerprintSHA1 };

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

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

Syntax

__property String SSLServerCertFingerprintSHA256 = { read=FSSLServerCertFingerprintSHA256 };

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

The issuer of the certificate.

Syntax

__property String SSLServerCertIssuer = { read=FSSLServerCertIssuer };

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

The private key of the certificate (if available).

Syntax

__property String SSLServerCertPrivateKey = { read=FSSLServerCertPrivateKey };

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

Whether a PrivateKey is available for the selected certificate.

Syntax

__property bool SSLServerCertPrivateKeyAvailable = { read=FSSLServerCertPrivateKeyAvailable };

Default Value

false

Remarks

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

This property is read-only.

Data Type

Boolean

SSLServerCertPrivateKeyContainer Property (GoogleCalendars Component)

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

Syntax

__property String SSLServerCertPrivateKeyContainer = { read=FSSLServerCertPrivateKeyContainer };

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

The public key of the certificate.

Syntax

__property String SSLServerCertPublicKey = { read=FSSLServerCertPublicKey };

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

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

Syntax

__property String SSLServerCertPublicKeyAlgorithm = { read=FSSLServerCertPublicKeyAlgorithm };

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

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

Syntax

__property int SSLServerCertPublicKeyLength = { read=FSSLServerCertPublicKeyLength };

Default Value

0

Remarks

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

This property is read-only.

Data Type

Integer

SSLServerCertSerialNumber Property (GoogleCalendars Component)

The serial number of the certificate encoded as a string.

Syntax

__property String SSLServerCertSerialNumber = { read=FSSLServerCertSerialNumber };

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

The text description of the certificate's signature algorithm.

Syntax

__property String SSLServerCertSignatureAlgorithm = { read=FSSLServerCertSignatureAlgorithm };

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

The name of the certificate store for the client certificate.

Syntax

__property String SSLServerCertStore = { read=FSSLServerCertStore };
__property DynamicArray<Byte> SSLServerCertStoreB = { read=FSSLServerCertStoreB };

Default Value

"MY"

Remarks

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 Array

SSLServerCertStorePassword Property (GoogleCalendars Component)

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

Syntax

__property String SSLServerCertStorePassword = { read=FSSLServerCertStorePassword };

Default Value

""

Remarks

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

This property is read-only.

Data Type

String

SSLServerCertStoreType Property (GoogleCalendars Component)

The type of certificate store for this certificate.

Syntax

__property TccGoogleCalendarsSSLServerCertStoreTypes SSLServerCertStoreType = { read=FSSLServerCertStoreType };

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

Default Value

cstUser

Remarks

The type of certificate store for this certificate.

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

This property is read-only.

Data Type

Integer

SSLServerCertSubjectAltNames Property (GoogleCalendars Component)

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

Syntax

__property String SSLServerCertSubjectAltNames = { read=FSSLServerCertSubjectAltNames };

Default Value

""

Remarks

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

This property is read-only.

Data Type

String

SSLServerCertThumbprintMD5 Property (GoogleCalendars Component)

The MD5 hash of the certificate.

Syntax

__property String SSLServerCertThumbprintMD5 = { read=FSSLServerCertThumbprintMD5 };

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

The SHA-1 hash of the certificate.

Syntax

__property String SSLServerCertThumbprintSHA1 = { read=FSSLServerCertThumbprintSHA1 };

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

The SHA-256 hash of the certificate.

Syntax

__property String SSLServerCertThumbprintSHA256 = { read=FSSLServerCertThumbprintSHA256 };

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

The text description of UsageFlags .

Syntax

__property String SSLServerCertUsage = { read=FSSLServerCertUsage };

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

The flags that show intended use for the certificate.

Syntax

__property int SSLServerCertUsageFlags = { read=FSSLServerCertUsageFlags };

Default Value

0

Remarks

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

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

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

This property is read-only.

Data Type

Integer

SSLServerCertVersion Property (GoogleCalendars Component)

The certificate's version number.

Syntax

__property String SSLServerCertVersion = { read=FSSLServerCertVersion };

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

The subject of the certificate used for client authentication.

Syntax

__property String SSLServerCertSubject = { read=FSSLServerCertSubject };

Default Value

""

Remarks

The subject of the certificate used for client authentication.

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

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

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

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

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

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

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

This property is read-only.

Data Type

String

SSLServerCertEncoded Property (GoogleCalendars Component)

The certificate (PEM/Base64 encoded).

Syntax

__property String SSLServerCertEncoded = { read=FSSLServerCertEncoded };
__property DynamicArray<Byte> SSLServerCertEncodedB = { read=FSSLServerCertEncodedB };

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 and not available at design time.

Data Type

Byte Array

Authorize Method (GoogleCalendars Component)

Get the authorization string required to access the protected resource.

Syntax

void __fastcall Authorize();

Remarks

This method is used to get an access token that is required to access the protected resource. The method will act differently based on what is set in the OAuthClientProfile property and the OAuthGrantType property. This method is not to be used in conjunction with the Authorization property. It should instead be used when setting the OAuth property.

For more information, see the introduction section.

Config Method (GoogleCalendars Component)

Sets or retrieves a configuration setting.

Syntax

String __fastcall Config(String ConfigurationString);

Remarks

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

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

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

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

CreateCalendar Method (GoogleCalendars Component)

Creates a new calendar.

Syntax

void __fastcall CreateCalendar(String Name);

Remarks

Creates a new calendar identified by the Name parameter, the display name of the calendar to be created. Creating a calendar with the same name as an existing one, does not override the old one, but creates a new one with a different Id.

The newly created calendar is added at the beginning of the Calendars properties.

If you need to specify more properties or customize the calendar beyond the basic creation, first create the calendar and then update it using the UpdateCalendar method.

Example (Creating a New Calendar)

gcal.CreateCalendar(name); string statusLine = gcal.Config("StatusLine")); // It should be "HTTP/1.1 200 OK"

CreateEvent Method (GoogleCalendars Component)

Creates an event. The timezone is UTC.

Syntax

void __fastcall CreateEvent(String Subject, String StartTime, String EndTime, String CalendarId);

Remarks

Creates a new event with the specified details. The Subject parameter defines the title or description of the event, while the StartTime and EndTime parameters specify the start and end times of the event in UTC. Both the StartTime and EndTime times should be in the format yyyy-MM-ddTHH:mm:ss. The CalendarId parameter identifies the calendar in which the event will be created.

If you need to set additional properties or customize the event further, use the UpdateEvent method after creation to modify attributes like location, attendees, start time etc.

Example(Create a New event) gcal.ListCalendars(); gcal.CreateEvent("TestSub", "yyyy-MM-ddTHH:mm:ss", "yyyy-MM-ddTHH:mm:ss", gcal.Calendars[index].Id);

DeleteCalendar Method (GoogleCalendars Component)

Deletes a calendar.

Syntax

void __fastcall DeleteCalendar(String id);

Remarks

Deletes a calendar identified by the id parameter. The calendar and all its associated events will be removed, this operation does not remove the calendar from the Calendars properties, the calendar will only be removed once ListCalendars is called.

DeleteEvent Method (GoogleCalendars Component)

Deletes an event.

Syntax

void __fastcall DeleteEvent(String CalendarId, String Id);

Remarks

Deletes an event identified by the CalendarId and Id parameters, where CalendarId is the Id of the calendar to which the Event belongs to, and Id is the Id of the event that will be deleted. The specified event will be permanently removed. This method does not delete the event from the Events properties, the event will be removed only once the ListEvents method is called.

GetEvent Method (GoogleCalendars Component)

Retrieves the event by Id.

Syntax

void __fastcall GetEvent(String CalendarId, String Id);

Remarks

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

Example (Get an Event)

// Retrieve an event by its ID gcal.GetEvent(calendarId, eventId); GCalEvent event = gcal.Events[gcal.Events.Count - 1]; event.Summary; // event summary event.StartDateTime; // start time of the event event.EndDateTime; // end time of the event for(int i = 0; i < event.AttendeesCount; i++){ event.AttendeeIndex = i; event.AttendeeEmail; // the email of the attendee event.AttendeeResponseStatus; // the response of the attendee }

GetEventField Method (GoogleCalendars Component)

Retrieves the event property value by JSONPath.

Syntax

String __fastcall GetEventField(int index, String JsonPath);

Remarks

This method retrieves a specific field within the event's JSON field. The first parameter, index, represents the index of the event in the Events 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 an event has/can have, please refer to the official documentation of the Google Calendars API documentation.

Example (Access Fields of an Event)

gcal.GetEvent(eventId); gcal.GetEventField(0, "/json/summary"); // The summary of the event gcal.GetEventField(0, "/json/end/dateTime"); // The date and time that the event ends. gcal.GetEventField(0, "/json/description"); // The description of the event. gcal.GetEventField(0, "/json/status"); // The status of the event.

Interrupt Method (GoogleCalendars Component)

Interrupt the current method.

Syntax

void __fastcall Interrupt();

Remarks

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

ListCalendars Method (GoogleCalendars Component)

Lists the calendars.

Syntax

void __fastcall ListCalendars();

Remarks

Lists all calendars associated with the current user. The retrieved calendars are added to the Calendars properties, which is cleared before being repopulated with the latest data. For each calendar retrieved, the CalendarList event is fired.

ListColors Method (GoogleCalendars Component)

Lists the colors.

Syntax

void __fastcall ListColors();

Remarks

Lists the color definitions for all calendars and events, the retrieved colors are added to the Colors properties.

ListEvents Method (GoogleCalendars Component)

Lists the events. (empty calendarId for all events).

Syntax

void __fastcall ListEvents(String calendarId);

Remarks

Retrieves a list of events from the specified calendar identified by the calendarId parameter. The retrieved events are added to the Events properties, which is cleared before being repopulated with the latest events data. For each event retrieved, the EventList event is fired.

Reset Method (GoogleCalendars Component)

This method will reset the component.

Syntax

void __fastcall Reset();

Remarks

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

SendCustomRequest Method (GoogleCalendars Component)

Send a custom HTTP request.

Syntax

void __fastcall SendCustomRequest(String HTTPMethod, String URL, String PostData);

Remarks

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

Example (Send a custom request):

String data = @"{ ""summary"": ""My new Calendar"" }"; String url = "https://www.googleapis.com/calendar/v3/calendars"; gcal.SendCustomRequest("POST", url, data);

SetEventField Method (GoogleCalendars Component)

Sets the event field value by JSONPath.

Syntax

void __fastcall SetEventField(int index, String JsonPath, String Value, int ValueType);

Remarks

This method updates a specific field within the event's JSON representation. The parameters for this method are as follows: the first parameter, index, represents the index of the event in the Events 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 an Event before Updating): // Create an event. gcal.CreateEvent("EventSum", "yyyy-MM-ddTHH:mm:ss", "yyyy-MM-ddTHH:mm:ss", calendarId); gcal.SetEventField(0, "/json/summary", "New Event Summary", 2); gcal.SetEventField(0, "/json/start", "{\"dateTime\": \"" + now.AddHours(3).ToString(dateTimeFormat) + "\", \"timeZone\": \"UTC\"}", 0); gcal.SetEventField(0, "/json/description", "Birthday, 2); gcal.SetEventField(0, "/json/end", "{\"dateTime\": \"" + now.AddHours(10).ToString(dateTimeFormat) + "\", \"timeZone\": \"UTC\"}", 0); // Update the event gcal.UpdateEvent(0);

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

UpdateCalendar Method (GoogleCalendars Component)

Updates a calendar.

Syntax

void __fastcall UpdateCalendar(int index);

Remarks

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

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

The GCalCalendar type used in the Calendars collection includes the fields of a calendar. Refer to the GCalCalendar type for a complete list of fields.

Example: gcal.CreateCalendar("Personal Calendar"); // Fields to update gcal.Calendars[0].Summary = "Personal Calendar 2.0"; gcal.Calendars[0].Description = "My own calendar"; // Update the calendar gcal.UpdateCalendar(0);

UpdateEvent Method (GoogleCalendars Component)

Updates an event.

Syntax

void __fastcall UpdateEvent(int index);

Remarks

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

To update an event, edit the desired event fields within the Events collection. Then, call the UpdateEvent method with the index of the event. Note that changing the JSON data will overwrite the entire event, ignoring other field edits made before setting the JSON.

The GCalEvent type used in the Events collection includes the fields of an event. Refer to the GCalEvent type for a complete list of fields. If you need to add other fields, you can use the SetEventField ; method. For a complete list of fields an event can have, please refer to the Google Calendar API overview

Example: gcal.ListCalendars(); // create an event gcal.CreateEvent("TestSub", "yyyy-MM-ddTHH:mm:ss", "yyyy-MM-ddTHH:mm:ss", gcal.Calendars[index].Id); gcal.Events[0].Summary = "New Test Subject"; gcal.Events[0].Visibility = TGCVisibilities.gcvPublic; gcal.Events[0].AttendeesCount = 2; gcal.Events[0].AttendeeIndex = 0; gcal.Events[0].AttendeeEmail = email1; gcal.Events[0].AttendeeOptional = true; gcal.Events[0].AttendeeIndex = 1; gcal.Events[0].AttendeeEmail = email2; gcal.Events[0].AttendeeOptional = false; gcal.Events[0].Description = "Weekly gathering"; // Update the event gcal.UpdateEvent(0);

CalendarList Event (GoogleCalendars Component)

Fired when a calendar is retrieved from the server.

Syntax

typedef struct {
  String Id;
  String Name;
} TccGoogleCalendarsCalendarListEventParams;
typedef void __fastcall (__closure *TccGoogleCalendarsCalendarListEvent)(System::TObject* Sender, TccGoogleCalendarsCalendarListEventParams *e);
__property TccGoogleCalendarsCalendarListEvent OnCalendarList = { read=FOnCalendarList, write=FOnCalendarList };

Remarks

The CalendarList event is fired for each calendar retrieved from the server when ListCalendars is called.

Error Event (GoogleCalendars Component)

Fired when information is available about errors during data delivery.

Syntax

typedef struct {
  int ErrorCode;
  String Description;
} TccGoogleCalendarsErrorEventParams;
typedef void __fastcall (__closure *TccGoogleCalendarsErrorEvent)(System::TObject* Sender, TccGoogleCalendarsErrorEventParams *e);
__property TccGoogleCalendarsErrorEvent OnError = { read=FOnError, write=FOnError };

Remarks

The Error event is fired in case of exceptional conditions during message processing. Normally the component raises an exception.

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

EventList Event (GoogleCalendars Component)

Fired when an event is retrieved from the server.

Syntax

typedef struct {
  String Id;
  String CalendarId;
  String Subject;
  String StartTime;
  String EndTime;
} TccGoogleCalendarsEventListEventParams;
typedef void __fastcall (__closure *TccGoogleCalendarsEventListEvent)(System::TObject* Sender, TccGoogleCalendarsEventListEventParams *e);
__property TccGoogleCalendarsEventListEvent OnEventList = { read=FOnEventList, write=FOnEventList };

Remarks

The EventList event is fired for each event retrieved from the server when ListEvents is called. This event provides details about each event, including its Id, the CalendarId it belongs to, the Subject (title or description), and the StartTime and EndTime times.

Log Event (GoogleCalendars Component)

Fired once for each log message.

Syntax

typedef struct {
  int LogLevel;
  String Message;
  String LogType;
} TccGoogleCalendarsLogEventParams;
typedef void __fastcall (__closure *TccGoogleCalendarsLogEvent)(System::TObject* Sender, TccGoogleCalendarsLogEventParams *e);
__property TccGoogleCalendarsLogEvent OnLog = { read=FOnLog, write=FOnLog };

Remarks

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

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

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

Fired after the server presents its certificate to the client.

Syntax

typedef struct {
  String CertEncoded;
  DynamicArray<Byte> CertEncodedB;
  String CertSubject;
  String CertIssuer;
  String Status;
  bool Accept;
} TccGoogleCalendarsSSLServerAuthenticationEventParams;
typedef void __fastcall (__closure *TccGoogleCalendarsSSLServerAuthenticationEvent)(System::TObject* Sender, TccGoogleCalendarsSSLServerAuthenticationEventParams *e);
__property TccGoogleCalendarsSSLServerAuthenticationEvent OnSSLServerAuthentication = { read=FOnSSLServerAuthentication, write=FOnSSLServerAuthentication };

Remarks

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

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

SSLStatus Event (GoogleCalendars Component)

Fired when secure connection progress messages are available.

Syntax

typedef struct {
  String Message;
} TccGoogleCalendarsSSLStatusEventParams;
typedef void __fastcall (__closure *TccGoogleCalendarsSSLStatusEvent)(System::TObject* Sender, TccGoogleCalendarsSSLStatusEventParams *e);
__property TccGoogleCalendarsSSLStatusEvent OnSSLStatus = { read=FOnSSLStatus, write=FOnSSLStatus };

Remarks

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

Transfer Event (GoogleCalendars Component)

Fired while a document transfers (delivers document).

Syntax

typedef struct {
  int Direction;
  __int64 BytesTransferred;
  int PercentDone;
  String Text;
  DynamicArray<Byte> TextB;
} TccGoogleCalendarsTransferEventParams;
typedef void __fastcall (__closure *TccGoogleCalendarsTransferEvent)(System::TObject* Sender, TccGoogleCalendarsTransferEventParams *e);
__property TccGoogleCalendarsTransferEvent OnTransfer = { read=FOnTransfer, write=FOnTransfer };

Remarks

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

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

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

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

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

Config Settings (GoogleCalendars Component)

GoogleCalendars 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