GoogleCalendars Class

Properties   Methods   Events   Config Settings   Errors  

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

Syntax

class cloudcalendars.GoogleCalendars

Remarks

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

This class requires authentication via OAuth 2.0. First, perform OAuth authentication using the o_auth property to set the appropriate fields for the chosen o_auth_client_profile and o_auth_grant_type.

The class has the following defaults:

Below is a brief description of the different o_auth_client_profile and o_auth_grant_type values that are supported by this class. 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 class. 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 o_auth_access_token property will be populated. Additionally, if a refresh token was provided the o_auth_refresh_token property will be populated as well. These values of the fields are for informational purposes. The class will also cache these tokens along with when the o_auth_access_token will be expired. When a method that makes requests to the service provider is called or the authorize method is called the class will automatically check to see if the access token is expired. If it is, it will then automatically try to get a new o_auth_access_token. If the authorize method was not used and user interaction would be required, the class will throw an error which can be caught. When user interaction is needed depends on what grant type is set in the o_auth_grant_type 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 o_auth_grant_type property are below. For more information, see the service documentation.

Authorization Code

When using the Authorization Code grant type, the class will use an authorization code to get an access token. For this o_auth_grant_type the class expects a o_auth_client_id, o_auth_client_secret, o_auth_server_auth_url, and o_auth_server_token_url 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 class will parse the authorization code, setting the o_auth_authorization_code property, from the redirect. Immediately, the class 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 o_auth_refresh_token property is set, or a refresh token is cached, then the class 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 class will request the authorization server to get an access token. For this o_auth_grant_type the class expects a o_auth_client_id, o_auth_client_secret, and o_auth_server_auth_url 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 class 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 class 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 class to ignore the values set in the o_auth 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 create_calendar method. The create_calendar 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 update_calendar 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 list_calendars method is called.

By default, the component will fetch one page of 100 calendars when list_calendars 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 list_calendars 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 create_event 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 update_event 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 delete_event 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 list_events 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 class with short descriptions. Click on the links for further details.

Method List

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

Event List

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

Config Settings

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

authorization Property

An OAuth Authorization String.

Syntax

def get_authorization() -> str: ...
def set_authorization(value: str) -> None: ...

authorization = property(get_authorization, set_authorization)

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

calendars_count Property

The number of records in the Calendar arrays.

Syntax

def get_calendars_count() -> int: ...
def set_calendars_count(value: int) -> None: ...

calendars_count = property(get_calendars_count, set_calendars_count)

Default Value

0

Remarks

This property controls the size of the following arrays:

• calendar_background_color
• calendar_color_id
• calendar_description
• calendar_foreground_color
• calendar_id
• calendar_location
• calendar_summary

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

calendar_background_color Property

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

Syntax

def get_calendar_background_color(calendar_index: int) -> str: ...

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 calendar_index parameter specifies the index of the item in the array. The size of the array is controlled by the calendars_count property.

This property is read-only.

calendar_color_id Property

The color of the calendar.

Syntax

def get_calendar_color_id(calendar_index: int) -> str: ...

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 calendar_index parameter specifies the index of the item in the array. The size of the array is controlled by the calendars_count property.

This property is read-only.

calendar_description Property

Description of the calendar.

Syntax

def get_calendar_description(calendar_index: int) -> str: ...
def set_calendar_description(calendar_index: int, value: str) -> None: ...

Default Value

""

Remarks

Description of the calendar

The calendar_index parameter specifies the index of the item in the array. The size of the array is controlled by the calendars_count property.

calendar_foreground_color Property

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

Syntax

def get_calendar_foreground_color(calendar_index: int) -> str: ...

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 calendar_index parameter specifies the index of the item in the array. The size of the array is controlled by the calendars_count property.

This property is read-only.

calendar_id Property

The unique identifier of the calendar.

Syntax

def get_calendar_id(calendar_index: int) -> str: ...

Default Value

""

Remarks

The unique identifier of the calendar.

The calendar_index parameter specifies the index of the item in the array. The size of the array is controlled by the calendars_count property.

This property is read-only.

calendar_location Property

Geographic location of the calendar as free-form text.

Syntax

def get_calendar_location(calendar_index: int) -> str: ...
def set_calendar_location(calendar_index: int, value: str) -> None: ...

Default Value

""

Remarks

Geographic location of the calendar as free-form text.

The calendar_index parameter specifies the index of the item in the array. The size of the array is controlled by the calendars_count property.

calendar_summary Property

Title of the calendar.

Syntax

def get_calendar_summary(calendar_index: int) -> str: ...
def set_calendar_summary(calendar_index: int, value: str) -> None: ...

Default Value

""

Remarks

Title of the calendar.

The calendar_index parameter specifies the index of the item in the array. The size of the array is controlled by the calendars_count property.

colors_count Property

The number of records in the Color arrays.

Syntax

def get_colors_count() -> int: ...

colors_count = property(get_colors_count, None)

Default Value

0

Remarks

This property controls the size of the following arrays:

• color_background
• color_foreground
• color_key
• color_of_event

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

This property is read-only.

color_background Property

The background color associated with this color definition.

Syntax

def get_color_background(color_index: int) -> str: ...

Default Value

""

Remarks

The background color associated with this color definition.

The color_index parameter specifies the index of the item in the array. The size of the array is controlled by the colors_count property.

This property is read-only.

color_foreground Property

The foreground color associated with this color definition.

Syntax

def get_color_foreground(color_index: int) -> str: ...

Default Value

""

Remarks

The foreground color associated with this color definition.

The color_index parameter specifies the index of the item in the array. The size of the array is controlled by the colors_count property.

This property is read-only.

color_key Property

The ID of the color definition.

Syntax

def get_color_key(color_index: int) -> str: ...

Default Value

""

Remarks

The ID of the color definition

The color_index parameter specifies the index of the item in the array. The size of the array is controlled by the colors_count property.

This property is read-only.

color_of_event Property

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

Syntax

def get_color_of_event(color_index: int) -> bool: ...

Default Value

FALSE

Remarks

Indicates the color for the events, otherwise - for calendars

The color_index parameter specifies the index of the item in the array. The size of the array is controlled by the colors_count property.

This property is read-only.

events_count Property

The number of records in the Event arrays.

Syntax

def get_events_count() -> int: ...
def set_events_count(value: int) -> None: ...

events_count = property(get_events_count, set_events_count)

Default Value

0

Remarks

This property controls the size of the following arrays:

• event_attachment_file_id
• event_attachment_file_url
• event_attachment_icon_link
• event_attachment_index
• event_attachment_mime_type
• event_attachments_count
• event_attachment_title
• event_attendee_additional_guests
• event_attendee_comment
• event_attendee_display_name
• event_attendee_email
• event_attendee_id
• event_attendee_index
• event_attendee_optional
• event_attendee_organizer
• event_attendee_resource
• event_attendee_response_status
• event_attendees_count
• event_attendee_self
• event_calendar_id
• event_color_id
• event_created
• event_description
• event_end_date_time
• event_end_time_zone
• event_id
• event_json
• event_location
• event_original_start_date_time
• event_original_start_time_zone
• event_recurrence
• event_recurrence_index
• event_recurrences_count
• event_recurring_event_id
• event_reminders_override_index
• event_reminders_override_method
• event_reminders_override_minutes
• event_reminders_overrides_count
• event_reminder_use_default
• event_start_date_time
• event_start_time_zone
• event_summary
• event_transparency
• event_updated
• event_visibility

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

event_attachment_file_id Property

ID of the attached file.

Syntax

def get_event_attachment_file_id(event_index: int) -> str: ...

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 event_index parameter specifies the index of the item in the array. The size of the array is controlled by the events_count property.

This property is read-only.

event_attachment_file_url Property

URL link to the attachment.

Syntax

def get_event_attachment_file_url(event_index: int) -> str: ...
def set_event_attachment_file_url(event_index: int, value: str) -> None: ...

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 event_index parameter specifies the index of the item in the array. The size of the array is controlled by the events_count property.

event_attachment_icon_link Property

URL link to the attachment's icon.

Syntax

def get_event_attachment_icon_link(event_index: int) -> str: ...
def set_event_attachment_icon_link(event_index: int, value: str) -> None: ...

Default Value

""

Remarks

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

The event_index parameter specifies the index of the item in the array. The size of the array is controlled by the events_count property.

event_attachment_index Property

Index of attachment to get or set its properties.

Syntax

def get_event_attachment_index(event_index: int) -> int: ...
def set_event_attachment_index(event_index: int, value: int) -> None: ...

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 event_index parameter specifies the index of the item in the array. The size of the array is controlled by the events_count property.

event_attachment_mime_type Property

Internet media type (MIME type) of the attachment.

Syntax

def get_event_attachment_mime_type(event_index: int) -> str: ...
def set_event_attachment_mime_type(event_index: int, value: str) -> None: ...

Default Value

""

Remarks

Internet media type (MIME type) of the attachment

The event_index parameter specifies the index of the item in the array. The size of the array is controlled by the events_count property.

event_attachments_count Property

Number of file attachments for the event.

Syntax

def get_event_attachments_count(event_index: int) -> int: ...
def set_event_attachments_count(event_index: int, value: int) -> None: ...

Default Value

0

Remarks

Number of file attachments for the event

The event_index parameter specifies the index of the item in the array. The size of the array is controlled by the events_count property.

event_attachment_title Property

Attachment title.

Syntax

def get_event_attachment_title(event_index: int) -> str: ...
def set_event_attachment_title(event_index: int, value: str) -> None: ...

Default Value

""

Remarks

Attachment title

The event_index parameter specifies the index of the item in the array. The size of the array is controlled by the events_count property.

event_attendee_additional_guests Property

Number of additional guests associated with the current attendee.

Syntax

def get_event_attendee_additional_guests(event_index: int) -> int: ...
def set_event_attendee_additional_guests(event_index: int, value: int) -> None: ...

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 event_index parameter specifies the index of the item in the array. The size of the array is controlled by the events_count property.

event_attendee_comment Property

The attendee's response comment.

Syntax

def get_event_attendee_comment(event_index: int) -> str: ...
def set_event_attendee_comment(event_index: int, value: str) -> None: ...

Default Value

""

Remarks

The attendee's response comment

The event_index parameter specifies the index of the item in the array. The size of the array is controlled by the events_count property.

event_attendee_display_name Property

The attendee's name, if available.

Syntax

def get_event_attendee_display_name(event_index: int) -> str: ...
def set_event_attendee_display_name(event_index: int, value: str) -> None: ...

Default Value

""

Remarks

The attendee's name, if available

The event_index parameter specifies the index of the item in the array. The size of the array is controlled by the events_count property.

event_attendee_email Property

Attendee email address.

Syntax

def get_event_attendee_email(event_index: int) -> str: ...
def set_event_attendee_email(event_index: int, value: str) -> None: ...

Default Value

""

Remarks

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

The event_index parameter specifies the index of the item in the array. The size of the array is controlled by the events_count property.

event_attendee_id Property

The attendee's Profile ID, if available.

Syntax

def get_event_attendee_id(event_index: int) -> str: ...

Default Value

""

Remarks

The attendee's Profile ID, if available

The event_index parameter specifies the index of the item in the array. The size of the array is controlled by the events_count property.

This property is read-only.

event_attendee_index Property

Index of attendee to get or set its properties.

Syntax

def get_event_attendee_index(event_index: int) -> int: ...
def set_event_attendee_index(event_index: int, value: int) -> None: ...

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 event_index parameter specifies the index of the item in the array. The size of the array is controlled by the events_count property.

event_attendee_optional Property

Whether this is an optional attendee.

Syntax

def get_event_attendee_optional(event_index: int) -> bool: ...
def set_event_attendee_optional(event_index: int, value: bool) -> None: ...

Default Value

FALSE

Remarks

Whether this is an optional attendee

The event_index parameter specifies the index of the item in the array. The size of the array is controlled by the events_count property.

event_attendee_organizer Property

Whether the attendee is the organizer of the event.

Syntax

def get_event_attendee_organizer(event_index: int) -> bool: ...
def set_event_attendee_organizer(event_index: int, value: bool) -> None: ...

Default Value

FALSE

Remarks

Whether the attendee is the organizer of the event

The event_index parameter specifies the index of the item in the array. The size of the array is controlled by the events_count property.

event_attendee_resource Property

Whether the attendee is a resource.

Syntax

def get_event_attendee_resource(event_index: int) -> bool: ...
def set_event_attendee_resource(event_index: int, value: bool) -> None: ...

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 event_index parameter specifies the index of the item in the array. The size of the array is controlled by the events_count property.

event_attendee_response_status Property

The attendee's response status.

Syntax

def get_event_attendee_response_status(event_index: int) -> int: ...
def set_event_attendee_response_status(event_index: int, value: int) -> None: ...

Default Value

0

Remarks

The attendee's response status.

Possible values are:

The event_index parameter specifies the index of the item in the array. The size of the array is controlled by the events_count property.

event_attendees_count Property

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

Syntax

def get_event_attendees_count(event_index: int) -> int: ...
def set_event_attendees_count(event_index: int, value: int) -> None: ...

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 event_index parameter specifies the index of the item in the array. The size of the array is controlled by the events_count property.

event_attendee_self Property

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

Syntax

def get_event_attendee_self(event_index: int) -> bool: ...

Default Value

FALSE

Remarks

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

The event_index parameter specifies the index of the item in the array. The size of the array is controlled by the events_count property.

This property is read-only.

event_calendar_id Property

The ID of the calendar that contains the event.

Syntax

def get_event_calendar_id(event_index: int) -> str: ...

Default Value

""

Remarks

The ID of the calendar that contains the event.

The event_index parameter specifies the index of the item in the array. The size of the array is controlled by the events_count property.

This property is read-only.

event_color_id Property

The color of the event.

Syntax

def get_event_color_id(event_index: int) -> str: ...
def set_event_color_id(event_index: int, value: str) -> None: ...

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 event_index parameter specifies the index of the item in the array. The size of the array is controlled by the events_count property.

event_created Property

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

Syntax

def get_event_created(event_index: int) -> str: ...

Default Value

""

Remarks

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

The event_index parameter specifies the index of the item in the array. The size of the array is controlled by the events_count property.

This property is read-only.

event_description Property

Description of the event.

Syntax

def get_event_description(event_index: int) -> str: ...
def set_event_description(event_index: int, value: str) -> None: ...

Default Value

""

Remarks

Description of the event. Can contain HTML.

The event_index parameter specifies the index of the item in the array. The size of the array is controlled by the events_count property.

event_end_date_time Property

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

Syntax

def get_event_end_date_time(event_index: int) -> str: ...
def set_event_end_date_time(event_index: int, value: str) -> None: ...

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 event_index parameter specifies the index of the item in the array. The size of the array is controlled by the events_count property.

event_end_time_zone Property

The time zone in which the time is specified.

Syntax

def get_event_end_time_zone(event_index: int) -> str: ...
def set_event_end_time_zone(event_index: int, value: str) -> None: ...

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 event_index parameter specifies the index of the item in the array. The size of the array is controlled by the events_count property.

event_id Property

Unique identifier for the event.

Syntax

def get_event_id(event_index: int) -> str: ...

Default Value

""

Remarks

Unique identifier for the event.

The event_index parameter specifies the index of the item in the array. The size of the array is controlled by the events_count property.

This property is read-only.

event_json Property

A JSON representation of the event.

Syntax

def get_event_json(event_index: int) -> str: ...
def set_event_json(event_index: int, value: str) -> None: ...

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 event_index parameter specifies the index of the item in the array. The size of the array is controlled by the events_count property.

event_location Property

Geographic location of the event as free-form text.

Syntax

def get_event_location(event_index: int) -> str: ...
def set_event_location(event_index: int, value: str) -> None: ...

Default Value

""

Remarks

Geographic location of the event as free-form text.

The event_index parameter specifies the index of the item in the array. The size of the array is controlled by the events_count property.

event_original_start_date_time Property

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

def get_event_original_start_date_time(event_index: int) -> str: ...

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 event_index parameter specifies the index of the item in the array. The size of the array is controlled by the events_count property.

This property is read-only.

event_original_start_time_zone Property

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

def get_event_original_start_time_zone(event_index: int) -> str: ...

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 event_index parameter specifies the index of the item in the array. The size of the array is controlled by the events_count property.

This property is read-only.

event_recurrence Property

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

Syntax

def get_event_recurrence(event_index: int) -> str: ...
def set_event_recurrence(event_index: int, value: str) -> None: ...

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 event_index parameter specifies the index of the item in the array. The size of the array is controlled by the events_count property.

event_recurrence_index Property

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

Syntax

def get_event_recurrence_index(event_index: int) -> int: ...
def set_event_recurrence_index(event_index: int, value: int) -> None: ...

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 event_index parameter specifies the index of the item in the array. The size of the array is controlled by the events_count property.

event_recurrences_count Property

Number of recurrence lines for the event.

Syntax

def get_event_recurrences_count(event_index: int) -> int: ...
def set_event_recurrences_count(event_index: int, value: int) -> None: ...

Default Value

0

Remarks

Number of recurrence lines for the event.

The event_index parameter specifies the index of the item in the array. The size of the array is controlled by the events_count property.

event_recurring_event_id Property

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

Syntax

def get_event_recurring_event_id(event_index: int) -> str: ...

Default Value

""

Remarks

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

The event_index parameter specifies the index of the item in the array. The size of the array is controlled by the events_count property.

This property is read-only.

event_reminders_override_index Property

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

Syntax

def get_event_reminders_override_index(event_index: int) -> int: ...
def set_event_reminders_override_index(event_index: int, value: int) -> None: ...

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 event_index parameter specifies the index of the item in the array. The size of the array is controlled by the events_count property.

event_reminders_override_method Property

The method used by this reminder.

Syntax

def get_event_reminders_override_method(event_index: int) -> int: ...
def set_event_reminders_override_method(event_index: int, value: int) -> None: ...

Default Value

0

Remarks

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

Possible values are:

The event_index parameter specifies the index of the item in the array. The size of the array is controlled by the events_count property.

event_reminders_override_minutes Property

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

Syntax

def get_event_reminders_override_minutes(event_index: int) -> int: ...
def set_event_reminders_override_minutes(event_index: int, value: int) -> None: ...

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 event_index parameter specifies the index of the item in the array. The size of the array is controlled by the events_count property.

event_reminders_overrides_count Property

number of reminders overrides for the event.

Syntax

def get_event_reminders_overrides_count(event_index: int) -> int: ...
def set_event_reminders_overrides_count(event_index: int, value: int) -> None: ...

Default Value

0

Remarks

number of reminders overrides for the event

The event_index parameter specifies the index of the item in the array. The size of the array is controlled by the events_count property.

event_reminder_use_default Property

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

Syntax

def get_event_reminder_use_default(event_index: int) -> bool: ...
def set_event_reminder_use_default(event_index: int, value: bool) -> None: ...

Default Value

FALSE

Remarks

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

The event_index parameter specifies the index of the item in the array. The size of the array is controlled by the events_count property.

event_start_date_time Property

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

Syntax

def get_event_start_date_time(event_index: int) -> str: ...
def set_event_start_date_time(event_index: int, value: str) -> None: ...

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 event_index parameter specifies the index of the item in the array. The size of the array is controlled by the events_count property.

event_start_time_zone Property

The time zone in which the time is specified.

Syntax

def get_event_start_time_zone(event_index: int) -> str: ...
def set_event_start_time_zone(event_index: int, value: str) -> None: ...

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 event_index parameter specifies the index of the item in the array. The size of the array is controlled by the events_count property.

event_summary Property

Title of the event.

Syntax

def get_event_summary(event_index: int) -> str: ...
def set_event_summary(event_index: int, value: str) -> None: ...

Default Value

""

Remarks

Title of the event.

The event_index parameter specifies the index of the item in the array. The size of the array is controlled by the events_count property.

event_transparency Property

Whether the event blocks time on the calendar.

Syntax

def get_event_transparency(event_index: int) -> int: ...
def set_event_transparency(event_index: int, value: int) -> None: ...

Default Value

0

Remarks

Whether the event blocks time on the calendar. Optional.

Possible values are:

The event_index parameter specifies the index of the item in the array. The size of the array is controlled by the events_count property.

event_updated Property

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

Syntax

def get_event_updated(event_index: int) -> str: ...

Default Value

""

Remarks

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

The event_index parameter specifies the index of the item in the array. The size of the array is controlled by the events_count property.

This property is read-only.

event_visibility Property

Visibility of the event.

Syntax

def get_event_visibility(event_index: int) -> int: ...
def set_event_visibility(event_index: int, value: int) -> None: ...

Default Value

0

Remarks

Visibility of the event. Possible values are:

Possible values are:

The event_index parameter specifies the index of the item in the array. The size of the array is controlled by the events_count property.

firewall_auto_detect Property

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

Syntax

def get_firewall_auto_detect() -> bool: ...
def set_firewall_auto_detect(value: bool) -> None: ...

firewall_auto_detect = property(get_firewall_auto_detect, set_firewall_auto_detect)

Default Value

FALSE

Remarks

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

firewall_type Property

The type of firewall to connect through.

Syntax

def get_firewall_type() -> int: ...
def set_firewall_type(value: int) -> None: ...

firewall_type = property(get_firewall_type, set_firewall_type)

Default Value

0

Remarks

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

firewall_host Property

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

Syntax

def get_firewall_host() -> str: ...
def set_firewall_host(value: str) -> None: ...

firewall_host = property(get_firewall_host, set_firewall_host)

Default Value

""

Remarks

The name or IP address of the firewall (optional). If a firewall_host 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 class fails with an error.

firewall_password Property

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

Syntax

def get_firewall_password() -> str: ...
def set_firewall_password(value: str) -> None: ...

firewall_password = property(get_firewall_password, set_firewall_password)

Default Value

""

Remarks

A password if authentication is to be used when connecting through the firewall. If firewall_host is specified, the firewall_user and firewall_password properties are used to connect and authenticate to the given firewall. If the authentication fails, the class fails with an error.

firewall_port Property

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

Syntax

def get_firewall_port() -> int: ...
def set_firewall_port(value: int) -> None: ...

firewall_port = property(get_firewall_port, set_firewall_port)

Default Value

0

Remarks

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

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

firewall_user Property

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

Syntax

def get_firewall_user() -> str: ...
def set_firewall_user(value: str) -> None: ...

firewall_user = property(get_firewall_user, set_firewall_user)

Default Value

""

Remarks

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

list_events_marker Property

The page marker for listing events.

Syntax

def get_list_events_marker() -> str: ...
def set_list_events_marker(value: str) -> None: ...

list_events_marker = property(get_list_events_marker, set_list_events_marker)

Default Value

""

Remarks

This property is populated if there are still unlisted events after list_events is called. It contains the nextPageToken that will be included in the next request as a parameter if list_events 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);

o_auth_access_token Property

The access token returned by the authorization server.

Syntax

def get_o_auth_access_token() -> str: ...
def set_o_auth_access_token(value: str) -> None: ...

o_auth_access_token = property(get_o_auth_access_token, set_o_auth_access_token)

Default Value

""

Remarks

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

o_auth_authorization_code Property

The authorization code that is exchanged for an access token.

Syntax

def get_o_auth_authorization_code() -> str: ...
def set_o_auth_authorization_code(value: str) -> None: ...

o_auth_authorization_code = property(get_o_auth_authorization_code, set_o_auth_authorization_code)

Default Value

""

Remarks

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

o_auth_authorization_scope Property

The scope request or response parameter used during authorization.

Syntax

def get_o_auth_authorization_scope() -> str: ...
def set_o_auth_authorization_scope(value: str) -> None: ...

o_auth_authorization_scope = property(get_o_auth_authorization_scope, set_o_auth_authorization_scope)

Default Value

""

Remarks

The scope request or response parameter used during authorization.

o_auth_client_id Property

The id of the client assigned when registering the application.

Syntax

def get_o_auth_client_id() -> str: ...
def set_o_auth_client_id(value: str) -> None: ...

o_auth_client_id = property(get_o_auth_client_id, set_o_auth_client_id)

Default Value

""

Remarks

The id of the client assigned when registering the application.

o_auth_client_profile Property

The type of client that is requesting authorization.

Syntax

def get_o_auth_client_profile() -> int: ...
def set_o_auth_client_profile(value: int) -> None: ...

o_auth_client_profile = property(get_o_auth_client_profile, set_o_auth_client_profile)

Default Value

0

Remarks

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

o_auth_client_secret Property

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

Syntax

def get_o_auth_client_secret() -> str: ...
def set_o_auth_client_secret(value: str) -> None: ...

o_auth_client_secret = property(get_o_auth_client_secret, set_o_auth_client_secret)

Default Value

""

Remarks

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

o_auth_grant_type Property

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

Syntax

def get_o_auth_grant_type() -> int: ...
def set_o_auth_grant_type(value: int) -> None: ...

o_auth_grant_type = property(get_o_auth_grant_type, set_o_auth_grant_type)

Default Value

0

Remarks

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

o_auth_refresh_token Property

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

Syntax

def get_o_auth_refresh_token() -> str: ...
def set_o_auth_refresh_token(value: str) -> None: ...

o_auth_refresh_token = property(get_o_auth_refresh_token, set_o_auth_refresh_token)

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 o_auth_grant_type property is set to a grant that can use refresh tokens.

o_auth_request_refresh_token Property

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

Syntax

def get_o_auth_request_refresh_token() -> bool: ...
def set_o_auth_request_refresh_token(value: bool) -> None: ...

o_auth_request_refresh_token = property(get_o_auth_request_refresh_token, set_o_auth_request_refresh_token)

Default Value

TRUE

Remarks

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

When True, the class 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 o_auth_grant_type property is set to cogtAuthorizationCode.

o_auth_return_url Property

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

Syntax

def get_o_auth_return_url() -> str: ...
def set_o_auth_return_url(value: str) -> None: ...

o_auth_return_url = property(get_o_auth_return_url, set_o_auth_return_url)

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

o_auth_server_auth_url Property

The URL of the authorization server.

Syntax

def get_o_auth_server_auth_url() -> str: ...
def set_o_auth_server_auth_url(value: str) -> None: ...

o_auth_server_auth_url = property(get_o_auth_server_auth_url, set_o_auth_server_auth_url)

Default Value

""

Remarks

The URL of the authorization server.

o_auth_server_token_url Property

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

Syntax

def get_o_auth_server_token_url() -> str: ...
def set_o_auth_server_token_url(value: str) -> None: ...

o_auth_server_token_url = property(get_o_auth_server_token_url, set_o_auth_server_token_url)

Default Value

""

Remarks

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

o_auth_web_auth_url Property

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

Syntax

def get_o_auth_web_auth_url() -> str: ...

o_auth_web_auth_url = property(get_o_auth_web_auth_url, None)

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.

proxy_auth_scheme Property

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

Syntax

def get_proxy_auth_scheme() -> int: ...
def set_proxy_auth_scheme(value: int) -> None: ...

proxy_auth_scheme = property(get_proxy_auth_scheme, set_proxy_auth_scheme)

Default Value

0

Remarks

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

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

By default, proxy_auth_scheme is authBasic (0), and if the proxy_user and proxy_password properties are set, the class will attempt basic authentication.

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

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

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

For security reasons, setting this property will clear the values of proxy_user and proxy_password.

proxy_auto_detect Property

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

Syntax

def get_proxy_auto_detect() -> bool: ...
def set_proxy_auto_detect(value: bool) -> None: ...

proxy_auto_detect = property(get_proxy_auto_detect, set_proxy_auto_detect)

Default Value

FALSE

Remarks

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

proxy_password Property

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

Syntax

def get_proxy_password() -> str: ...
def set_proxy_password(value: str) -> None: ...

proxy_password = property(get_proxy_password, set_proxy_password)

Default Value

""

Remarks

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

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

If proxy_auth_scheme is set to Digest Authentication, the proxy_user and proxy_password properties are used to respond to the Digest Authentication challenge from the server.

If proxy_auth_scheme is set to NTLM Authentication, the proxy_user and proxy_password properties are used to authenticate through NTLM negotiation.

proxy_port Property

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

Syntax

def get_proxy_port() -> int: ...
def set_proxy_port(value: int) -> None: ...

proxy_port = property(get_proxy_port, set_proxy_port)

Default Value

80

Remarks

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

proxy_server Property

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

Syntax

def get_proxy_server() -> str: ...
def set_proxy_server(value: str) -> None: ...

proxy_server = property(get_proxy_server, set_proxy_server)

Default Value

""

Remarks

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

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

proxy_ssl Property

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

Syntax

def get_proxy_ssl() -> int: ...
def set_proxy_ssl(value: int) -> None: ...

proxy_ssl = property(get_proxy_ssl, set_proxy_ssl)

Default Value

0

Remarks

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

proxy_user Property

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

Syntax

def get_proxy_user() -> str: ...
def set_proxy_user(value: str) -> None: ...

proxy_user = property(get_proxy_user, set_proxy_user)

Default Value

""

Remarks

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

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

If proxy_auth_scheme is set to Digest Authentication, the proxy_user and proxy_password properties are used to respond to the Digest Authentication challenge from the server.

If proxy_auth_scheme is set to NTLM Authentication, the proxy_user and proxy_password properties are used to authenticate through NTLM negotiation.

ssl_accept_server_cert_effective_date Property

The date on which this certificate becomes valid.

Syntax

def get_ssl_accept_server_cert_effective_date() -> str: ...

ssl_accept_server_cert_effective_date = property(get_ssl_accept_server_cert_effective_date, None)

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.

ssl_accept_server_cert_expiration_date Property

The date on which the certificate expires.

Syntax

def get_ssl_accept_server_cert_expiration_date() -> str: ...

ssl_accept_server_cert_expiration_date = property(get_ssl_accept_server_cert_expiration_date, None)

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.

ssl_accept_server_cert_extended_key_usage Property

A comma-delimited list of extended key usage identifiers.

Syntax

def get_ssl_accept_server_cert_extended_key_usage() -> str: ...

ssl_accept_server_cert_extended_key_usage = property(get_ssl_accept_server_cert_extended_key_usage, None)

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.

ssl_accept_server_cert_fingerprint Property

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

Syntax

def get_ssl_accept_server_cert_fingerprint() -> str: ...

ssl_accept_server_cert_fingerprint = property(get_ssl_accept_server_cert_fingerprint, None)

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.

ssl_accept_server_cert_fingerprint_sha1 Property

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

Syntax

def get_ssl_accept_server_cert_fingerprint_sha1() -> str: ...

ssl_accept_server_cert_fingerprint_sha1 = property(get_ssl_accept_server_cert_fingerprint_sha1, None)

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.

ssl_accept_server_cert_fingerprint_sha256 Property

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

Syntax

def get_ssl_accept_server_cert_fingerprint_sha256() -> str: ...

ssl_accept_server_cert_fingerprint_sha256 = property(get_ssl_accept_server_cert_fingerprint_sha256, None)

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.

ssl_accept_server_cert_issuer Property

The issuer of the certificate.

Syntax

def get_ssl_accept_server_cert_issuer() -> str: ...

ssl_accept_server_cert_issuer = property(get_ssl_accept_server_cert_issuer, None)

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.

ssl_accept_server_cert_private_key Property

The private key of the certificate (if available).

Syntax

def get_ssl_accept_server_cert_private_key() -> str: ...

ssl_accept_server_cert_private_key = property(get_ssl_accept_server_cert_private_key, None)

Default Value

""

Remarks

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

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

This property is read-only.

ssl_accept_server_cert_private_key_available Property

Whether a PrivateKey is available for the selected certificate.

Syntax

def get_ssl_accept_server_cert_private_key_available() -> bool: ...

ssl_accept_server_cert_private_key_available = property(get_ssl_accept_server_cert_private_key_available, None)

Default Value

FALSE

Remarks

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

This property is read-only.

ssl_accept_server_cert_private_key_container Property

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

Syntax

def get_ssl_accept_server_cert_private_key_container() -> str: ...

ssl_accept_server_cert_private_key_container = property(get_ssl_accept_server_cert_private_key_container, None)

Default Value

""

Remarks

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

This property is read-only.

ssl_accept_server_cert_public_key Property

The public key of the certificate.

Syntax

def get_ssl_accept_server_cert_public_key() -> str: ...

ssl_accept_server_cert_public_key = property(get_ssl_accept_server_cert_public_key, None)

Default Value

""

Remarks

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

This property is read-only.

ssl_accept_server_cert_public_key_algorithm Property

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

Syntax

def get_ssl_accept_server_cert_public_key_algorithm() -> str: ...

ssl_accept_server_cert_public_key_algorithm = property(get_ssl_accept_server_cert_public_key_algorithm, None)

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.

ssl_accept_server_cert_public_key_length Property

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

Syntax

def get_ssl_accept_server_cert_public_key_length() -> int: ...

ssl_accept_server_cert_public_key_length = property(get_ssl_accept_server_cert_public_key_length, None)

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.

ssl_accept_server_cert_serial_number Property

The serial number of the certificate encoded as a string.

Syntax

def get_ssl_accept_server_cert_serial_number() -> str: ...

ssl_accept_server_cert_serial_number = property(get_ssl_accept_server_cert_serial_number, None)

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.

ssl_accept_server_cert_signature_algorithm Property

The text description of the certificate's signature algorithm.

Syntax

def get_ssl_accept_server_cert_signature_algorithm() -> str: ...

ssl_accept_server_cert_signature_algorithm = property(get_ssl_accept_server_cert_signature_algorithm, None)

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.

ssl_accept_server_cert_store Property

The name of the certificate store for the client certificate.

Syntax

def get_ssl_accept_server_cert_store() -> bytes: ...
def set_ssl_accept_server_cert_store(value: bytes) -> None: ...

ssl_accept_server_cert_store = property(get_ssl_accept_server_cert_store, set_ssl_accept_server_cert_store)

Default Value

"MY"

Remarks

The name of the certificate store for the client certificate.

The ssl_accept_server_cert_store_type property denotes the type of the certificate store specified by ssl_accept_server_cert_store. If the store is password-protected, specify the password in ssl_accept_server_cert_store_password.

ssl_accept_server_cert_store is used in conjunction with the ssl_accept_server_cert_subject property to specify client certificates. If ssl_accept_server_cert_store has a value, and ssl_accept_server_cert_subject or ssl_accept_server_cert_encoded is set, a search for a certificate is initiated. Please see the ssl_accept_server_cert_subject 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).

ssl_accept_server_cert_store_password Property

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

Syntax

def get_ssl_accept_server_cert_store_password() -> str: ...
def set_ssl_accept_server_cert_store_password(value: str) -> None: ...

ssl_accept_server_cert_store_password = property(get_ssl_accept_server_cert_store_password, set_ssl_accept_server_cert_store_password)

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.

ssl_accept_server_cert_store_type Property

The type of certificate store for this certificate.

Syntax

def get_ssl_accept_server_cert_store_type() -> int: ...
def set_ssl_accept_server_cert_store_type(value: int) -> None: ...

ssl_accept_server_cert_store_type = property(get_ssl_accept_server_cert_store_type, set_ssl_accept_server_cert_store_type)

Default Value

0

Remarks

The type of certificate store for this certificate.

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

ssl_accept_server_cert_subject_alt_names Property

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

Syntax

def get_ssl_accept_server_cert_subject_alt_names() -> str: ...

ssl_accept_server_cert_subject_alt_names = property(get_ssl_accept_server_cert_subject_alt_names, None)

Default Value

""

Remarks

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

This property is read-only.

ssl_accept_server_cert_thumbprint_md5 Property

The MD5 hash of the certificate.

Syntax

def get_ssl_accept_server_cert_thumbprint_md5() -> str: ...

ssl_accept_server_cert_thumbprint_md5 = property(get_ssl_accept_server_cert_thumbprint_md5, None)

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.

ssl_accept_server_cert_thumbprint_sha1 Property

The SHA-1 hash of the certificate.

Syntax

def get_ssl_accept_server_cert_thumbprint_sha1() -> str: ...

ssl_accept_server_cert_thumbprint_sha1 = property(get_ssl_accept_server_cert_thumbprint_sha1, None)

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.

ssl_accept_server_cert_thumbprint_sha256 Property

The SHA-256 hash of the certificate.

Syntax

def get_ssl_accept_server_cert_thumbprint_sha256() -> str: ...

ssl_accept_server_cert_thumbprint_sha256 = property(get_ssl_accept_server_cert_thumbprint_sha256, None)

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.

ssl_accept_server_cert_usage Property

The text description of UsageFlags .

Syntax

def get_ssl_accept_server_cert_usage() -> str: ...

ssl_accept_server_cert_usage = property(get_ssl_accept_server_cert_usage, None)

Default Value

""

Remarks

The text description of ssl_accept_server_cert_usage_flags.

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.

ssl_accept_server_cert_usage_flags Property

The flags that show intended use for the certificate.

Syntax

def get_ssl_accept_server_cert_usage_flags() -> int: ...

ssl_accept_server_cert_usage_flags = property(get_ssl_accept_server_cert_usage_flags, None)

Default Value

0

Remarks

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

Please see the ssl_accept_server_cert_usage property for a text representation of ssl_accept_server_cert_usage_flags.

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

This property is read-only.

ssl_accept_server_cert_version Property

The certificate's version number.

Syntax

def get_ssl_accept_server_cert_version() -> str: ...

ssl_accept_server_cert_version = property(get_ssl_accept_server_cert_version, None)

Default Value

""

Remarks

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

This property is read-only.

ssl_accept_server_cert_subject Property

The subject of the certificate used for client authentication.

Syntax

def get_ssl_accept_server_cert_subject() -> str: ...
def set_ssl_accept_server_cert_subject(value: str) -> None: ...

ssl_accept_server_cert_subject = property(get_ssl_accept_server_cert_subject, set_ssl_accept_server_cert_subject)

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.

ssl_accept_server_cert_encoded Property

The certificate (PEM/Base64 encoded).

Syntax

def get_ssl_accept_server_cert_encoded() -> bytes: ...
def set_ssl_accept_server_cert_encoded(value: bytes) -> None: ...

ssl_accept_server_cert_encoded = property(get_ssl_accept_server_cert_encoded, set_ssl_accept_server_cert_encoded)

Default Value

""

Remarks

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

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

ssl_cert_effective_date Property

The date on which this certificate becomes valid.

Syntax

def get_ssl_cert_effective_date() -> str: ...

ssl_cert_effective_date = property(get_ssl_cert_effective_date, None)

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.

ssl_cert_expiration_date Property

The date on which the certificate expires.

Syntax

def get_ssl_cert_expiration_date() -> str: ...

ssl_cert_expiration_date = property(get_ssl_cert_expiration_date, None)

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.

ssl_cert_extended_key_usage Property

A comma-delimited list of extended key usage identifiers.

Syntax

def get_ssl_cert_extended_key_usage() -> str: ...

ssl_cert_extended_key_usage = property(get_ssl_cert_extended_key_usage, None)

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.

ssl_cert_fingerprint Property

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

Syntax

def get_ssl_cert_fingerprint() -> str: ...

ssl_cert_fingerprint = property(get_ssl_cert_fingerprint, None)

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.

ssl_cert_fingerprint_sha1 Property

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

Syntax

def get_ssl_cert_fingerprint_sha1() -> str: ...

ssl_cert_fingerprint_sha1 = property(get_ssl_cert_fingerprint_sha1, None)

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.

ssl_cert_fingerprint_sha256 Property

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

Syntax

def get_ssl_cert_fingerprint_sha256() -> str: ...

ssl_cert_fingerprint_sha256 = property(get_ssl_cert_fingerprint_sha256, None)

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.

ssl_cert_issuer Property

The issuer of the certificate.

Syntax

def get_ssl_cert_issuer() -> str: ...

ssl_cert_issuer = property(get_ssl_cert_issuer, None)

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.

ssl_cert_private_key Property

The private key of the certificate (if available).

Syntax

def get_ssl_cert_private_key() -> str: ...

ssl_cert_private_key = property(get_ssl_cert_private_key, None)

Default Value

""

Remarks

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

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

This property is read-only.

ssl_cert_private_key_available Property

Whether a PrivateKey is available for the selected certificate.

Syntax

def get_ssl_cert_private_key_available() -> bool: ...

ssl_cert_private_key_available = property(get_ssl_cert_private_key_available, None)

Default Value

FALSE

Remarks

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

This property is read-only.

ssl_cert_private_key_container Property

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

Syntax

def get_ssl_cert_private_key_container() -> str: ...

ssl_cert_private_key_container = property(get_ssl_cert_private_key_container, None)

Default Value

""

Remarks

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

This property is read-only.

ssl_cert_public_key Property

The public key of the certificate.

Syntax

def get_ssl_cert_public_key() -> str: ...

ssl_cert_public_key = property(get_ssl_cert_public_key, None)

Default Value

""

Remarks

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

This property is read-only.

ssl_cert_public_key_algorithm Property

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

Syntax

def get_ssl_cert_public_key_algorithm() -> str: ...

ssl_cert_public_key_algorithm = property(get_ssl_cert_public_key_algorithm, None)

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.

ssl_cert_public_key_length Property

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

Syntax

def get_ssl_cert_public_key_length() -> int: ...

ssl_cert_public_key_length = property(get_ssl_cert_public_key_length, None)

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.

ssl_cert_serial_number Property

The serial number of the certificate encoded as a string.

Syntax

def get_ssl_cert_serial_number() -> str: ...

ssl_cert_serial_number = property(get_ssl_cert_serial_number, None)

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.

ssl_cert_signature_algorithm Property

The text description of the certificate's signature algorithm.

Syntax

def get_ssl_cert_signature_algorithm() -> str: ...

ssl_cert_signature_algorithm = property(get_ssl_cert_signature_algorithm, None)

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.

ssl_cert_store Property

The name of the certificate store for the client certificate.

Syntax

def get_ssl_cert_store() -> bytes: ...
def set_ssl_cert_store(value: bytes) -> None: ...

ssl_cert_store = property(get_ssl_cert_store, set_ssl_cert_store)

Default Value

"MY"

Remarks

The name of the certificate store for the client certificate.

The ssl_cert_store_type property denotes the type of the certificate store specified by ssl_cert_store. If the store is password-protected, specify the password in ssl_cert_store_password.

ssl_cert_store is used in conjunction with the ssl_cert_subject property to specify client certificates. If ssl_cert_store has a value, and ssl_cert_subject or ssl_cert_encoded is set, a search for a certificate is initiated. Please see the ssl_cert_subject 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).

ssl_cert_store_password Property

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

Syntax

def get_ssl_cert_store_password() -> str: ...
def set_ssl_cert_store_password(value: str) -> None: ...

ssl_cert_store_password = property(get_ssl_cert_store_password, set_ssl_cert_store_password)

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.

ssl_cert_store_type Property

The type of certificate store for this certificate.

Syntax

def get_ssl_cert_store_type() -> int: ...
def set_ssl_cert_store_type(value: int) -> None: ...

ssl_cert_store_type = property(get_ssl_cert_store_type, set_ssl_cert_store_type)

Default Value

0

Remarks

The type of certificate store for this certificate.

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

ssl_cert_subject_alt_names Property

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

Syntax

def get_ssl_cert_subject_alt_names() -> str: ...

ssl_cert_subject_alt_names = property(get_ssl_cert_subject_alt_names, None)

Default Value

""

Remarks

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

This property is read-only.

ssl_cert_thumbprint_md5 Property

The MD5 hash of the certificate.

Syntax

def get_ssl_cert_thumbprint_md5() -> str: ...

ssl_cert_thumbprint_md5 = property(get_ssl_cert_thumbprint_md5, None)

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.

ssl_cert_thumbprint_sha1 Property

The SHA-1 hash of the certificate.

Syntax

def get_ssl_cert_thumbprint_sha1() -> str: ...

ssl_cert_thumbprint_sha1 = property(get_ssl_cert_thumbprint_sha1, None)

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.

ssl_cert_thumbprint_sha256 Property

The SHA-256 hash of the certificate.

Syntax

def get_ssl_cert_thumbprint_sha256() -> str: ...

ssl_cert_thumbprint_sha256 = property(get_ssl_cert_thumbprint_sha256, None)

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.

ssl_cert_usage Property

The text description of UsageFlags .

Syntax

def get_ssl_cert_usage() -> str: ...

ssl_cert_usage = property(get_ssl_cert_usage, None)

Default Value

""

Remarks

The text description of ssl_cert_usage_flags.

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.

ssl_cert_usage_flags Property

The flags that show intended use for the certificate.

Syntax

def get_ssl_cert_usage_flags() -> int: ...

ssl_cert_usage_flags = property(get_ssl_cert_usage_flags, None)

Default Value

0

Remarks

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

Please see the ssl_cert_usage property for a text representation of ssl_cert_usage_flags.

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

This property is read-only.

ssl_cert_version Property

The certificate's version number.

Syntax

def get_ssl_cert_version() -> str: ...

ssl_cert_version = property(get_ssl_cert_version, None)

Default Value

""

Remarks

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

This property is read-only.

ssl_cert_subject Property

The subject of the certificate used for client authentication.

Syntax

def get_ssl_cert_subject() -> str: ...
def set_ssl_cert_subject(value: str) -> None: ...

ssl_cert_subject = property(get_ssl_cert_subject, set_ssl_cert_subject)

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.

ssl_cert_encoded Property

The certificate (PEM/Base64 encoded).

Syntax

def get_ssl_cert_encoded() -> bytes: ...
def set_ssl_cert_encoded(value: bytes) -> None: ...

ssl_cert_encoded = property(get_ssl_cert_encoded, set_ssl_cert_encoded)

Default Value

""

Remarks

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

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

ssl_provider Property

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

Syntax

def get_ssl_provider() -> int: ...
def set_ssl_provider(value: int) -> None: ...

ssl_provider = property(get_ssl_provider, set_ssl_provider)

Default Value

0

Remarks

This property specifies the SSL/TLS implementation to use. In most cases the default value of 0 (Automatic) is recommended and should not be changed. When set to 0 (Automatic), the class 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 class will select a provider depending on the current platform.

When Automatic is selected, on Windows, the class will use the platform implementation. On Linux/macOS, the class will use the internal implementation. When TLS 1.3 is enabled via SSLEnabledProtocols, the internal implementation is used on all platforms.

ssl_server_cert_effective_date Property

The date on which this certificate becomes valid.

Syntax

def get_ssl_server_cert_effective_date() -> str: ...

ssl_server_cert_effective_date = property(get_ssl_server_cert_effective_date, None)

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.

ssl_server_cert_expiration_date Property

The date on which the certificate expires.

Syntax

def get_ssl_server_cert_expiration_date() -> str: ...

ssl_server_cert_expiration_date = property(get_ssl_server_cert_expiration_date, None)

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.

ssl_server_cert_extended_key_usage Property

A comma-delimited list of extended key usage identifiers.

Syntax

def get_ssl_server_cert_extended_key_usage() -> str: ...

ssl_server_cert_extended_key_usage = property(get_ssl_server_cert_extended_key_usage, None)

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.

ssl_server_cert_fingerprint Property

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

Syntax

def get_ssl_server_cert_fingerprint() -> str: ...

ssl_server_cert_fingerprint = property(get_ssl_server_cert_fingerprint, None)

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.

ssl_server_cert_fingerprint_sha1 Property

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

Syntax

def get_ssl_server_cert_fingerprint_sha1() -> str: ...

ssl_server_cert_fingerprint_sha1 = property(get_ssl_server_cert_fingerprint_sha1, None)

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.

ssl_server_cert_fingerprint_sha256 Property

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

Syntax

def get_ssl_server_cert_fingerprint_sha256() -> str: ...

ssl_server_cert_fingerprint_sha256 = property(get_ssl_server_cert_fingerprint_sha256, None)

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.

ssl_server_cert_issuer Property

The issuer of the certificate.

Syntax

def get_ssl_server_cert_issuer() -> str: ...

ssl_server_cert_issuer = property(get_ssl_server_cert_issuer, None)

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.

ssl_server_cert_private_key Property

The private key of the certificate (if available).

Syntax

def get_ssl_server_cert_private_key() -> str: ...

ssl_server_cert_private_key = property(get_ssl_server_cert_private_key, None)

Default Value

""

Remarks

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

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

This property is read-only.

ssl_server_cert_private_key_available Property

Whether a PrivateKey is available for the selected certificate.

Syntax

def get_ssl_server_cert_private_key_available() -> bool: ...

ssl_server_cert_private_key_available = property(get_ssl_server_cert_private_key_available, None)

Default Value

FALSE

Remarks

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

This property is read-only.

ssl_server_cert_private_key_container Property

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

Syntax

def get_ssl_server_cert_private_key_container() -> str: ...

ssl_server_cert_private_key_container = property(get_ssl_server_cert_private_key_container, None)

Default Value

""

Remarks

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

This property is read-only.

ssl_server_cert_public_key Property

The public key of the certificate.

Syntax

def get_ssl_server_cert_public_key() -> str: ...

ssl_server_cert_public_key = property(get_ssl_server_cert_public_key, None)

Default Value

""

Remarks

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

This property is read-only.

ssl_server_cert_public_key_algorithm Property

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

Syntax

def get_ssl_server_cert_public_key_algorithm() -> str: ...

ssl_server_cert_public_key_algorithm = property(get_ssl_server_cert_public_key_algorithm, None)

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.

ssl_server_cert_public_key_length Property

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

Syntax

def get_ssl_server_cert_public_key_length() -> int: ...

ssl_server_cert_public_key_length = property(get_ssl_server_cert_public_key_length, None)

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.

ssl_server_cert_serial_number Property

The serial number of the certificate encoded as a string.

Syntax

def get_ssl_server_cert_serial_number() -> str: ...

ssl_server_cert_serial_number = property(get_ssl_server_cert_serial_number, None)

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.

ssl_server_cert_signature_algorithm Property

The text description of the certificate's signature algorithm.

Syntax

def get_ssl_server_cert_signature_algorithm() -> str: ...

ssl_server_cert_signature_algorithm = property(get_ssl_server_cert_signature_algorithm, None)

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.

ssl_server_cert_store Property

The name of the certificate store for the client certificate.

Syntax

def get_ssl_server_cert_store() -> bytes: ...

ssl_server_cert_store = property(get_ssl_server_cert_store, None)

Default Value

"MY"

Remarks

The name of the certificate store for the client certificate.

The ssl_server_cert_store_type property denotes the type of the certificate store specified by ssl_server_cert_store. If the store is password-protected, specify the password in ssl_server_cert_store_password.

ssl_server_cert_store is used in conjunction with the ssl_server_cert_subject property to specify client certificates. If ssl_server_cert_store has a value, and ssl_server_cert_subject or ssl_server_cert_encoded is set, a search for a certificate is initiated. Please see the ssl_server_cert_subject 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.

ssl_server_cert_store_password Property

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

Syntax

def get_ssl_server_cert_store_password() -> str: ...

ssl_server_cert_store_password = property(get_ssl_server_cert_store_password, None)

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.

ssl_server_cert_store_type Property

The type of certificate store for this certificate.

Syntax

def get_ssl_server_cert_store_type() -> int: ...

ssl_server_cert_store_type = property(get_ssl_server_cert_store_type, None)

Default Value

0

Remarks

The type of certificate store for this certificate.

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

This property is read-only.

ssl_server_cert_subject_alt_names Property

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

Syntax

def get_ssl_server_cert_subject_alt_names() -> str: ...

ssl_server_cert_subject_alt_names = property(get_ssl_server_cert_subject_alt_names, None)

Default Value

""

Remarks

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

This property is read-only.

ssl_server_cert_thumbprint_md5 Property

The MD5 hash of the certificate.

Syntax

def get_ssl_server_cert_thumbprint_md5() -> str: ...

ssl_server_cert_thumbprint_md5 = property(get_ssl_server_cert_thumbprint_md5, None)

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.

ssl_server_cert_thumbprint_sha1 Property

The SHA-1 hash of the certificate.

Syntax

def get_ssl_server_cert_thumbprint_sha1() -> str: ...

ssl_server_cert_thumbprint_sha1 = property(get_ssl_server_cert_thumbprint_sha1, None)

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.

ssl_server_cert_thumbprint_sha256 Property

The SHA-256 hash of the certificate.

Syntax

def get_ssl_server_cert_thumbprint_sha256() -> str: ...

ssl_server_cert_thumbprint_sha256 = property(get_ssl_server_cert_thumbprint_sha256, None)

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.

ssl_server_cert_usage Property

The text description of UsageFlags .

Syntax

def get_ssl_server_cert_usage() -> str: ...

ssl_server_cert_usage = property(get_ssl_server_cert_usage, None)

Default Value

""

Remarks

The text description of ssl_server_cert_usage_flags.

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.

ssl_server_cert_usage_flags Property

The flags that show intended use for the certificate.

Syntax

def get_ssl_server_cert_usage_flags() -> int: ...

ssl_server_cert_usage_flags = property(get_ssl_server_cert_usage_flags, None)

Default Value

0

Remarks

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

Please see the ssl_server_cert_usage property for a text representation of ssl_server_cert_usage_flags.

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

This property is read-only.

ssl_server_cert_version Property

The certificate's version number.

Syntax

def get_ssl_server_cert_version() -> str: ...

ssl_server_cert_version = property(get_ssl_server_cert_version, None)

Default Value

""

Remarks

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

This property is read-only.

ssl_server_cert_subject Property

The subject of the certificate used for client authentication.

Syntax

def get_ssl_server_cert_subject() -> str: ...

ssl_server_cert_subject = property(get_ssl_server_cert_subject, None)

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.

ssl_server_cert_encoded Property

The certificate (PEM/Base64 encoded).

Syntax

def get_ssl_server_cert_encoded() -> bytes: ...

ssl_server_cert_encoded = property(get_ssl_server_cert_encoded, None)

Default Value

""

Remarks

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

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

This property is read-only.

authorize Method

Get the authorization string required to access the protected resource.

Syntax

def authorize() -> None: ...

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 o_auth_client_profile property and the o_auth_grant_type property. This method is not to be used in conjunction with the authorization property. It should instead be used when setting the o_auth property.

For more information, see the introduction section.

config Method

Sets or retrieves a configuration setting.

Syntax

def config(configuration_string: str) -> str: ...

Remarks

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

These settings are similar in functionality to properties, but they are rarely used. In order to avoid "polluting" the property namespace of the class, 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.

create_calendar Method

Creates a new calendar.

Syntax

def create_calendar(name: str) -> None: ...

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 update_calendar method.

Example (Creating a New Calendar)

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

create_event Method

Creates an event. The timezone is UTC.

Syntax

def create_event(subject: str, start_time: str, end_time: str, calendar_id: str) -> None: ...

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

delete_calendar Method

Deletes a calendar.

Syntax

def delete_calendar(id: str) -> None: ...

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 list_calendars is called.

delete_event Method

Deletes an event.

Syntax

def delete_event(calendar_id: str, id: str) -> None: ...

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 list_events method is called.

get_event Method

Retrieves the event by Id.

Syntax

def get_event(calendar_id: str, id: str) -> None: ...

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 }

get_event_field Method

Retrieves the event property value by JSONPath.

Syntax

def get_event_field(index: int, json_path: str) -> str: ...

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

Interrupt the current method.

Syntax

def interrupt() -> None: ...

Remarks

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

list_calendars Method

Lists the calendars.

Syntax

def list_calendars() -> None: ...

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 on_calendar_list event is fired.

list_colors Method

Lists the colors.

Syntax

def list_colors() -> None: ...

Remarks

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

list_events Method

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

Syntax

def list_events(calendar_id: str) -> None: ...

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 on_event_list event is fired.

reset Method

This method will reset the class.

Syntax

def reset() -> None: ...

Remarks

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

send_custom_request Method

Send a custom HTTP request.

Syntax

def send_custom_request(http_method: str, url: str, post_data: str) -> None: ...

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

set_event_field Method

Sets the event field value by JSONPath.

Syntax

def set_event_field(index: int, json_path: str, value: str, value_type: int) -> None: ...

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.

update_calendar Method

Updates a calendar.

Syntax

def update_calendar(index: int) -> None: ...

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

update_event Method

Updates an event.

Syntax

def update_event(index: int) -> None: ...

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

on_calendar_list Event

Fired when a calendar is retrieved from the server.

Syntax

class GoogleCalendarsCalendarListEventParams(object):
  @property
  def id() -> str: ...

  @property
  def name() -> str: ...

# In class GoogleCalendars:
@property
def on_calendar_list() -> Callable[[GoogleCalendarsCalendarListEventParams], None]: ...
@on_calendar_list.setter
def on_calendar_list(event_hook: Callable[[GoogleCalendarsCalendarListEventParams], None]) -> None: ...

Remarks

The on_calendar_list event is fired for each calendar retrieved from the server when list_calendars is called.

on_error Event

Fired when information is available about errors during data delivery.

Syntax

class GoogleCalendarsErrorEventParams(object):
  @property
  def error_code() -> int: ...

  @property
  def description() -> str: ...

# In class GoogleCalendars:
@property
def on_error() -> Callable[[GoogleCalendarsErrorEventParams], None]: ...
@on_error.setter
def on_error(event_hook: Callable[[GoogleCalendarsErrorEventParams], None]) -> None: ...

Remarks

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

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

on_event_list Event

Fired when an event is retrieved from the server.

Syntax

class GoogleCalendarsEventListEventParams(object):
  @property
  def id() -> str: ...

  @property
  def calendar_id() -> str: ...

  @property
  def subject() -> str: ...

  @property
  def start_time() -> str: ...

  @property
  def end_time() -> str: ...

# In class GoogleCalendars:
@property
def on_event_list() -> Callable[[GoogleCalendarsEventListEventParams], None]: ...
@on_event_list.setter
def on_event_list(event_hook: Callable[[GoogleCalendarsEventListEventParams], None]) -> None: ...

Remarks

The on_event_list event is fired for each event retrieved from the server when list_events 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.

on_log Event

Fired once for each log message.

Syntax

class GoogleCalendarsLogEventParams(object):
  @property
  def log_level() -> int: ...

  @property
  def message() -> str: ...

  @property
  def log_type() -> str: ...

# In class GoogleCalendars:
@property
def on_log() -> Callable[[GoogleCalendarsLogEventParams], None]: ...
@on_log.setter
def on_log(event_hook: Callable[[GoogleCalendarsLogEventParams], None]) -> None: ...

Remarks

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

on_ssl_server_authentication Event

Fired after the server presents its certificate to the client.

Syntax

class GoogleCalendarsSSLServerAuthenticationEventParams(object):
  @property
  def cert_encoded() -> bytes: ...

  @property
  def cert_subject() -> str: ...

  @property
  def cert_issuer() -> str: ...

  @property
  def status() -> str: ...

  @property
  def accept() -> bool: ...
  @accept.setter
  def accept(value) -> None: ...

# In class GoogleCalendars:
@property
def on_ssl_server_authentication() -> Callable[[GoogleCalendarsSSLServerAuthenticationEventParams], None]: ...
@on_ssl_server_authentication.setter
def on_ssl_server_authentication(event_hook: Callable[[GoogleCalendarsSSLServerAuthenticationEventParams], None]) -> None: ...

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.

on_ssl_status Event

Fired when secure connection progress messages are available.

Syntax

class GoogleCalendarsSSLStatusEventParams(object):
  @property
  def message() -> str: ...

# In class GoogleCalendars:
@property
def on_ssl_status() -> Callable[[GoogleCalendarsSSLStatusEventParams], None]: ...
@on_ssl_status.setter
def on_ssl_status(event_hook: Callable[[GoogleCalendarsSSLStatusEventParams], None]) -> None: ...

Remarks

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

on_transfer Event

Fired while a document transfers (delivers document).

Syntax

class GoogleCalendarsTransferEventParams(object):
  @property
  def direction() -> int: ...

  @property
  def bytes_transferred() -> int: ...

  @property
  def percent_done() -> int: ...

  @property
  def text() -> bytes: ...

# In class GoogleCalendars:
@property
def on_transfer() -> Callable[[GoogleCalendarsTransferEventParams], None]: ...
@on_transfer.setter
def on_transfer(event_hook: Callable[[GoogleCalendarsTransferEventParams], None]) -> None: ...

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.

GoogleCalendars Config Settings

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

GoogleCalendars Errors