GoogleCalendars Component

Properties Methods Events Config Settings Errors

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

Syntax

nsoftware.CloudCalendars.GoogleCalendars

Remarks

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

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

The component has the following defaults:


Authorization Server URL	"https://accounts.google.com/o/oauth2/auth"
Token Server URL	"https://accounts.google.com/o/oauth2/token"
Scopes	"https://www.googleapis.com/auth/calendar https://www.googleapis.com/auth/calendar https://www.googleapis.com/auth/calendar.events https://www.googleapis.com/auth/calendar.settings.readonly"

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

Application Profile

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

To start the authentication and authorization process, the Authorize method should be called. If the authorization and authentication was successful, then the AccessToken field will be populated. Additionally, if a refresh token was provided the RefreshToken field will be populated as well. These values of the fields are for informational purposes. The component will also cache these tokens along with when the AccessToken will be expired. When a method that makes requests to the service provider is called or the Authorize method is called the component will automatically check to see if the access token is expired. If it is, it will then automatically try to get a new AccessToken. If the Authorize method was not used and user interaction would be required, the component will throw an error which can be caught. When user interaction is needed depends on what grant type is set in the GrantType field. 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 GrantType field are below. For more information, see the service documentation.

Authorization Code

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

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

Implicit

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

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

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

Web Profile

This profile is similar to setting the component to the Application profile and Authorization Code grant type except the component will not launch the browser. It is typically used in situations where there is a back-end that is supporting some front end. This profile expects that ClientId, ClientSecret, ServerAuthURL, ServerTokenURL, and the ReturnURL fields to be set. Before calling the Authorize method, the WebAuthURL field should be queried to get a URL. This URL should be used to redirect the user to the authorization page for the service provider. The redirect_uri parameter of this URL is mapped to the ReturnURL field. The ReturnURL field should be set to some web server that will parse the authorization code out of the query parameter from the redirect. Once the authorization code is parsed, it should be passed back to the server where it is then set to the AuthorizationCode field. Once that is set, the Authorize method can be called to exchange the authorization code for an access token and refresh token if provided. The component will then cache these values like normal and use them to make requests. If the RefreshToken field is set, or a refresh token is cached, then the Authorize method can immediately be called to make a request to the token server to get a new access token.

External OAuth Support

For complex profiles or grant types, or for more control of the flow, it is possible to perform OAuth authentication using the OAuth component or a separate process. Once complete you should have an authorization string which looks like:

Bearer ACCESS_TOKEN_VALUE

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

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

Creating a Calendar

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

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

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

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

Listing Calendars

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

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

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

Creating Events

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

Example (Create a new event in a specific calendar)

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

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

Retrieving an Event

To retrieve an event use the GetEvent method and provide two arguments, the Id of the calendar to which the event belongs to and the Id of the event itself. The event is added to the end of the Events collection.

Example (Retrieve an Event)

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

Deleting an Event

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

Example (Delete Events

// List events and delete all events containing "Meeting" in their name gcal.ListEvents(calID); for (int i = 0; i < gcal.Events.Count; i++) { if (gcal.Events[i].Summary.Contains("Meeting")) { gcal.DeleteEvent(calID, gcal.Events[i].Id); } }

Property List

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


Authorization	An OAuth Authorization String
Calendars	The collection of calendars listed by the server.
Colors	The collection of colors listed by the server.
Events	The collection of events listed by the server.
Firewall	A set of properties related to firewall access.
ListEventsMarker	The page marker for listing events.
OAuth	This property holds the OAuth Settings.
Proxy	A set of properties related to proxy access.
SSLAcceptServerCert	Instructs the component to unconditionally accept the server certificate that matches the supplied certificate.
SSLCert	The certificate to be used during Secure Sockets Layer (SSL) negotiation.
SSLProvider	The Secure Sockets Layer/Transport Layer Security (SSL/TLS) implementation to use.
SSLServerCert	The server certificate for the last established connection.

Method List

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


Authorize	Get the authorization string required to access the protected resource.
Config	Sets or retrieves a configuration setting.
CreateCalendar	Creates a new calendar.
CreateEvent	Creates an event. The timezone is UTC.
DeleteCalendar	Deletes a calendar.
DeleteEvent	Deletes an event.
GetEvent	Retrieves the event by Id.
GetEventField	Retrieves the event property value by JSONPath.
Interrupt	Interrupt the current method.
ListCalendars	Lists the calendars.
ListColors	Lists the colors.
ListEvents	Lists the events. (empty calendarId for all events)
Reset	This method will reset the component.
SendCustomRequest	Send a custom HTTP request.
SetEventField	Sets the event field value by JSONPath.
UpdateCalendar	Updates a calendar.
UpdateEvent	Updates an event.

Event List

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


CalendarList	Fired when a calendar is retrieved from the server.
Error	Fired when information is available about errors during data delivery.
EventList	Fired when an event is retrieved from the server.
Log	Fired once for each log message.
SSLServerAuthentication	Fired after the server presents its certificate to the client.
SSLStatus	Fired when secure connection progress messages are available.
Transfer	Fired while a document transfers (delivers document).

Config Settings

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


CalendarsPageSize	Page size limit for fetching calendars.
EventsPageSize	Page size for fetching events.
ListCalendarsMarker	The page marker for listing calendars.
XChildCount	The number of child elements of the current element.
XChildName[i]	The name of the child element.
XChildXText[i]	The inner text of the child element.
XElement	The name of the current element.
XParent	The parent of the current element.
XPath	Provides a way to point to a specific element in the returned XML or JSON response.
XSubTree	A snapshot of the current element in the document.
XText	The text of the current element.
OAuthAccessTokenExpiration	The lifetime of the access token.
OAuthAuthorizationTokenType	The type of access token returned.
OAuthAutomaticRefresh	Whether or not to refresh an expired access token automatically.
OAuthBrowserResponseTimeout	Specifies the amount of time to wait for a response from the browser.
OAuthIncludeEmptyRedirectURI	Whether an empty redirect_uri parameter is included in requests.
OAuthJWTPayload	The payload of the JWT access token if present.
OAuthJWTXChildCount	The number of child elements of the current element.
OauthJWTXChildName[i]	The name of the child element.
OAuthJWTXChildXText[i]	The inner text of the child element.
OAuthJWTXElement	The name of the current element.
OauthJWTXParent	The parent of the current element.
OAuthJWTXPath	Provides a way to point to a specific element in the returned payload of a JWT based access token.
OAuthJWTXSubTree	A snapshot of the current element in the document.
OAuthJWTXText	The text of the current element.
OAuthParamCount	Specifies the number of additional parameters variables to include in the request.
OAuthParamName[i]	Specifies the parameter name at the specified index.
OAuthParamValue[i]	Specifies the parameter value at the specified index.
OAuthPasswordGrantUsername	Used in the Resource Owner Password grant type.
OAuthPKCEChallengeEncoding	The PKCE code challenge method to use.
OAuthPKCEVerifier	The PKCE verifier used to generate the challenge.
OAuthResetData	Determines if the Reset method applies to the OAuth settings.
OAuthReUseWebServer	Determines if the same server instance is used between requests.
OAuthTransferredRequest	The full OAuth request last sent by the client.
OAuthUsePKCE	Specifies if PKCE should be used.
OAuthWebServerActive	Specifies and controls whether the embedded web server is active.
OAuthWebServerCertStore	The certificate with private key to use when SSL is enabled.
OAuthWebServerCertStorePassword	The certificate with private key to use when SSL is enabled.
OAuthWebServerCertStoreType	The certificate with private key to use when SSL is enabled.
OAuthWebServerCertSubject	The certificate with private key to use when SSL is enabled.
OAuthWebServerFailedResponse	The custom response that will be displayed to the user if authentication failed.
OAuthWebServerHost	The hostname used by the embedded web server displayed in the ReturnURL.
OAuthWebServerPort	The local port on which the embedded web server listens.
OAuthWebServerResponse	The custom response that will be displayed to the user.
OAuthWebServerSSLEnabled	Whether the web server requires SSL connections.
AcceptEncoding	Used to tell the server which types of content encodings the client supports.
AllowHTTPCompression	This property enables HTTP compression for receiving data.
AllowHTTPFallback	Whether HTTP/2 connections are permitted to fallback to HTTP/1.1.
AllowNTLMFallback	Whether to allow fallback from Negotiate to NTLM when authenticating.
Append	Whether to append data to LocalFile.
Authorization	The Authorization string to be sent to the server.
BytesTransferred	Contains the number of bytes transferred in the response data.
ChunkSize	Specifies the chunk size in bytes when using chunked encoding.
CompressHTTPRequest	Set to true to compress the body of a PUT or POST request.
EncodeURL	If set to True the URL will be encoded by the component.
FollowRedirects	Determines what happens when the server issues a redirect.
GetOn302Redirect	If set to True the component will perform a GET on the new location.
HTTP2HeadersWithoutIndexing	HTTP2 headers that should not update the dynamic header table with incremental indexing.
HTTPVersion	The version of HTTP used by the component.
IfModifiedSince	A date determining the maximum age of the desired document.
KeepAlive	Determines whether the HTTP connection is closed after completion of the request.
KerberosSPN	The Service Principal Name for the Kerberos Domain Controller.
LogLevel	The level of detail that is logged.
MaxHeaders	Instructs component to save the amount of headers specified that are returned by the server after a Header event has been fired.
MaxHTTPCookies	Instructs component to save the amount of cookies specified that are returned by the server when a SetCookie event is fired.
MaxRedirectAttempts	Limits the number of redirects that are followed in a request.
NegotiatedHTTPVersion	The negotiated HTTP version.
OtherHeaders	Other headers as determined by the user (optional).
ProxyAuthorization	The authorization string to be sent to the proxy server.
ProxyAuthScheme	The authorization scheme to be used for the proxy.
ProxyPassword	A password if authentication is to be used for the proxy.
ProxyPort	Port for the proxy server (default 80).
ProxyServer	Name or IP address of a proxy server (optional).
ProxyUser	A user name if authentication is to be used for the proxy.
SentHeaders	The full set of headers as sent by the client.
StatusCode	The status code of the last response from the server.
StatusLine	The first line of the last response from the server.
TransferredData	The contents of the last response from the server.
TransferredDataLimit	The maximum number of incoming bytes to be stored by the component.
TransferredHeaders	The full set of headers as received from the server.
TransferredRequest	The full request as sent by the client.
UseChunkedEncoding	Enables or Disables HTTP chunked encoding for transfers.
UseIDNs	Whether to encode hostnames to internationalized domain names.
UsePlatformDeflate	Whether to use the platform implementation to decompress compressed responses.
UsePlatformHTTPClient	Whether or not to use the platform HTTP client.
UseProxyAutoConfigURL	Whether to use a Proxy auto-config file when attempting a connection.
UserAgent	Information about the user agent (browser).
CloseStreamAfterTransfer	If true, the component will close the upload or download stream after the transfer.
ConnectionTimeout	Sets a separate timeout value for establishing a connection.
FirewallAutoDetect	Tells the component whether or not to automatically detect and use firewall system settings, if available.
FirewallHost	Name or IP address of firewall (optional).
FirewallListener	If true, the component binds to a SOCKS firewall as a server (TCPClient only).
FirewallPassword	Password to be used if authentication is to be used when connecting through the firewall.
FirewallPort	The TCP port for the FirewallHost;.
FirewallType	Determines the type of firewall to connect through.
FirewallUser	A user name if authentication is to be used connecting through a firewall.
KeepAliveInterval	The retry interval, in milliseconds, to be used when a TCP keep-alive packet is sent and no response is received.
KeepAliveTime	The inactivity time in milliseconds before a TCP keep-alive packet is sent.
Linger	When set to True, connections are terminated gracefully.
LingerTime	Time in seconds to have the connection linger.
LocalHost	The name of the local host through which connections are initiated or accepted.
LocalPort	The port in the local host where the component binds.
MaxLineLength	The maximum amount of data to accumulate when no EOL is found.
MaxTransferRate	The transfer rate limit in bytes per second.
ProxyExceptionsList	A semicolon separated list of hosts and IPs to bypass when using a proxy.
TCPKeepAlive	Determines whether or not the keep alive socket option is enabled.
TcpNoDelay	Whether or not to delay when sending packets.
UseIPv6	Whether to use IPv6.
UseNTLMv2	Whether to use NTLM V2.
CACertFilePaths	The paths to CA certificate files when using Mono on Unix/Linux.
LogSSLPackets	Controls whether SSL packets are logged when using the internal security API.
ReuseSSLSession	Determines if the SSL session is reused.
SSLCACerts	A newline separated list of CA certificates to be included when performing an SSL handshake.
SSLCheckCRL	Whether to check the Certificate Revocation List for the server certificate.
SSLCheckOCSP	Whether to use OCSP to check the status of the server certificate.
SSLCipherStrength	The minimum cipher strength used for bulk encryption.
SSLClientCACerts	A newline separated list of CA certificates to use during SSL client certificate validation.
SSLEnabledCipherSuites	The cipher suite to be used in an SSL negotiation.
SSLEnabledProtocols	Used to enable/disable the supported security protocols.
SSLEnableRenegotiation	Whether the renegotiation_info SSL extension is supported.
SSLIncludeCertChain	Whether the entire certificate chain is included in the SSLServerAuthentication event.
SSLKeyLogFile	The location of a file where per-session secrets are written for debugging purposes.
SSLNegotiatedCipher	Returns the negotiated cipher suite.
SSLNegotiatedCipherStrength	Returns the negotiated cipher suite strength.
SSLNegotiatedCipherSuite	Returns the negotiated cipher suite.
SSLNegotiatedKeyExchange	Returns the negotiated key exchange algorithm.
SSLNegotiatedKeyExchangeStrength	Returns the negotiated key exchange algorithm strength.
SSLNegotiatedVersion	Returns the negotiated protocol version.
SSLSecurityFlags	Flags that control certificate verification.
SSLServerCACerts	A newline separated list of CA certificates to use during SSL server certificate validation.
TLS12SignatureAlgorithms	Defines the allowed TLS 1.2 signature algorithms when SSLProvider is set to Internal.
TLS12SupportedGroups	The supported groups for ECC.
TLS13KeyShareGroups	The groups for which to pregenerate key shares.
TLS13SignatureAlgorithms	The allowed certificate signature algorithms.
TLS13SupportedGroups	The supported groups for (EC)DHE key exchange.
AbsoluteTimeout	Determines whether timeouts are inactivity timeouts or absolute timeouts.
FirewallData	Used to send extra data to the firewall.
InBufferSize	The size in bytes of the incoming queue of the socket.
OutBufferSize	The size in bytes of the outgoing queue of the socket.
BuildInfo	Information about the product's build.
GUIAvailable	Whether or not a message loop is available for processing events.
LicenseInfo	Information about the current license.
MaskSensitiveData	Whether sensitive data is masked in log messages.
UseFIPSCompliantAPI	Tells the component whether or not to use FIPS certified APIs.
UseInternalSecurityAPI	Whether or not to use the system security libraries or an internal implementation.

Authorization Property (GoogleCalendars Component)

An OAuth Authorization String

public string Authorization { get; set; }

Public Property Authorization As String

Default Value

Remarks

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

Example

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

This property is not available at design time.

Calendars Property (GoogleCalendars Component)

The collection of calendars listed by the server.

Syntax

C#
VB.NET

public GCalCalendarList Calendars { get; }

Public Property Calendars As GCalCalendarList

Remarks

This collection contains a list of calendars returned by the server. It is populated when ListCalendars is called.

This property is not available at design time.

Please refer to the GCalCalendar type for a complete list of fields.

Colors Property (GoogleCalendars Component)

The collection of colors listed by the server.

Syntax

C#
VB.NET

public GCalColorList Colors { get; }

Public ReadOnly Property Colors As GCalColorList

Remarks

This collection contains a list of colors returned by the server. It is populated when ListColors is called.

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

Please refer to the GCalColor type for a complete list of fields.

Events Property (GoogleCalendars Component)

The collection of events listed by the server.

Syntax

C#
VB.NET

public GCalEventList Events { get; }

Public Property Events As GCalEventList

Remarks

This collection contains a list of events returned by the server. It is populated when the ListEvents or GetEvent method is called. A GetEvent call adds the retrieved event to the beginning of the list. If the event already exists in the Events collection, it will be removed and then added to the beginning, preventing duplication.

Example (Retrieve Events from a Calendar)

// List all events from Calendar gcal.ListEvents(calendarId); foreach (GCalEvent event in gcal.Events) { event.Summary; // event summary event.StartDateTime; // event start time event.EndDateTime; // event end time for(int i = 0; i < event.AttendeesCount; i++){ event.AttendeeIndex = i; event.AttendeeEmail; // the email of the attendee event.AttendeeStatusResponse; // the response of the attendee event.Description; // the description of the event } }

This property is not available at design time.

Please refer to the GCalEvent type for a complete list of fields.

Firewall Property (GoogleCalendars Component)

A set of properties related to firewall access.

Syntax

C#
VB.NET

public Firewall Firewall { get; set; }

Public Property Firewall As Firewall

Remarks

This is a Firewall-type property, which contains fields describing the firewall through which the component will attempt to connect.

Please refer to the Firewall type for a complete list of fields.

ListEventsMarker Property (GoogleCalendars Component)

The page marker for listing events.

Syntax

C#
VB.NET

public string ListEventsMarker { get; set; }

Public Property ListEventsMarker As String

Default Value

Remarks

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

Example (List All Events in a Calendar):

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

This property is not available at design time.

OAuth Property (GoogleCalendars Component)

This property holds the OAuth Settings.

Syntax

C#
VB.NET

public OAuthSettings OAuth { get; }

Public ReadOnly Property OAuth As OAuthSettings

Remarks

This property is used to define the necessary fields to authenticate with the service provider. See the introduction for more information.

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

Please refer to the OAuthSettings type for a complete list of fields.

Proxy Property (GoogleCalendars Component)

A set of properties related to proxy access.

Syntax

C#
VB.NET

public Proxy Proxy { get; set; }

Public Property Proxy As Proxy

Remarks

This property contains fields describing the proxy through which the component will attempt to connect.

Please refer to the Proxy type for a complete list of fields.

SSLAcceptServerCert Property (GoogleCalendars Component)

Instructs the component to unconditionally accept the server certificate that matches the supplied certificate.

Syntax

C#
VB.NET

public Certificate SSLAcceptServerCert { get; set; }

Public Property SSLAcceptServerCert As Certificate

Remarks

If it finds any issues with the certificate presented by the server, the component will normally terminate the connection with an error.

You may override this behavior by supplying a value for SSLAcceptServerCert. If the certificate supplied in SSLAcceptServerCert is the same as the certificate presented by the server, then the server certificate is accepted unconditionally, and the connection will continue normally.

Note: This functionality is provided only for cases in which you otherwise know that you are communicating with the right server. If used improperly, this property may create a security breach. Use it at your own risk.

Please refer to the Certificate type for a complete list of fields.

SSLCert Property (GoogleCalendars Component)

The certificate to be used during Secure Sockets Layer (SSL) negotiation.

Syntax

C#
VB.NET

public Certificate SSLCert { get; set; }

Public Property SSLCert As Certificate

Remarks

This property includes the digital certificate that the component will use during SSL negotiation. Set this property to a valid certificate before starting SSL negotiation. To set a certificate, you may set the Encoded field to the encoded certificate. To select a certificate, use the store and subject fields.

Please refer to the Certificate type for a complete list of fields.

SSLProvider Property (GoogleCalendars Component)

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

Syntax

C#
VB.NET

public GoogleCalendarsSSLProviders SSLProvider { get; set; }

enum GoogleCalendarsSSLProviders {
  sslpAutomatic,
  sslpPlatform,
  sslpInternal
}

Public Property SSLProvider As GooglecalendarsSSLProviders

Enum GoogleCalendarsSSLProviders
  sslpAutomatic
  sslpPlatform
  sslpInternal
End Enum

Default Value

Remarks

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

Possible values are as follows:


0 (sslpAutomatic - default)	Automatically selects the appropriate implementation.
1 (sslpPlatform)	Uses the platform/system implementation.
2 (sslpInternal)	Uses the internal implementation.

Additional Notes

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

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

The .NET Standard library will always use the internal implementation on all platforms.

SSLServerCert Property (GoogleCalendars Component)

The server certificate for the last established connection.

Syntax

C#
VB.NET

public Certificate SSLServerCert { get; }

Public ReadOnly Property SSLServerCert As Certificate

Remarks

This property contains the server certificate for the last established connection.

SSLServerCert is reset every time a new connection is attempted.

This property is read-only.

Please refer to the Certificate type for a complete list of fields.

Authorize Method (GoogleCalendars Component)

Get the authorization string required to access the protected resource.

Syntax

C#
VB.NET

public void Authorize();

Async Version
public async Task Authorize();
public async Task Authorize(CancellationToken cancellationToken);

Public Sub Authorize()

Async Version
Public Sub Authorize() As Task
Public Sub Authorize(cancellationToken As CancellationToken) As Task

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 ClientProfile field and the GrantType field. This method is not to be used in conjunction with the Authorization property. It should instead be used when setting the OAuth property.

For more information, see the introduction section.

Config Method (GoogleCalendars Component)

Sets or retrieves a configuration setting.

Syntax

C#
VB.NET

public string Config(string configurationString);

Async Version
public async Task<string> Config(string configurationString);
public async Task<string> Config(string configurationString, CancellationToken cancellationToken);

Public Function Config(ByVal ConfigurationString As String) As String

Async Version
Public Function Config(ByVal ConfigurationString As String) As Task(Of String)
Public Function Config(ByVal ConfigurationString As String, cancellationToken As CancellationToken) As Task(Of String)

Remarks

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

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

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

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

CreateCalendar Method (GoogleCalendars Component)

Creates a new calendar.

Syntax

C#
VB.NET

public void CreateCalendar(string name);

Async Version
public async Task CreateCalendar(string name);
public async Task CreateCalendar(string name, CancellationToken cancellationToken);

Public Sub CreateCalendar(ByVal Name As String)

Async Version
Public Sub CreateCalendar(ByVal Name As String) As Task
Public Sub CreateCalendar(ByVal Name As String, cancellationToken As CancellationToken) As Task

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

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

Example (Creating a New Calendar)

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

CreateEvent Method (GoogleCalendars Component)

Creates an event. The timezone is UTC.

Syntax

C#
VB.NET

public void CreateEvent(string subject, string startTime, string endTime, string calendarId);

Async Version
public async Task CreateEvent(string subject, string startTime, string endTime, string calendarId);
public async Task CreateEvent(string subject, string startTime, string endTime, string calendarId, CancellationToken cancellationToken);

Public Sub CreateEvent(ByVal Subject As String, ByVal StartTime As String, ByVal EndTime As String, ByVal CalendarId As String)

Async Version
Public Sub CreateEvent(ByVal Subject As String, ByVal StartTime As String, ByVal EndTime As String, ByVal CalendarId As String) As Task
Public Sub CreateEvent(ByVal Subject As String, ByVal StartTime As String, ByVal EndTime As String, ByVal CalendarId As String, cancellationToken As CancellationToken) As Task

Remarks

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

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

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

DeleteCalendar Method (GoogleCalendars Component)

Deletes a calendar.

Syntax

C#
VB.NET

public void DeleteCalendar(string id);

Async Version
public async Task DeleteCalendar(string id);
public async Task DeleteCalendar(string id, CancellationToken cancellationToken);

Public Sub DeleteCalendar(ByVal id As String)

Async Version
Public Sub DeleteCalendar(ByVal id As String) As Task
Public Sub DeleteCalendar(ByVal id As String, cancellationToken As CancellationToken) As Task

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 collection, the calendar will only be removed once ListCalendars is called.

DeleteEvent Method (GoogleCalendars Component)

Deletes an event.

Syntax

C#
VB.NET

public void DeleteEvent(string calendarId, string id);

Async Version
public async Task DeleteEvent(string calendarId, string id);
public async Task DeleteEvent(string calendarId, string id, CancellationToken cancellationToken);

Public Sub DeleteEvent(ByVal CalendarId As String, ByVal Id As String)

Async Version
Public Sub DeleteEvent(ByVal CalendarId As String, ByVal Id As String) As Task
Public Sub DeleteEvent(ByVal CalendarId As String, ByVal Id As String, cancellationToken As CancellationToken) As Task

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 collection, the event will be removed only once the ListEvents method is called.

GetEvent Method (GoogleCalendars Component)

Retrieves the event by Id.

Syntax

C#
VB.NET

public void GetEvent(string calendarId, string id);

Async Version
public async Task GetEvent(string calendarId, string id);
public async Task GetEvent(string calendarId, string id, CancellationToken cancellationToken);

Public Sub GetEvent(ByVal CalendarId As String, ByVal Id As String)

Async Version
Public Sub GetEvent(ByVal CalendarId As String, ByVal Id As String) As Task
Public Sub GetEvent(ByVal CalendarId As String, ByVal Id As String, cancellationToken As CancellationToken) As Task

Remarks

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

Example (Get an Event)

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

GetEventField Method (GoogleCalendars Component)

Retrieves the event property value by JSONPath.

Syntax

C#
VB.NET

public string GetEventField(int index, string jsonPath);

Async Version
public async Task<string> GetEventField(int index, string jsonPath);
public async Task<string> GetEventField(int index, string jsonPath, CancellationToken cancellationToken);

Public Function GetEventField(ByVal index As Integer, ByVal JsonPath As String) As String

Async Version
Public Function GetEventField(ByVal index As Integer, ByVal JsonPath As String) As Task(Of String)
Public Function GetEventField(ByVal index As Integer, ByVal JsonPath As String, cancellationToken As CancellationToken) As Task(Of String)

Remarks

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

Example (Access Fields of an Event)

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

Interrupt Method (GoogleCalendars Component)

Interrupt the current method.

Syntax

C#
VB.NET

public void Interrupt();

Async Version
public async Task Interrupt();
public async Task Interrupt(CancellationToken cancellationToken);

Public Sub Interrupt()

Async Version
Public Sub Interrupt() As Task
Public Sub Interrupt(cancellationToken As CancellationToken) As Task

Remarks

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

ListCalendars Method (GoogleCalendars Component)

Lists the calendars.

Syntax

C#
VB.NET

public void ListCalendars();

Async Version
public async Task ListCalendars();
public async Task ListCalendars(CancellationToken cancellationToken);

Public Sub ListCalendars()

Async Version
Public Sub ListCalendars() As Task
Public Sub ListCalendars(cancellationToken As CancellationToken) As Task

Remarks

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

ListColors Method (GoogleCalendars Component)

Lists the colors.

Syntax

C#
VB.NET

public void ListColors();

Async Version
public async Task ListColors();
public async Task ListColors(CancellationToken cancellationToken);

Public Sub ListColors()

Async Version
Public Sub ListColors() As Task
Public Sub ListColors(cancellationToken As CancellationToken) As Task

Remarks

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

ListEvents Method (GoogleCalendars Component)

Lists the events. (empty calendarId for all events)

Syntax

C#
VB.NET

public void ListEvents(string calendarId);

Async Version
public async Task ListEvents(string calendarId);
public async Task ListEvents(string calendarId, CancellationToken cancellationToken);

Public Sub ListEvents(ByVal calendarId As String)

Async Version
Public Sub ListEvents(ByVal calendarId As String) As Task
Public Sub ListEvents(ByVal calendarId As String, cancellationToken As CancellationToken) As Task

Remarks

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

Reset Method (GoogleCalendars Component)

This method will reset the component.

Syntax

C#
VB.NET

public void Reset();

Async Version
public async Task Reset();
public async Task Reset(CancellationToken cancellationToken);

Public Sub Reset()

Async Version
Public Sub Reset() As Task
Public Sub Reset(cancellationToken As CancellationToken) As Task

Remarks

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

SendCustomRequest Method (GoogleCalendars Component)

Send a custom HTTP request.

Syntax

C#
VB.NET

public void SendCustomRequest(string HTTPMethod, string URL, string postData);

Async Version
public async Task SendCustomRequest(string HTTPMethod, string URL, string postData);
public async Task SendCustomRequest(string HTTPMethod, string URL, string postData, CancellationToken cancellationToken);

Public Sub SendCustomRequest(ByVal HTTPMethod As String, ByVal URL As String, ByVal PostData As String)

Async Version
Public Sub SendCustomRequest(ByVal HTTPMethod As String, ByVal URL As String, ByVal PostData As String) As Task
Public Sub SendCustomRequest(ByVal HTTPMethod As String, ByVal URL As String, ByVal PostData As String, cancellationToken As CancellationToken) As Task

Remarks

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

Example (Send a custom request):

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

SetEventField Method (GoogleCalendars Component)

Sets the event field value by JSONPath.

Syntax

C#
VB.NET

public void SetEventField(int index, string jsonPath, string value, int valueType);

Async Version
public async Task SetEventField(int index, string jsonPath, string value, int valueType);
public async Task SetEventField(int index, string jsonPath, string value, int valueType, CancellationToken cancellationToken);

Public Sub SetEventField(ByVal index As Integer, ByVal JsonPath As String, ByVal Value As String, ByVal ValueType As Integer)

Async Version
Public Sub SetEventField(ByVal index As Integer, ByVal JsonPath As String, ByVal Value As String, ByVal ValueType As Integer) As Task
Public Sub SetEventField(ByVal index As Integer, ByVal JsonPath As String, ByVal Value As String, ByVal ValueType As Integer, cancellationToken As CancellationToken) As Task

Remarks

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

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

Example (Set/Edit Fields of an Event before Updating): // Create an event. gcal.CreateEvent("EventSum", "yyyy-MM-ddTHH:mm:ss", "yyyy-MM-ddTHH:mm:ss", calendarId); gcal.SetEventField(0, "/json/summary", "New Event Summary", 2); gcal.SetEventField(0, "/json/start", "{\"dateTime\": \"" + now.AddHours(3).ToString(dateTimeFormat) + "\", \"timeZone\": \"UTC\"}", 0); gcal.SetEventField(0, "/json/description", "Birthday, 2); gcal.SetEventField(0, "/json/end", "{\"dateTime\": \"" + now.AddHours(10).ToString(dateTimeFormat) + "\", \"timeZone\": \"UTC\"}", 0); // Update the event gcal.UpdateEvent(0);

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

UpdateCalendar Method (GoogleCalendars Component)

Updates a calendar.

Syntax

C#
VB.NET

public void UpdateCalendar(int index);

Async Version
public async Task UpdateCalendar(int index);
public async Task UpdateCalendar(int index, CancellationToken cancellationToken);

Public Sub UpdateCalendar(ByVal index As Integer)

Async Version
Public Sub UpdateCalendar(ByVal index As Integer) As Task
Public Sub UpdateCalendar(ByVal index As Integer, cancellationToken As CancellationToken) As Task

Remarks

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

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

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

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

UpdateEvent Method (GoogleCalendars Component)

Updates an event.

Syntax

C#
VB.NET

public void UpdateEvent(int index);

Async Version
public async Task UpdateEvent(int index);
public async Task UpdateEvent(int index, CancellationToken cancellationToken);

Public Sub UpdateEvent(ByVal index As Integer)

Async Version
Public Sub UpdateEvent(ByVal index As Integer) As Task
Public Sub UpdateEvent(ByVal index As Integer, cancellationToken As CancellationToken) As Task

Remarks

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

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

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

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

CalendarList Event (GoogleCalendars Component)

Fired when a calendar is retrieved from the server.

Syntax

C#
VB.NET

public event OnCalendarListHandler OnCalendarList;

public delegate void OnCalendarListHandler(object sender, GoogleCalendarsCalendarListEventArgs e);

public class GoogleCalendarsCalendarListEventArgs : EventArgs {
  public string Id { get; }
  public string Name { get; }
}

Public Event OnCalendarList As OnCalendarListHandler

Public Delegate Sub OnCalendarListHandler(sender As Object, e As GoogleCalendarsCalendarListEventArgs)

Public Class GoogleCalendarsCalendarListEventArgs Inherits EventArgs
  Public ReadOnly Property Id As String
  Public ReadOnly Property Name As String
End Class

Remarks

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

Error Event (GoogleCalendars Component)

Fired when information is available about errors during data delivery.

Syntax

C#
VB.NET

public event OnErrorHandler OnError;

public delegate void OnErrorHandler(object sender, GoogleCalendarsErrorEventArgs e);

public class GoogleCalendarsErrorEventArgs : EventArgs {
  public int ErrorCode { get; }
  public string Description { get; }
}

Public Event OnError As OnErrorHandler

Public Delegate Sub OnErrorHandler(sender As Object, e As GoogleCalendarsErrorEventArgs)

Public Class GoogleCalendarsErrorEventArgs Inherits EventArgs
  Public ReadOnly Property ErrorCode As Integer
  Public ReadOnly Property Description As String
End Class

Remarks

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

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

EventList Event (GoogleCalendars Component)

Fired when an event is retrieved from the server.

Syntax

C#
VB.NET

public event OnEventListHandler OnEventList;

public delegate void OnEventListHandler(object sender, GoogleCalendarsEventListEventArgs e);

public class GoogleCalendarsEventListEventArgs : EventArgs {
  public string Id { get; }
  public string CalendarId { get; }
  public string Subject { get; }
  public string StartTime { get; }
  public string EndTime { get; }
}

Public Event OnEventList As OnEventListHandler

Public Delegate Sub OnEventListHandler(sender As Object, e As GoogleCalendarsEventListEventArgs)

Public Class GoogleCalendarsEventListEventArgs Inherits EventArgs
  Public ReadOnly Property Id As String
  Public ReadOnly Property CalendarId As String
  Public ReadOnly Property Subject As String
  Public ReadOnly Property StartTime As String
  Public ReadOnly Property EndTime As String
End Class

Remarks

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

Log Event (GoogleCalendars Component)

Fired once for each log message.

Syntax

C#
VB.NET

public event OnLogHandler OnLog;

public delegate void OnLogHandler(object sender, GoogleCalendarsLogEventArgs e);

public class GoogleCalendarsLogEventArgs : EventArgs {
  public int LogLevel { get; }
  public string Message { get; }
  public string LogType { get; }
}

Public Event OnLog As OnLogHandler

Public Delegate Sub OnLogHandler(sender As Object, e As GoogleCalendarsLogEventArgs)

Public Class GoogleCalendarsLogEventArgs Inherits EventArgs
  Public ReadOnly Property LogLevel As Integer
  Public ReadOnly Property Message As String
  Public ReadOnly Property LogType As String
End Class

Remarks

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

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


0 (None)	No events are logged.
1 (Info - default)	Informational events are logged.
2 (Verbose)	Detailed data are logged.
3 (Debug)	Debug data are logged.

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

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

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

Message is the log entry.

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

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

SSLServerAuthentication Event (GoogleCalendars Component)

Fired after the server presents its certificate to the client.

Syntax

C#
VB.NET

public event OnSSLServerAuthenticationHandler OnSSLServerAuthentication;

public delegate void OnSSLServerAuthenticationHandler(object sender, GoogleCalendarsSSLServerAuthenticationEventArgs e);

public class GoogleCalendarsSSLServerAuthenticationEventArgs : EventArgs {
  public string CertEncoded { get; }
  public byte[] CertEncodedB { get; }
  public string CertSubject { get; }
  public string CertIssuer { get; }
  public string Status { get; }
  public bool Accept { get; set; }
}

Public Event OnSSLServerAuthentication As OnSSLServerAuthenticationHandler

Public Delegate Sub OnSSLServerAuthenticationHandler(sender As Object, e As GoogleCalendarsSSLServerAuthenticationEventArgs)

Public Class GoogleCalendarsSSLServerAuthenticationEventArgs Inherits EventArgs
  Public ReadOnly Property CertEncoded As String
  Public ReadOnly Property CertEncodedB As Byte()
  Public ReadOnly Property CertSubject As String
  Public ReadOnly Property CertIssuer As String
  Public ReadOnly Property Status As String
  Public Property Accept As Boolean
End Class

Remarks

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

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

SSLStatus Event (GoogleCalendars Component)

Fired when secure connection progress messages are available.

Syntax

C#
VB.NET

public event OnSSLStatusHandler OnSSLStatus;

public delegate void OnSSLStatusHandler(object sender, GoogleCalendarsSSLStatusEventArgs e);

public class GoogleCalendarsSSLStatusEventArgs : EventArgs {
  public string Message { get; }
}

Public Event OnSSLStatus As OnSSLStatusHandler

Public Delegate Sub OnSSLStatusHandler(sender As Object, e As GoogleCalendarsSSLStatusEventArgs)

Public Class GoogleCalendarsSSLStatusEventArgs Inherits EventArgs
  Public ReadOnly Property Message As String
End Class

Remarks

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

Transfer Event (GoogleCalendars Component)

Fired while a document transfers (delivers document).

Syntax

C#
VB.NET

public event OnTransferHandler OnTransfer;

public delegate void OnTransferHandler(object sender, GoogleCalendarsTransferEventArgs e);

public class GoogleCalendarsTransferEventArgs : EventArgs {
  public int Direction { get; }
  public long BytesTransferred { get; }
  public int PercentDone { get; }
  public string Text { get; }
  public byte[] TextB { get; }
}

Public Event OnTransfer As OnTransferHandler

Public Delegate Sub OnTransferHandler(sender As Object, e As GoogleCalendarsTransferEventArgs)

Public Class GoogleCalendarsTransferEventArgs Inherits EventArgs
  Public ReadOnly Property Direction As Integer
  Public ReadOnly Property BytesTransferred As Long
  Public ReadOnly Property PercentDone As Integer
  Public ReadOnly Property Text As String
  Public ReadOnly Property TextB As Byte()
End Class

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.

Certificate Type

This is the digital certificate being used.

Remarks

This type describes the current digital certificate. The certificate may be a public or private key. The fields are used to identify or select certificates.

The following fields are available:

Fields

EffectiveDate
string (read-only)
Default: ""

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.

ExpirationDate
string (read-only)
Default: ""

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.

ExtendedKeyUsage
string (read-only)
Default: ""

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

Fingerprint
string (read-only)
Default: ""

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

FingerprintSHA1
string (read-only)
Default: ""

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

FingerprintSHA256
string (read-only)
Default: ""

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

Issuer
string (read-only)
Default: ""

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

PrivateKey
string (read-only)
Default: ""

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

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

PrivateKeyAvailable
bool (read-only)
Default: False

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

PrivateKeyContainer
string (read-only)
Default: ""

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

PublicKey
string (read-only)
Default: ""

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

PublicKeyAlgorithm
string (read-only)
Default: ""

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.

PublicKeyLength
int (read-only)
Default: 0

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

SerialNumber
string (read-only)
Default: ""

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.

SignatureAlgorithm
string (read-only)
Default: ""

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.

Store
string
Default: "MY"

The name of the certificate store for the client certificate.

The StoreType field denotes the type of the certificate store specified by Store. If the store is password-protected, specify the password in StorePassword.

Store is used in conjunction with the Subject field to specify client certificates. If Store has a value, and Subject or Encoded is set, a search for a certificate is initiated. Please see the Subject field for details.

Designations of certificate stores are platform dependent.

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


MY	A certificate store holding personal certificates with their associated private keys.
CA	Certifying authority certificates.
ROOT	Root certificates.

When the certificate store type is 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).

StoreB
byte []
Default: "MY"

The name of the certificate store for the client certificate.

The StoreType field denotes the type of the certificate store specified by Store. If the store is password-protected, specify the password in StorePassword.

Designations of certificate stores are platform dependent.

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


MY	A certificate store holding personal certificates with their associated private keys.
CA	Certifying authority certificates.
ROOT	Root certificates.

StorePassword
string
Default: ""

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

StoreType
CertStoreTypes
Default: 0

The type of certificate store for this certificate.

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


0 (cstUser - default)	For Windows, this specifies that the certificate store is a certificate store owned by the current user. Note: This store type is not available in Java.
1 (cstMachine)	For Windows, this specifies that the certificate store is a machine store. Note: This store type is not available in Java.
2 (cstPFXFile)	The certificate store is the name of a PFX (PKCS#12) file containing certificates.
3 (cstPFXBlob)	The certificate store is a string (binary or Base64-encoded) representing a certificate store in PFX (PKCS#12) format.
4 (cstJKSFile)	The certificate store is the name of a Java Key Store (JKS) file containing certificates. Note: This store type is only available in Java.
5 (cstJKSBlob)	The certificate store is a string (binary or Base64-encoded) representing a certificate store in Java Key Store (JKS) format. Note: This store type is only available in Java.
6 (cstPEMKeyFile)	The certificate store is the name of a PEM-encoded file that contains a private key and an optional certificate.
7 (cstPEMKeyBlob)	The certificate store is a string (binary or Base64-encoded) that contains a private key and an optional certificate.
8 (cstPublicKeyFile)	The certificate store is the name of a file that contains a PEM- or DER-encoded public key certificate.
9 (cstPublicKeyBlob)	The certificate store is a string (binary or Base64-encoded) that contains a PEM- or DER-encoded public key certificate.
10 (cstSSHPublicKeyBlob)	The certificate store is a string (binary or Base64-encoded) that contains an SSH-style public key.
11 (cstP7BFile)	The certificate store is the name of a PKCS#7 file containing certificates.
12 (cstP7BBlob)	The certificate store is a string (binary) representing a certificate store in PKCS#7 format.
13 (cstSSHPublicKeyFile)	The certificate store is the name of a file that contains an SSH-style public key.
14 (cstPPKFile)	The certificate store is the name of a file that contains a PPK (PuTTY Private Key).
15 (cstPPKBlob)	The certificate store is a string (binary) that contains a PPK (PuTTY Private Key).
16 (cstXMLFile)	The certificate store is the name of a file that contains a certificate in XML format.
17 (cstXMLBlob)	The certificate store is a string that contains a certificate in XML format.
18 (cstJWKFile)	The certificate store is the name of a file that contains a JWK (JSON Web Key).
19 (cstJWKBlob)	The certificate store is a string that contains a JWK (JSON Web Key).
21 (cstBCFKSFile)	The certificate store is the name of a file that contains a BCFKS (Bouncy Castle FIPS Key Store). Note: This store type is only available in Java and .NET.
22 (cstBCFKSBlob)	The certificate store is a string (binary or Base64-encoded) representing a certificate store in BCFKS (Bouncy Castle FIPS Key Store) format. Note: This store type is only available in Java and .NET.
23 (cstPKCS11)	The certificate is present on a physical security key accessible via a PKCS#11 interface. To use a security key, the necessary data must first be collected using the CERTMGR component. The ListStoreCertificates method may be called after setting CertStoreType to `cstPKCS11`, CertStorePassword to the PIN, and CertStore to the full path of the PKCS#11 DLL. The certificate information returned in the CertList event's `CertEncoded` parameter may be saved for later use. When using a certificate, pass the previously saved security key information as the Store and set StorePassword to the PIN. Code Example. SSH Authentication with Security Key: `certmgr.CertStoreType = CertStoreTypes.cstPKCS11; certmgr.OnCertList += (s, e) => { secKeyBlob = e.CertEncoded; }; certmgr.CertStore = @"C:\Program Files\OpenSC Project\OpenSC\pkcs11\opensc-pkcs11.dll"; certmgr.CertStorePassword = "123456"; //PIN certmgr.ListStoreCertificates(); sftp.SSHCert = new Certificate(CertStoreTypes.cstPKCS11, secKeyBlob, "123456", "*"); sftp.SSHUser = "test"; sftp.SSHLogon("myhost", 22);`
99 (cstAuto)	The store type is automatically detected from the input data. This setting may be used with both public and private keys and can detect any of the supported formats automatically.

SubjectAltNames
string (read-only)
Default: ""

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

ThumbprintMD5
string (read-only)
Default: ""

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.

ThumbprintSHA1
string (read-only)
Default: ""

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.

ThumbprintSHA256
string (read-only)
Default: ""

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.

Usage
string (read-only)
Default: ""

The text description of UsageFlags.

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.

UsageFlags
int (read-only)
Default: 0

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


0x80	Digital Signature
0x40	Non-Repudiation
0x20	Key Encipherment
0x10	Data Encipherment
0x08	Key Agreement
0x04	Certificate Signing
0x02	CRL Signing
0x01	Encipher Only

Please see the Usage field for a text representation of UsageFlags.

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

Version
string (read-only)
Default: ""

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

Subject
string
Default: ""

The subject of the certificate used for client authentication.

This field will be populated with the full subject of the loaded certificate. When loading a certificate, the subject is used to locate the certificate in the store.

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

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

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

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


Field	Meaning
CN	Common Name. This is commonly a hostname like www.server.com.
O	Organization
OU	Organizational Unit
L	Locality
S	State
C	Country
E	Email Address

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

Encoded
string
Default: ""

The certificate (PEM/Base64 encoded). This field is used to assign a specific certificate. The Store and Subject fields also may be used to specify a certificate.

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

EncodedB
byte []
Default: ""

The certificate (PEM/Base64 encoded). This field is used to assign a specific certificate. The Store and Subject fields also may be used to specify a certificate.

Constructors

C#
VB.NET

public Certificate();

Public Certificate()

Creates a instance whose properties can be set. This is useful for use with when generating new certificates.

C#
VB.NET

public Certificate(string certificateFile);

Public Certificate(ByVal CertificateFile As String)

Opens CertificateFile and reads out the contents as an X.509 public key.

C#
VB.NET

public Certificate(byte[] encoded);

Public Certificate(ByVal Encoded As Byte())

Parses Encoded as an X.509 public key.

C#
VB.NET

public Certificate(CertStoreTypes storeType, string store, string storePassword, string subject);

Public Certificate(ByVal StoreType As CertStoreTypes, ByVal Store As String, ByVal StorePassword As String, ByVal Subject As String)

StoreType identifies the type of certificate store to use. See for descriptions of the different certificate stores. Store is a file containing the certificate store. StorePassword is the password used to protect the store.

After the store has been successfully opened, the component will attempt to find the certificate identified by Subject . This can be either a complete or a substring match of the X.509 certificate's subject Distinguished Name (DN). The Subject parameter can also take an MD5, SHA-1, or SHA-256 thumbprint of the certificate to load in a "Thumbprint=value" format.

C#
VB.NET

public Certificate(CertStoreTypes storeType, string store, string storePassword, string subject, string configurationString);

Public Certificate(ByVal StoreType As CertStoreTypes, ByVal Store As String, ByVal StorePassword As String, ByVal Subject As String, ByVal ConfigurationString As String)

ConfigurationString is a newline-separated list of name-value pairs that may be used to modify the default behavior. Possible values include "PersistPFXKey", which shows whether or not the PFX key is persisted after performing operations with the private key. This correlates to the PKCS12_NO_PERSIST_KEY CryptoAPI option. The default value is True (the key is persisted). "Thumbprint" - an MD5, SHA-1, or SHA-256 thumbprint of the certificate to load. When specified, this value is used to select the certificate in the store. This is applicable to the cstUser , cstMachine , cstPublicKeyFile , and cstPFXFile store types. "UseInternalSecurityAPI" shows whether the platform (default) or the internal security API is used when performing certificate-related operations.

C#
VB.NET

public Certificate(CertStoreTypes storeType, string store, string storePassword, byte[] encoded);

Public Certificate(ByVal StoreType As CertStoreTypes, ByVal Store As String, ByVal StorePassword As String, ByVal Encoded As Byte())

After the store has been successfully opened, the component will load Encoded as an X.509 certificate and search the opened store for a corresponding private key.

C#
VB.NET

public Certificate(CertStoreTypes storeType, byte[] store, string storePassword, string subject);

Public Certificate(ByVal StoreType As CertStoreTypes, ByVal Store As Byte(), ByVal StorePassword As String, ByVal Subject As String)

StoreType identifies the type of certificate store to use. See for descriptions of the different certificate stores. Store is a byte array containing the certificate data. StorePassword is the password used to protect the store.

C#
VB.NET

public Certificate(CertStoreTypes storeType, byte[] store, string storePassword, string subject, string configurationString);

Public Certificate(ByVal StoreType As CertStoreTypes, ByVal Store As Byte(), ByVal StorePassword As String, ByVal Subject As String, ByVal ConfigurationString As String)

C#
VB.NET

public Certificate(CertStoreTypes storeType, byte[] store, string storePassword, byte[] encoded);

Public Certificate(ByVal StoreType As CertStoreTypes, ByVal Store As Byte(), ByVal StorePassword As String, ByVal Encoded As Byte())

After the store has been successfully opened, the component will load Encoded as an X.509 certificate and search the opened store for a corresponding private key.

Firewall Type

The firewall the component will connect through.

Remarks

When connecting through a firewall, this type is used to specify different properties of the firewall, such as the firewall Host and the FirewallType.

The following fields are available:

Fields

AutoDetect
bool
Default: False

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

FirewallType
FirewallTypes
Default: 0

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


fwNone (0)	No firewall (default setting).
fwTunnel (1)	Connect through a tunneling proxy. Port is set to 80.
fwSOCKS4 (2)	Connect through a SOCKS4 Proxy. Port is set to 1080.
fwSOCKS5 (3)	Connect through a SOCKS5 Proxy. Port is set to 1080.
fwSOCKS4A (10)	Connect through a SOCKS4A Proxy. Port is set to 1080.

Host
string
Default: ""

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

If this field is set to a Domain Name, a DNS request is initiated. Upon successful termination of the request, this field is set to the corresponding address. If the search is not successful, the component throws an exception.

Password
string
Default: ""

A password if authentication is to be used when connecting through the firewall. If Host is specified, the User and Password fields are used to connect and authenticate to the given firewall. If the authentication fails, the component throws an exception.

Port
int
Default: 0

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

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

User
string
Default: ""

A username if authentication is to be used when connecting through a firewall. If Host is specified, this field and the Password field are used to connect and authenticate to the given Firewall. If the authentication fails, the component throws an exception.

Constructors

C#
VB.NET

public Firewall();

Public Firewall()

GCalCalendar Type

Holds information about a calendar.

Remarks

Holds information about a calendar.

The following fields are available:

Fields

BackgroundColor
string (read-only)
Default: ""

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.

ColorId
string (read-only)
Default: ""

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

Description
string
Default: ""

Description of the calendar

ForegroundColor
string (read-only)
Default: ""

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.

Id
string (read-only)
Default: ""

The unique identifier of the calendar.

Location
string
Default: ""

Geographic location of the calendar as free-form text.

Summary
string
Default: ""

Title of the calendar.

Constructors

C#
VB.NET

public GCalCalendar();

Public GCalCalendar()

GCalColor Type

Holds information about a color.

Remarks

Holds information about a color.

The following fields are available:

Fields

Background
string (read-only)
Default: ""

The background color associated with this color definition.

Foreground
string (read-only)
Default: ""

The foreground color associated with this color definition.

Key
string (read-only)
Default: ""

The ID of the color definition

OfEvent
bool (read-only)
Default: False

Indicates the color for the events, otherwise - for calendars

Constructors

C#
VB.NET

public GCalColor();

Public GCalColor()

GCalEvent Type

Holds information about an event.

Remarks

Holds information about an event.

The following fields are available:

AttendeeAdditionalGuests

AttendeeResponseStatus

OriginalStartDateTime

OriginalStartTimeZone

RemindersOverrideIndex

RemindersOverrideMethod

RemindersOverrideMinutes

RemindersOverridesCount

Fields

AttachmentFileId
string (read-only)
Default: ""

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

AttachmentFileUrl
string
Default: ""

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.

AttachmentIconLink
string
Default: ""

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

AttachmentIndex
int
Default: 0

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

AttachmentMimeType
string
Default: ""

Internet media type (MIME type) of the attachment

AttachmentsCount
int
Default: 0

Number of file attachments for the event

AttachmentTitle
string
Default: ""

Attachment title

AttendeeAdditionalGuests
int
Default: 0

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

AttendeeComment
string
Default: ""

The attendee's response comment

AttendeeDisplayName
string
Default: ""

The attendee's name, if available

AttendeeEmail
string
Default: ""

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

AttendeeId
string (read-only)
Default: ""

The attendee's Profile ID, if available

AttendeeIndex
int
Default: 0

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

AttendeeOptional
bool
Default: False

Whether this is an optional attendee

AttendeeOrganizer
bool
Default: False

Whether the attendee is the organizer of the event

AttendeeResource
bool
Default: False

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

AttendeeResponseStatus
TGCAttendeeResponseStatus
Default: 0

The attendee's response status.

Possible values are:


0 (gcrsNeedsAction)	The attendee has not responded to the invitation (recommended for new events)
1 (gcrsDeclined)	The attendee has declined the invitation.
2 (gcrsTentative)	The attendee has tentatively accepted the invitation.
3 (gcrsAccepted)	The attendee has accepted the invitation.

AttendeesCount
int
Default: 0

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

AttendeeSelf
bool (read-only)
Default: False

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

CalendarId
string (read-only)
Default: ""

The ID of the calendar that contains the event.

ColorId
string
Default: ""

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

Created
string (read-only)
Default: ""

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

Description
string
Default: ""

Description of the event. Can contain HTML.

EndDateTime
string
Default: ""

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.

EndTimeZone
string
Default: ""

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.

Id
string (read-only)
Default: ""

Unique identifier for the event.

JSON
string
Default: ""

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.

Location
string
Default: ""

Geographic location of the event as free-form text.

OriginalStartDateTime
string (read-only)
Default: ""

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.

OriginalStartTimeZone
string (read-only)
Default: ""

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.

Recurrence
string
Default: ""

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

RecurrenceIndex
int
Default: 0

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

RecurrencesCount
int
Default: 0

Number of recurrence lines for the event.

RecurringEventId
string (read-only)
Default: ""

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

RemindersOverrideIndex
int
Default: 0

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;

RemindersOverrideMethod
TGCRemindersOverrideMethods
Default: 0

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

Possible values are:


0 (gcrmEmail)	Reminders are sent via email.
1 (gcrmPopup)	Reminders are sent via a UI popup.

RemindersOverrideMinutes
int
Default: 0

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;

RemindersOverridesCount
int
Default: 0

number of reminders overrides for the event

ReminderUseDefault
bool
Default: False

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

StartDateTime
string
Default: ""

StartTimeZone
string
Default: ""

Summary
string
Default: ""

Title of the event.

Transparency
TGCTransparencies
Default: 0

Whether the event blocks time on the calendar. Optional.

Possible values are:


0 (gctOpaque)	Default value. The event does block time on the calendar. This is equivalent to setting Show me as to Busy in the Calendar UI.
1 (gctTransparent)	The event does not block time on the calendar. This is equivalent to setting Show me as to Available in the Calendar UI.

Updated
string (read-only)
Default: ""

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

Visibility
TGCVisibilities
Default: 0

Visibility of the event. Possible values are:

Possible values are:


0 (gcvDefault)	Uses the default visibility for events on the calendar. This is the default value.
1 (gcvPublic)	The event is public and event details are visible to all readers of the calendar.
2 (gcvPrivate)	The event is private and only event attendees may view event details.
3 (gcvConfidential)	The event is private. This value is provided for compatibility reasons.

Constructors

C#
VB.NET

public GCalEvent();

Public GCalEvent()

OAuthSettings Type

The settings to use to authenticate with the service provider.

Remarks

Used to set give the component the necessary information needed to complete OAuth authentication.

The following fields are available:

Fields

AccessToken
string
Default: ""

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

AuthorizationCode
string
Default: ""

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

AuthorizationScope
string
Default: ""

The scope request or response parameter used during authorization.

ClientId
string
Default: ""

The id of the client assigned when registering the application.

ClientProfile
CloudOAuthClientProfiles
Default: 0

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


0 (cocpApplication - Default)	The application profile is applicable to applications that are run by the user directly. For instance a windows form application would use the application profile. To authorize your application (client) using the application profile see the introduction section.
1 (cocpWeb)	The Web profile is applicable to applications that are run on the server side where the user uses the application from a web browser. To authorize your application (client) using this profile follow see the introduction section.

ClientSecret
string
Default: ""

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

GrantType
OAuthSettingsGrantTypes
Default: 0

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


0 (cogtAuthorizationCode - Default)	Authorization Code grant type
1 (cogtImplicit)	Implicit grant type
2 (cogtPassword)	Resource Owner Password Credentials grant type
3 (cogtClientCredentials)	Client Credentials grant type

RefreshToken
string
Default: ""

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

RequestRefreshToken
bool
Default: True

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

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

Note: This field is only applicable when the GrantType field is set to cogtAuthorizationCode.

ReturnURL
string
Default: ""

The URL where the user (browser) returns after authenticating. This field is mapped to the redirect_uri parameter when making a request to the authorization server. Typically, this is automatically set by the component when using the embedded web server. If the OAuthWebServerPort or OAuthWebServerHost configuration settings is set, then this field 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.

ServerAuthURL
string
Default: ""

The URL of the authorization server.

ServerTokenURL
string
Default: ""

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

WebAuthURL
string (read-only)
Default: ""

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.

Constructors

C#
VB.NET

public OAuthSettings();

Public OAuthSettings()

Proxy Type

The proxy the component will connect to.

Remarks

When connecting through a proxy, this type is used to specify different properties of the proxy, such as the Server and the AuthScheme.

The following fields are available:

Fields

AuthScheme
ProxyAuthSchemes
Default: 0

The type of authorization to perform when connecting to the proxy. This is used only when the User and Password fields are set.

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

By default, AuthScheme is authBasic (0), and if the User and Password fields are set, the component will attempt basic authentication.

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

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

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

For security reasons, setting this field will clear the values of User and Password.

AutoDetect
bool
Default: False

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

Password
string
Default: ""

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

If AuthScheme is set to Basic Authentication, the User and Password fields are Base64 encoded and the proxy authentication token will be generated in the form Basic [encoded-user-password].

If AuthScheme is set to Digest Authentication, the User and Password fields are used to respond to the Digest Authentication challenge from the server.

If AuthScheme is set to NTLM Authentication, the User and Password fields are used to authenticate through NTLM negotiation.

Port
int
Default: 80

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

Server
string
Default: ""

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

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

SSL
ProxySSLTypes
Default: 0

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


psAutomatic (0)	Default setting. If the URL is an `https` URL, the component will use the `psTunnel` option. If the URL is an `http` URL, the component will use the `psNever` option.
psAlways (1)	The connection is always SSL-enabled.
psNever (2)	The connection is not SSL-enabled.
psTunnel (3)	The connection is made through a tunneling (HTTP) proxy.

User
string
Default: ""

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

If AuthScheme is set to Basic Authentication, the User and Password fields are Base64 encoded and the proxy authentication token will be generated in the form Basic [encoded-user-password].

If AuthScheme is set to Digest Authentication, the User and Password fields are used to respond to the Digest Authentication challenge from the server.

If AuthScheme is set to NTLM Authentication, the User and Password fields are used to authenticate through NTLM negotiation.

Constructors

C#
VB.NET

public Proxy();

Public Proxy()

C#
VB.NET

public Proxy(string server, int port);

Public Proxy(ByVal Server As String, ByVal Port As Integer)

C#
VB.NET

public Proxy(string server, int port, string user, string password);

Public Proxy(ByVal Server As String, ByVal Port As Integer, ByVal User As String, ByVal Password As String)

Config Settings (GoogleCalendars Component)

The component accepts one or more of the following configuration settings. Configuration settings are similar in functionality to properties, but they are rarely used. In order to avoid "polluting" the property namespace of the component, access to these internal properties is provided through the Config method.

GoogleCalendars Config Settings

CalendarsPageSize: Page size limit for fetching calendars.

This setting specifies the calendars page size, or the maximum number of calendars that will be fetched from the server in one get call.

The default value is 100.

EventsPageSize: Page size for fetching events.

This setting specifies the events page size, or the maximum number of events that will be fetched from the server in one get call.

The default value is 100.

ListCalendarsMarker: The page marker for listing calendars.

This property is populated if there are still unlisted items after ListCalendars is called. It contains the nextPageToken that will be included in the next request as a parameter if ListCalendars is called again, this will cause the next page of calendars to be listed.

Example (List All Calendars)

do { gcal.ListCalendars(); } while (gcal.Config("ListCalendarsMarker").Length > 0);

XChildCount: The number of child elements of the current element.

This configuration settings specifies the number of child attributes of the current element. The XChild configuration settings will be indexed from 0 to (XChildCount - 1).

The current element is specified through the XPath configuration setting. This configuration setting is read-only.

XChildName[i]: The name of the child element.

This configuration setting provides the name of the i-th child element of the current element.

The current element is specified through the XPath configuration setting. This configuration setting is read-only.

XChildXText[i]: The inner text of the child element.

This configuration setting provides the inner text of the i-th child element of the current element.

The current element is specified through the XPath configuration setting. This configuration setting is read-only.

XElement: The name of the current element.

This configuration setting provides the name of the current element.

The current element is specified through the XPath configuration setting. This configuration setting is read-only.

XParent: The parent of the current element.

This configuration setting provides the parent of the current element.

The current element is specified through the XPath configuration setting. This configuration setting is read-only.

XPath: Provides a way to point to a specific element in the returned XML or JSON response.

The XPath setting allows you to point to specific elements in the XML or JSON response.

When XPath is set to a valid path, XElement points to the name of the element, with XText, XParent, XSubTree, XChildCount, XChildName[i], and XChildXText[i] providing other properties of the element.

XPath syntax is available for both XML and JSON documents. An XPath is a series of one or more element accessors separated by the / character, for example, /A/B/C/D. An XPath can be absolute (i.e., it starts with /), or it can be relative to the current XPath location.

The following are possible values for an element accessor, which operates relative to the current location specified by the XPath accessors, which proceed it in the overall XPath string:


Accessor	Description
`name`	The first element with a particular name. Can be `*`.
`[i]`	The i-th element.
`name[i]`	The i-th element with a particular name.
`[last()]`	The last element.
`[last()-i]`	The element i before the last element.
`name[@attrname="attrvalue"]`	The first element with a particular name that contains the specified attribute-value pair. Supports single and double quotes. (XML Only)
`.`	The current element.
`..`	The parent element.

Note: XPath indices are 1-based.

For example, assume the following XML and JSON responses.

XML:

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

JSON:

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

The following are examples of valid XPaths for these responses:


Description	XML XPath	JSON XPath
Document root	`/`	`/json`
Specific element	`/firstlevel/one`	`/json/firstlevel/one`
i-th child	`/firstlevel/two/item[2]`	`/json/firstlevel/two/[2]`

This list is not exhaustive, but it provides a general idea of the possibilities.

XSubTree: A snapshot of the current element in the document.

This configuration setting provides the entirety of the current element (including its subelements).

The current element is specified through the XPath configuration setting. This configuration setting is read-only.

XText: The text of the current element.

This configuration setting provides the inner text of the current element.

The current element is specified in the XPath configuration setting. This configuration setting is read-only.

OAuth Config Settings

OAuthAccessTokenExpiration: The lifetime of the access token.

This setting holds the lifetime of the access token in seconds. For instance the value 3600 indicates that the token will expire in one hour from the time it was generated.

OAuthAuthorizationTokenType: The type of access token returned.

The applicable values include the following:


Bearer (default)	When the access token returned by the server is a Bearer type, the authorization string returned by Authorize will be in the format "Bearer access_token". This can be supplied as the value of the HTTP Authorization header.

OAuthAutomaticRefresh: Whether or not to refresh an expired access token automatically.

When this setting is set to true and the Authorization property is not set, the component will automatically get a new access token if it has the necessary properties to do so without user interaction.

For example, when using the Authorization Code grant type, the RefreshToken field should be set to a valid refresh token. When using the Client Credential grant type however, the component does not need any additional properties set as it can already get a new access token without user interaction.

OAuthBrowserResponseTimeout: Specifies the amount of time to wait for a response from the browser.

This setting specifies the amount of time (in seconds) the component will wait for a response from the browser when requesting user authentication. The default value is 0, meaning that the component will wait indefinitely.

OAuthIncludeEmptyRedirectURI: Whether an empty redirect_uri parameter is included in requests.

This setting specifies whether redirect_uri is included in the request made by Authorize if it is empty.

If set to true (default) the redirect_uri will be sent in all cases. If set to false the redirect_uri will only be sent if it has a value.

OAuthJWTPayload: The payload of the JWT access token if present.

This configuration setting provides the payload section of a JWT access token if the access token is a JWT and the component is able to parse out the payload section. This setting only applies to access tokens that are returned from a service provider after successfully authorizing and authenticating with the service.

To parse the payload for specific claims, see OAuthJWTXPath.

OAuthJWTXChildCount: The number of child elements of the current element.

The number of child attributes of the current element. The OAuthJWTXChildCount configuration settings will be indexed from 0 to (OAuthJWTXChildCount - 1).

The current element is specified in the OAuthJWTXPath configuration setting. This configuration setting is read-only.

OauthJWTXChildName[i]: The name of the child element.

Provides the name of the i'th child element of the current element.

The current element is specified in the OAuthJWTXPath configuration setting. This configuration setting is read-only.

OAuthJWTXChildXText[i]: The inner text of the child element.

Provides the inner text of the i'th child element of the current element.

The current element is specified in the OAuthJWTXPath configuration setting. This configuration setting is read-only.

OAuthJWTXElement: The name of the current element.

Provides the name of the current element.

The current element is specified in the OAuthJWTXPath configuration setting. This configuration setting is read-only.

OauthJWTXParent: The parent of the current element.

Provides the parent of the current element.

The current element is specified in the OAuthJWTXPath configuration setting. This configuration setting is read-only.

OAuthJWTXPath: Provides a way to point to a specific element in the returned payload of a JWT based access token.

The OAuthJWTXPath setting allows you to point to specific claims within the payload of a JWT based access token.

XPath syntax is available for the payload of JWT based access tokens if available. An XPath is a series of one or more element accessors separated by the / character, for example: /A/B/C/D.

The following are possible values for an element accessor, which operates relative to the current location specified by the XPath accessors which proceed it in the overall XPath string:


Accessor	Description
`name`	The first element with a particular name. Can be `*`.
`[i]`	The i-th element.
`name[i]`	The i-th element with a particular name.
`[last()]`	The last element.
`[last()-i]`	The element i before the last element.

Here are some examples of valid XPaths and some common claims:


Description	JSON XPath
Document root	`/json`
Specific element	`/json/element_one`
Username Claim (Microsoft Specific)	`/json/preferred_username`
Registered Application Name Claim (Microsoft Specific)	`/json/app_displayname`

This is not an exhaustive list by any means, but should provide a general idea of the possibilities. To get the text of the specified element, see OAuthJWTXText.

OAuthJWTXSubTree: A snapshot of the current element in the document.

Provides the entirety of the current element (including its sub-elements).

The current element is specified in the OAuthJWTXPath configuration setting. This configuration setting is read-only.

OAuthJWTXText: The text of the current element.

Provides the inner text of the current element.

The current element is specified in the OAuthJWTXPath configuration setting. This configuration setting is read-only.

OAuthParamCount: Specifies the number of additional parameters variables to include in the request.

This setting can be used to add query string parameters to the outgoing request. One common use for this method would be to add the "state" parameter to the request, which can be used when the ClientProfile is cocpWeb to add user defined data. The authorization server will include the "state" parameter in the response and will be available in the post back to your server which will allow you to maintain state in your application. This is used in conjunction with OAuthParamName[i] and OAuthParamValue[i]. For instance:

component.Config("OAuthParamCount=2"); component.Config("OAuthParamName[0]=myvar"); component.Config("OAuthParamValue[0]=myvalue"); component.Config("OAuthParamName[1]=testname"); component.Config("OAuthParamValue[1]=testvalue");

Additionally, this will also be updated to hold the parameters returned in the response.

for (int i = 0; i < int.Parse(component.Config("OAuthParamCount")); i++) { string name = component.Config("OAuthParamName[" + i + "]"); string value = component.Config("OAuthParamValue[" + i + "]"); }

OAuthParamName[i]: Specifies the parameter name at the specified index.

This setting can be used to retrieve or specify the parameter variable name at the index specified. See OAuthParamCount for details.

OAuthParamValue[i]: Specifies the parameter value at the specified index.

This setting can be used to retrieve or specify the parameter variable value at the index specified. See OAuthParamCount for details.

OAuthPasswordGrantUsername: Used in the Resource Owner Password grant type.

Used to set the username field when the GrantType is set to the password grant type and Authorize is called.

OAuthPKCEChallengeEncoding: The PKCE code challenge method to use.

This setting controls the PKCE code challenge method used when OAuthUsePKCE is set to true. Possible values are:

1 (Plain)
2 (S256/SHA256 - default)

OAuthPKCEVerifier: The PKCE verifier used to generate the challenge.

This configuration setting when queried provides the PKCE verifier that is used to generate the PKCE challenge for the Authorize method and the WebAuthURL field when OAuthUsePKCE is set to true. When using the cocpWeb ClientProfile, the configuration setting can be set instead to allow the authorization request to be made from a different instance than the authentication (token) request.

OAuthResetData: Determines if the Reset method applies to the OAuth settings.

If set to true (default), the Reset method will reset the OAuth settings including any authorization fields like AccessToken and RefreshToken. This means the Authorize method must be called again to get new authorization information. When set to false, the Reset method will not reset the OAuth property and the OAuth* configuration settings. This allows for the component to be reset without having to get authorization again.

OAuthReUseWebServer: Determines if the same server instance is used between requests.

If set to true (default), the same embedded web server instance will be used for multiple requests. If set to false the embedded web server will be created and destroyed on each call to Authorize

OAuthTransferredRequest: The full OAuth request last sent by the client.

This configuration setting returns the full OAuth request last sent by the client. For performance reasons, the request is not normally saved. Set this configuration setting to ON before making a request to enable it. Following are examples of this request:

.NET Gmail gmail = new Gmail(); gmail.Config("OAuthTransferredRequest=on"); gmail.Authorize(); Console.WriteLine(gmail.Config("OAuthTransferredRequest")); C++ Gmail gmail; gmail.Config("OAuthTransferredRequest=on"); gmail.Authorize(); printf("%s\r\n", gmail.Config("OAuthTransferredRequest"));

OAuthUsePKCE: Specifies if PKCE should be used.

If set to true (default), Proof Key for Code Exchange (PKCE) defined by RFC 7636 will be used when performing authorization. This setting applies when using the Authorization Code GrantType. The OAuthPKCEChallengeEncoding configuration setting can be used to control the code challenge method that will be used.

OAuthWebServerActive: Specifies and controls whether the embedded web server is active.

The setting when queried will return the current state of the web server. If the webserver is active, it will return "true" and if it is inactive it will return "false".

This setting can also be set to activate or deactivate the web server. Under normal circumstances, this would not be required as the component will automatically start and stop the web server when Authorize is called. In certain cases, it is required to start the webserver before calling Authorize. For example, if the ReturnURL needs to be set to a relay server, then you will need to start the web server manually. Another example would be when the OAuthReUseWebServer is set to true, the server will not be automatically stopped, and this configuration setting must be set to "false" to stop the embedded web server.

OAuthWebServerCertStore: The certificate with private key to use when SSL is enabled.

The name of the certificate store used for the embedded web server's SSL.

The OAuthWebServerCertStoreType field specifies the type of the certificate store specified by OAuthWebServerCertStore. If the store is password protected, specify the password in OAuthWebServerCertStorePassword.

OAuthWebServerCertStore is used in conjunction with the OAuthWebServerCertSubject field in order to specify the certificate to be used during SSL.

Designations of certificate stores are platform dependent.

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


MY	A certificate store holding personal certificates with their associated private keys.
CA	Certifying authority certificates.
ROOT	Root certificates.

Note: This is required when OAuthWebServerSSLEnabled is set to true.

OAuthWebServerCertStorePassword: The certificate with private key to use when SSL is enabled.

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

Note: This is only applicable when OAuthWebServerSSLEnabled is set to true.

OAuthWebServerCertStoreType: The certificate with private key to use when SSL is enabled.

This specifies the type of certificate store. Possible values are:


0	User - This is the default for Windows. This specifies that the certificate store is a certificate store owned by the current user. Note: This store type is not available in Java.
1	Machine - For Windows, this specifies that the certificate store is a machine store. Note: This store type is not available in Java.
2	PFXFile - The certificate store is the name of a PFX (PKCS12) file containing certificates.
3	PFXBlob - The certificate store is a string (binary or Base64-encoded) representing a certificate store in PFX (PKCS12) format.
4	JKSFile - The certificate store is the name of a Java Key Store (JKS) file containing certificates. Note: This store type is available only in Java.
5	JKSBlob - The certificate store is a string (binary or Base64-encoded) representing a certificate store in Java Key Store (JKS) format. Note: This store type is available only in Java.
6	PEMKeyFile - The certificate store is the name of a PEM-encoded file that contains a private key and an optional certificate.
7	PEMKeyBlob - The certificate store is a string (binary or Base64-encoded) that contains a private key and an optional certificate.
14	PPKFile - The certificate store is the name of a file that contains a PPK (PuTTY Private Key).
15	PPKBlob - The certificate store is a string (binary) that contains a PPK (PuTTY Private Key).
16	XMLFile - The certificate store is the name of a file that contains a certificate in XML format.
17	XMLBlob - The certificate store is a string that contains a certificate in XML format.

Note: This is required when OAuthWebServerSSLEnabled is set to true.

OAuthWebServerCertSubject: The certificate with private key to use when SSL is enabled.

The subject of the SSL certificate.

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


Field	Meaning
CN	Common Name. This is commonly a hostname like www.server.com.
O	Organization
OU	Organizational Unit
L	Locality
S	State
C	Country
E	Email Address

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

Note: This is required when OAuthWebServerSSLEnabled is set to true.

OAuthWebServerFailedResponse: The custom response that will be displayed to the user if authentication failed.

When Authorize is called the user will be redirected to the embedded web server upon completing authentication with the authorization server. If authentication failed, the HTML specified here will be sent to the user's browser.

OAuthWebServerHost: The hostname used by the embedded web server displayed in the ReturnURL.

This setting specifies the hostname used by the embedded web server when ClientProfile is set to cocpApplication. This specifies the interface on which the embedded web server listens, and also the value displayed in the ReturnURL. This should be set to the hostname only, not the full URL.

The default value is localhost.

OAuthWebServerPort: The local port on which the embedded web server listens.

This property specifies the port on which the embedded web server listens. Setting this to 0 (default) enables the system to choose a port at random. The chosen port will be returned when this setting is queried after the server has started listening.This is only applicable when using the embedded web server.

OAuthWebServerResponse: The custom response that will be displayed to the user.

When Authorize is called the user will be redirected to the embedded web server upon completing authentication with the authorization server. This setting allows you to specify the HTML that will be sent to the user's browser.

OAuthWebServerSSLEnabled: Whether the web server requires SSL connections.

This setting specifies whether the embedded web server will use SSL. If set to True OAuthWebServerCert* configs are required and the server will only accept SSL connections. If set to False only plaintext connects are supported.

HTTP Config Settings

AcceptEncoding: Used to tell the server which types of content encodings the client supports.

When AllowHTTPCompression is True, the component adds an Accept-Encoding header to the request being sent to the server. By default, this header's value is "gzip, deflate". This configuration setting allows you to change the value of the Accept-Encoding header. Note: The component only supports gzip and deflate decompression algorithms.

AllowHTTPCompression: This property enables HTTP compression for receiving data.

This configuration setting enables HTTP compression for receiving data. When set to True (default), the component will accept compressed data. It then will uncompress the data it has received. The component will handle data compressed by both gzip and deflate compression algorithms.

When True, the component adds an Accept-Encoding header to the outgoing request. The value for this header can be controlled by the AcceptEncoding configuration setting. The default value for this header is "gzip, deflate".

The default value is True.

AllowHTTPFallback: Whether HTTP/2 connections are permitted to fallback to HTTP/1.1.

This configuration setting controls whether HTTP/2 connections are permitted to fall back to HTTP/1.1 when the server does not support HTTP/2. This setting is applicable only when HTTPVersion is set to "2.0".

If set to True (default), the component will automatically use HTTP/1.1 if the server does not support HTTP/2. If set to False, the component throws an exception if the server does not support HTTP/2.

The default value is True.

AllowNTLMFallback: Whether to allow fallback from Negotiate to NTLM when authenticating.

This configuration setting applies only when AuthScheme is set to Negotiate. If set to True, the component will automatically use New Technology LAN Manager (NTLM) if the server does not support Negotiate authentication. Note: The server must indicate that it supports NTLM authentication through the WWW-Authenticate header for the fallback from Negotiate to NTLM to take place. The default value is False.

Append: Whether to append data to LocalFile.

This configuration setting determines whether data will be appended when writing to LocalFile. When set to True, downloaded data will be appended to LocalFile. This may be used in conjunction with Range to resume a failed download. This is applicable only when LocalFile is set. The default value is False.

Authorization: The Authorization string to be sent to the server.

If the Authorization property contains a nonempty string, an Authorization HTTP request header is added to the request. This header conveys Authorization information to the server.

This property is provided so that the HTTP component can be extended with other security schemes in addition to the authorization schemes already implemented by the component.

The AuthScheme property defines the authentication scheme used. In the case of HTTP Basic Authentication (default), every time User and Password are set, they are Base64 encoded, and the result is put in the Authorization property in the form "Basic [encoded-user-password]".

BytesTransferred: Contains the number of bytes transferred in the response data.

This configuration setting returns the raw number of bytes from the HTTP response data, before the component processes the data, whether it is chunked or compressed. This returns the same value as the Transfer event, by BytesTransferred.

ChunkSize: Specifies the chunk size in bytes when using chunked encoding.

This is applicable only when UseChunkedEncoding is True. This setting specifies the chunk size in bytes to be used when posting data. The default value is 16384.

CompressHTTPRequest: Set to true to compress the body of a PUT or POST request.

If set to True, the body of a PUT or POST request will be compressed into gzip format before sending the request. The "Content-Encoding" header is also added to the outgoing request.

The default value is False.

EncodeURL: If set to True the URL will be encoded by the component.

If set to True, the URL passed to the component will be URL encoded. The default value is False.

FollowRedirects: Determines what happens when the server issues a redirect.

This option determines what happens when the server issues a redirect. Normally, the component returns an error if the server responds with an "Object Moved" message. If this property is set to 1 (always), the new URL for the object is retrieved automatically every time.

If this property is set to 2 (Same Scheme), the new URL is retrieved automatically only if the URL Scheme is the same; otherwise, the component throws an exception.

Note: Following the HTTP specification, unless this option is set to 1 (Always), automatic redirects will be performed only for GET or HEAD requests. Other methods potentially could change the conditions of the initial request and create security vulnerabilities.

Furthermore, if either the new URL server or port are different from the existing one, User and Password are also reset to empty, unless this property is set to 1 (Always), in which case the same credentials are used to connect to the new server.

A Redirect event is fired for every URL the product is redirected to. In the case of automatic redirections, the Redirect event is a good place to set properties related to the new connection (e.g., new authentication parameters).

The default value is 0 (Never). In this case, redirects are never followed, and the component throws an exception instead.

Following are the valid options:

0 - Never
1 - Always
2 - Same Scheme

GetOn302Redirect: If set to True the component will perform a GET on the new location.

The default value is False. If set to True, the component will perform a GET on the new location. Otherwise, it will use the same HTTP method again.

HTTP2HeadersWithoutIndexing: HTTP2 headers that should not update the dynamic header table with incremental indexing.

HTTP/2 servers maintain a dynamic table of headers and values seen over the course of a connection. Typically, these headers are inserted into the table through incremental indexing (also known as HPACK, defined in RFC 7541). To tell the component not to use incremental indexing for certain headers, and thus not update the dynamic table, set this configuration option to a comma-delimited list of the header names.

HTTPVersion: The version of HTTP used by the component.

This property specifies the HTTP version used by the component. Possible values are as follows:

"1.0"
"1.1" (default)
"2.0"
"3.0"

When using HTTP/2 ("2.0"), additional restrictions apply. Please see the following notes for details.

HTTP/2 Notes

When using HTTP/2, a secure Secure Sockets Layer/Transport Layer Security (TLS/SSL) connection is required. Attempting to use a plaintext URL with HTTP/2 will result in an error.

If the server does not support HTTP/2, the component will automatically use HTTP/1.1 instead. This is done to provide compatibility without the need for any additional settings. To see which version was used, check NegotiatedHTTPVersion after calling a method. The AllowHTTPFallback setting controls whether this behavior is allowed (default) or disallowed.

HTTP/2 is supported on all versions of Windows. If the Windows version is an earlier version than Windows 8.1/Windows Server 2012 R2, the internal security implementation will be used. If the Windows version is Window 8.1/Windows Server 2012 R2 or later, the system security libraries will be used by default.

HTTP/3 Notes

HTTP/3 is supported only in .NET and Java.

When using HTTP/3, a secure (TLS/SSL) connection is required. Attempting to use a plaintext URL with HTTP/3 will result in an error.

IfModifiedSince: A date determining the maximum age of the desired document.

If this setting contains a nonempty string, an If-Modified-Since HTTP header is added to the request. The value of this header is used to make the HTTP request conditional: if the requested documented has not been modified since the time specified in the field, a copy of the document will not be returned from the server; instead, a 304 (not modified) response will be returned by the server and the component throws an exception

The format of the date value for IfModifiedSince is detailed in the HTTP specs. For example: Sat, 29 Oct 2017 19:43:31 GMT.

KeepAlive: Determines whether the HTTP connection is closed after completion of the request.

If true, the component will not send the Connection: Close header. The absence of the Connection header indicates to the server that HTTP persistent connections should be used if supported. Note: Not all servers support persistent connections. If false, the connection will be closed immediately after the server response is received.

The default value for KeepAlive is false.

KerberosSPN: The Service Principal Name for the Kerberos Domain Controller.

If the Service Principal Name on the Kerberos Domain Controller is not the same as the URL that you are authenticating to, the Service Principal Name should be set here.

LogLevel: The level of detail that is logged.

This configuration setting controls the level of detail that is logged through the Log event. Possible values are as follows:


0 (None)	No events are logged.
1 (Info - default)	Informational events are logged.
2 (Verbose)	Detailed data are logged.
3 (Debug)	Debug data are logged.

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

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

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

MaxHeaders: Instructs component to save the amount of headers specified that are returned by the server after a Header event has been fired.

This configuration setting should be set when the TransferredHeaders collection is to be populated when a Header event has been fired. This value represents the number of headers that are to be saved in the collection.

To save all items to the collection, set this configuration setting to -1. If no items are wanted, set this to 0, which will not save any items to the collection. The default for this configuration setting is -1, so all items will be included in the collection.

MaxHTTPCookies: Instructs component to save the amount of cookies specified that are returned by the server when a SetCookie event is fired.

This configuration setting should be set when populating the Cookies collection as a result of an HTTP request. This value represents the number of cookies that are to be saved in the collection.

MaxRedirectAttempts: Limits the number of redirects that are followed in a request.

When FollowRedirects is set to any value other than frNever, the component will follow redirects until this maximum number of redirect attempts are made. The default value is 20.

NegotiatedHTTPVersion: The negotiated HTTP version.

This configuration setting may be queried after the request is complete to indicate the HTTP version used. When HTTPVersion is set to "2.0" (if the server does not support "2.0"), then the component will fall back to using "1.1" automatically. This setting will indicate which version was used.

OtherHeaders: Other headers as determined by the user (optional).

This configuration setting can be set to a string of headers to be appended to the HTTP request headers.

The headers must follow the format "header: value" as described in the HTTP specifications. Header lines should be separated by CRLF ("\r\n") .

Use this configuration setting with caution. If this configuration setting contains invalid headers, HTTP requests may fail.

This configuration setting is useful for extending the functionality of the component beyond what is provided.

ProxyAuthorization: The authorization string to be sent to the proxy server.

This is similar to the Authorization configuration setting, but is used for proxy authorization. If this configuration setting contains a nonempty string, a Proxy-Authorization HTTP request header is added to the request. This header conveys proxy Authorization information to the server. If User and Password are specified, this value is calculated using the algorithm specified by AuthScheme.

ProxyAuthScheme: The authorization scheme to be used for the proxy.

This configuration setting is provided for use by components that do not directly expose Proxy properties.

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

This configuration setting is provided for use by components that do not directly expose Proxy properties.

ProxyPort: Port for the proxy server (default 80).

This configuration setting is provided for use by components that do not directly expose Proxy properties.

ProxyServer: Name or IP address of a proxy server (optional).

This configuration setting is provided for use by components that do not directly expose Proxy properties.

ProxyUser: A user name if authentication is to be used for the proxy.

This configuration setting is provided for use by components that do not directly expose Proxy properties.

SentHeaders: The full set of headers as sent by the client.

This configuration setting returns the complete set of raw headers as sent by the client.

StatusCode: The status code of the last response from the server.

This configuration setting contains the result code of the last response from the server.

StatusLine: The first line of the last response from the server.

This setting contains the first line of the last response from the server. The format of the line will be [HTTP version] [Result Code] [Description].

TransferredData: The contents of the last response from the server.

This configuration setting contains the contents of the last response from the server.

TransferredDataLimit: The maximum number of incoming bytes to be stored by the component.

If TransferredDataLimit is set to 0 (default), no limits are imposed. Otherwise, this reflects the maximum number of incoming bytes that can be stored by the component.

TransferredHeaders: The full set of headers as received from the server.

This configuration setting returns the complete set of raw headers as received from the server.

TransferredRequest: The full request as sent by the client.

This configuration setting returns the full request as sent by the client. For performance reasons, the request is not normally saved. Set this configuration setting to ON before making a request to enable it. Following are examples of this request:

.NET Http http = new Http(); http.Config("TransferredRequest=on"); http.PostData = "body"; http.Post("http://someserver.com"); Console.WriteLine(http.Config("TransferredRequest")); C++ HTTP http; http.Config("TransferredRequest=on"); http.SetPostData("body", 5); http.Post("http://someserver.com"); printf("%s\r\n", http.Config("TransferredRequest"));

UseChunkedEncoding: Enables or Disables HTTP chunked encoding for transfers.

If UseChunkedEncoding is set to True, the component will use HTTP-chunked encoding when posting, if possible. HTTP-chunked encoding allows large files to be sent in chunks instead of all at once. If set to False, the component will not use HTTP-chunked encoding. The default value is False.

Note: Some servers (such as the ASP.NET Development Server) may not support chunked encoding.

UseIDNs: Whether to encode hostnames to internationalized domain names.

This configuration setting specifies whether hostnames containing non-ASCII characters are encoded to internationalized domain names. When set to True, if a hostname contains non-ASCII characters, it is encoded using Punycode to an IDN (internationalized domain name).

The default value is False and the hostname will always be used exactly as specified.

UsePlatformDeflate: Whether to use the platform implementation to decompress compressed responses.

This configuration setting specifies whether the platform's deflate-algorithm implementation is used to decompress responses that use compression. If set to True (default), the platform implementation is used. If set to False, an internal implementation is used.

UsePlatformHTTPClient: Whether or not to use the platform HTTP client.

When using this configuration setting, if True, the component will use the default HTTP client for the platform (URLConnection in Java, WebRequest in .NET, or CFHTTPMessage in Mac/iOS) instead of the internal HTTP implementation. This is important for environments in which direct access to sockets is limited or not allowed (e.g., in the Google AppEngine).

UseProxyAutoConfigURL: Whether to use a Proxy auto-config file when attempting a connection.

This configuration specifies whether the component will attempt to use the Proxy auto-config URL when establishing a connection and AutoDetect is set to True.

When True (default), the component will check for the existence of a Proxy auto-config URL, and if found, will determine the appropriate proxy to use.

UserAgent: Information about the user agent (browser).

This is the value supplied in the HTTP User-Agent header. The default setting is "IPWorks HTTP Component - www.nsoftware.com".

Override the default with the name and version of your software.

TCPClient Config Settings

CloseStreamAfterTransfer: If true, the component will close the upload or download stream after the transfer.

This configuration setting determines whether the input or output stream is closed after the transfer completes. When set to True (default), all streams will be closed after a transfer is completed. To keep streams open after the transfer of data, set this to False. The default value is True.

ConnectionTimeout: Sets a separate timeout value for establishing a connection.

When set, this configuration setting allows you to specify a different timeout value for establishing a connection. Otherwise, the component will use Timeout for establishing a connection and transmitting/receiving data.

FirewallAutoDetect: Tells the component whether or not to automatically detect and use firewall system settings, if available.

This configuration setting is provided for use by components that do not directly expose Firewall properties.

FirewallHost: Name or IP address of firewall (optional).

If a FirewallHost is given, requested connections will be authenticated through the specified firewall when connecting.

If the FirewallHost setting is set to a Domain Name, a DNS request is initiated. Upon successful termination of the request, the FirewallHost setting is set to the corresponding address. If the search is not successful, an error is returned.

Note: This setting is provided for use by components that do not directly expose Firewall properties.

FirewallListener: If true, the component binds to a SOCKS firewall as a server (TCPClient only).

This entry is for TCPClient only and does not work for other components that descend from TCPClient.

If this entry is set, the component acts as a server. RemoteHost and RemotePort are used to tell the SOCKS firewall in which address and port to listen to. The firewall rules may ignore RemoteHost, and it is recommended that RemoteHost be set to empty string in this case.

RemotePort is the port in which the firewall will listen to. If set to 0, the firewall will select a random port. The binding (address and port) is provided through the ConnectionStatus event.

The connection to the firewall is made by calling the Connect method.

FirewallPassword: Password to be used if authentication is to be used when connecting through the firewall.

If FirewallHost is specified, the FirewallUser and FirewallPassword settings are used to connect and authenticate to the given firewall. If the authentication fails, the component throws an exception.

Note: This setting is provided for use by components that do not directly expose Firewall properties.

FirewallPort: The TCP port for the FirewallHost;.

The FirewallPort is set automatically when FirewallType is set to a valid value.

Note: This configuration setting is provided for use by components that do not directly expose Firewall properties.

FirewallType: Determines the type of firewall to connect through.

Possible values are as follows:


0	No firewall (default setting).
1	Connect through a tunneling proxy. FirewallPort is set to 80.
2	Connect through a SOCKS4 Proxy. FirewallPort is set to 1080.
3	Connect through a SOCKS5 Proxy. FirewallPort is set to 1080.
10	Connect through a SOCKS4A Proxy. FirewallPort is set to 1080.

Note: This setting is provided for use by components that do not directly expose Firewall properties.

FirewallUser: A user name if authentication is to be used connecting through a firewall.

If the FirewallHost is specified, the FirewallUser and FirewallPassword settings are used to connect and authenticate to the Firewall. If the authentication fails, the component throws an exception.

Note: This setting is provided for use by components that do not directly expose Firewall properties.

KeepAliveInterval: The retry interval, in milliseconds, to be used when a TCP keep-alive packet is sent and no response is received.

When set, TCPKeepAlive will automatically be set to True. A TCP keep-alive packet will be sent after a period of inactivity as defined by KeepAliveTime. If no acknowledgment is received from the remote host, the keep-alive packet will be sent again. This configuration setting specifies the interval at which the successive keep-alive packets are sent in milliseconds. This system default if this value is not specified here is 1 second.

Note: This value is not applicable in macOS.

KeepAliveTime: The inactivity time in milliseconds before a TCP keep-alive packet is sent.

When set, TCPKeepAlive will automatically be set to True. By default, the operating system will determine the time a connection is idle before a Transmission Control Protocol (TCP) keep-alive packet is sent. This system default if this value is not specified here is 2 hours. In many cases, a shorter interval is more useful. Set this value to the desired interval in milliseconds.

Linger: When set to True, connections are terminated gracefully.

This property controls how a connection is closed. The default is True.

In the case that Linger is True (default), two scenarios determine how long the connection will linger. In the first, if LingerTime is 0 (default), the system will attempt to send pending data for a connection until the default IP timeout expires.

In the second scenario, if LingerTime is a positive value, the system will attempt to send pending data until the specified LingerTime is reached. If this attempt fails, then the system will reset the connection.

The default behavior (which is also the default mode for stream sockets) might result in a long delay in closing the connection. Although the component returns control immediately, the system could hold system resources until all pending data are sent (even after your application closes).

Setting this property to False forces an immediate disconnection. If you know that the other side has received all the data you sent (e.g., by a client acknowledgment), setting this property to False might be the appropriate course of action.

LingerTime: Time in seconds to have the connection linger.

LingerTime is the time, in seconds, the socket connection will linger. This value is 0 by default, which means it will use the default IP timeout.

LocalHost: The name of the local host through which connections are initiated or accepted.

The LocalHost setting contains the name of the local host as obtained by the gethostname() system call, or if the user has assigned an IP address, the value of that address.

In multihomed hosts (machines with more than one IP interface), setting LocalHost to the value of an interface will make the component initiate connections (or accept in the case of server components) only through that interface.

If the component is connected, the LocalHost setting shows the IP address of the interface through which the connection is made in internet dotted format (aaa.bbb.ccc.ddd). In most cases, this is the address of the local host, except for multihomed hosts (machines with more than one IP interface).

LocalPort: The port in the local host where the component binds.

This configuration setting must be set before a connection is attempted. It instructs the component to bind to a specific port (or communication endpoint) in the local machine.

Setting this to 0 (default) enables the system to choose a port at random. The chosen port will be shown by LocalPort after the connection is established.

LocalPort cannot be changed once a connection is made. Any attempt to set this when a connection is active will generate an error.

This configuration setting is useful when trying to connect to services that require a trusted port on the client side. An example is the remote shell (rsh) service in UNIX systems.

MaxLineLength: The maximum amount of data to accumulate when no EOL is found.

MaxLineLength is the size of an internal buffer, which holds received data while waiting for an EOL string.

If an EOL string is found in the input stream before MaxLineLength bytes are received, the DataIn event is fired with the EOL parameter set to True, and the buffer is reset.

If no EOL is found, and MaxLineLength bytes are accumulated in the buffer, the DataIn event is fired with the EOL parameter set to False, and the buffer is reset.

The minimum value for MaxLineLength is 256 bytes. The default value is 2048 bytes.

MaxTransferRate: The transfer rate limit in bytes per second.

This configuration setting can be used to throttle outbound TCP traffic. Set this to the number of bytes to be sent per second. By default, this is not set and there is no limit.

ProxyExceptionsList: A semicolon separated list of hosts and IPs to bypass when using a proxy.

This configuration setting optionally specifies a semicolon-separated list of hostnames or IP addresses to bypass when a proxy is in use. When requests are made to hosts specified in this property, the proxy will not be used. For instance:

www.google.com;www.nsoftware.com

TCPKeepAlive: Determines whether or not the keep alive socket option is enabled.

If set to True, the socket's keep-alive option is enabled and keep-alive packets will be sent periodically to maintain the connection. Set KeepAliveTime and KeepAliveInterval to configure the timing of the keep-alive packets.

Note: This value is not applicable in Java.

TcpNoDelay: Whether or not to delay when sending packets.

When set to True, the socket will send all data that are ready to send at once. When set to False, the socket will send smaller buffered packets of data at small intervals. This is known as the Nagle algorithm.

By default, this configuration setting is set to False.

UseIPv6: Whether to use IPv6.

When set to 0 (default), the component will use IPv4 exclusively. When set to 1, the component will use IPv6 exclusively. To instruct the component to prefer IPv6 addresses, but use IPv4 if IPv6 is not supported on the system, this setting should be set to 2. The default value is 0. Possible values are as follows:


0	IPv4 only
1	IPv6 only
2	IPv6 with IPv4 fallback

UseNTLMv2: Whether to use NTLM V2.

When authenticating with NTLM, this setting specifies whether NTLM V2 is used. By default this value is False and NTLM V1 will be used. Set this to True to use NTLM V2.

SSL Config Settings

CACertFilePaths: The paths to CA certificate files when using Mono on Unix/Linux.

This configuration setting specifies the paths on disk to certificate authority (CA) certificate files when using Mono on Unix/Linux. It is not applicable in any other circumstances.

The value is formatted as a list of paths separated by semicolons. The component will check for the existence of each file in the order specified. When a file is found, the CA certificates within the file will be loaded and used to determine the validity of server or client certificates.

The default value is as follows:

/etc/ssl/ca-bundle.pem;/etc/pki/tls/certs/ca-bundle.crt;/etc/ssl/certs/ca-certificates.crt;/etc/pki/tls/cacert.pem

LogSSLPackets: Controls whether SSL packets are logged when using the internal security API.

When SSLProvider is set to Internal, this configuration setting controls whether Secure Sockets Layer (SSL) packets should be logged. By default, this configuration setting is False, as it is useful only for debugging purposes.

When enabled, SSL packet logs are output using the SSLStatus event, which will fire each time an SSL packet is sent or received.

Enabling this configuration setting has no effect if SSLProvider is set to Platform.

ReuseSSLSession: Determines if the SSL session is reused.

If set to True, the component will reuse the context if and only if the following criteria are met:

The target host name is the same.
The system cache entry has not expired (default timeout is 10 hours).
The application process that calls the function is the same.
The logon session is the same.
The instance of the component is the same.

SSLCACerts: A newline separated list of CA certificates to be included when performing an SSL handshake.

When SSLProvider is set to Internal, this configuration setting specifies one or more CA certificates to be included with the SSLCert property. Some servers or clients require the entire chain, including CA certificates, to be presented when performing SSL authentication. The value of this configuration setting is a newline-separated (CR/LF) list of certificates. For instance:

-----BEGIN CERTIFICATE-----
MIIEKzCCAxOgAwIBAgIRANTET4LIkxdH6P+CFIiHvTowDQYJKoZIhvcNAQELBQAw
... Intermediate Cert ...
eWHV5OW1K53o/atv59sOiW5K3crjFhsBOd5Q+cJJnU+SWinPKtANXMht+EDvYY2w
F0I1XhM+pKj7FjDr+XNj
-----END CERTIFICATE-----
\r \n
-----BEGIN CERTIFICATE-----
MIIEFjCCAv6gAwIBAgIQetu1SMxpnENAnnOz1P+PtTANBgkqhkiG9w0BAQUFADBp
... Root Cert ...
d8q23djXZbVYiIfE9ebr4g3152BlVCHZ2GyPdjhIuLeH21VbT/dyEHHA
-----END CERTIFICATE-----

SSLCheckCRL: Whether to check the Certificate Revocation List for the server certificate.

This configuration setting specifies whether the component will check the Certificate Revocation List (CRL) specified by the server certificate. If set to 1 or 2, the component will first obtain the list of CRL URLs from the server certificate's CRL distribution points extension. The component will then make HTTP requests to each CRL endpoint to check the validity of the server's certificate. If the certificate has been revoked or any other issues are found during validation the component throws an exception.

When set to 0 (default), the CRL check will not be performed by the component. When set to 1, it will attempt to perform the CRL check, but it will continue without an error if the server's certificate does not support CRL. When set to 2, it will perform the CRL check and will throw an error if CRL is not supported.

This configuration setting is supported only in the Java, C#, and C++ editions. In the C++ edition, it is supported only on Windows operating systems.

SSLCheckOCSP: Whether to use OCSP to check the status of the server certificate.

This configuration setting specifies whether the component will use OCSP to check the validity of the server certificate. If set to 1 or 2, the component will first obtain the Online Certificate Status Protocol (OCSP) URL from the server certificate's OCSP extension. The component will then locate the issuing certificate and make an HTTP request to the OCSP endpoint to check the validity of the server's certificate. If the certificate has been revoked or any other issues are found during validation, the component throws an exception.

When set to 0 (default), the component will not perform an OCSP check. When set to 1, it will attempt to perform the OCSP check, but it will continue without an error if the server's certificate does not support OCSP. When set to 2, it will perform the OCSP check and will throw an error if OCSP is not supported.

This configuration setting is supported only in the Java, C#, and C++ editions. In the C++ edition, it is supported only on Windows operating systems.

SSLCipherStrength: The minimum cipher strength used for bulk encryption.

This minimum cipher strength is largely dependent on the security modules installed on the system. If the cipher strength specified is not supported, an error will be returned when connections are initiated.

Note: This configuration setting contains the minimum cipher strength requested from the security library. The actual cipher strength used for the connection is shown by the SSLStatus event.

Use this configuration setting with caution. Requesting a lower cipher strength than necessary could potentially cause serious security vulnerabilities in your application.

When the provider is OpenSSL, SSLCipherStrength is currently not supported. This functionality is instead made available through the OpenSSLCipherList configuration setting.

SSLClientCACerts: A newline separated list of CA certificates to use during SSL client certificate validation.

This configuration setting is only applicable to server components (e.g., TCPServer) see SSLServerCACerts for client components (e.g., TCPClient). This setting can be used to optionally specify one or more CA certificates to be used when verifying the client certificate that is presented by the client during the SSL handshake when SSLAuthenticateClients is enabled. When verifying the client's certificate, the certificates trusted by the system will be used as part of the verification process. If the client's CA certificates are not installed to the trusted system store, they may be specified here so they are included when performing the verification process. This configuration setting should be set only if the client's CA certificates are not already trusted on the system and cannot be installed to the trusted system store.

The value of this configuration setting is a newline-separated (CR/LF) list of certificates. For instance:

-----BEGIN CERTIFICATE-----
MIIEKzCCAxOgAwIBAgIRANTET4LIkxdH6P+CFIiHvTowDQYJKoZIhvcNAQELBQAw
... Intermediate Cert ...
eWHV5OW1K53o/atv59sOiW5K3crjFhsBOd5Q+cJJnU+SWinPKtANXMht+EDvYY2w
F0I1XhM+pKj7FjDr+XNj
-----END CERTIFICATE-----
\r \n
-----BEGIN CERTIFICATE-----
MIIEFjCCAv6gAwIBAgIQetu1SMxpnENAnnOz1P+PtTANBgkqhkiG9w0BAQUFADBp
... Root Cert ...
d8q23djXZbVYiIfE9ebr4g3152BlVCHZ2GyPdjhIuLeH21VbT/dyEHHA
-----END CERTIFICATE-----

SSLEnabledCipherSuites: The cipher suite to be used in an SSL negotiation.

This configuration setting enables the cipher suites to be used in SSL negotiation.

By default, the enabled cipher suites will include all available ciphers ("*").

The special value "*" means that the component will pick all of the supported cipher suites. If SSLEnabledCipherSuites is set to any other value, only the specified cipher suites will be considered.

Multiple cipher suites are separated by semicolons.

Example values when SSLProvider is set to Platform include the following: obj.config("SSLEnabledCipherSuites=*"); obj.config("SSLEnabledCipherSuites=CALG_AES_256"); obj.config("SSLEnabledCipherSuites=CALG_AES_256;CALG_3DES"); Possible values when SSLProvider is set to Platform include the following:

CALG_3DES
CALG_3DES_112
CALG_AES
CALG_AES_128
CALG_AES_192
CALG_AES_256
CALG_AGREEDKEY_ANY
CALG_CYLINK_MEK
CALG_DES
CALG_DESX
CALG_DH_EPHEM
CALG_DH_SF
CALG_DSS_SIGN
CALG_ECDH
CALG_ECDH_EPHEM
CALG_ECDSA
CALG_ECMQV
CALG_HASH_REPLACE_OWF
CALG_HUGHES_MD5
CALG_HMAC
CALG_KEA_KEYX
CALG_MAC
CALG_MD2
CALG_MD4
CALG_MD5
CALG_NO_SIGN
CALG_OID_INFO_CNG_ONLY
CALG_OID_INFO_PARAMETERS
CALG_PCT1_MASTER
CALG_RC2
CALG_RC4
CALG_RC5
CALG_RSA_KEYX
CALG_RSA_SIGN
CALG_SCHANNEL_ENC_KEY
CALG_SCHANNEL_MAC_KEY
CALG_SCHANNEL_MASTER_HASH
CALG_SEAL
CALG_SHA
CALG_SHA1
CALG_SHA_256
CALG_SHA_384
CALG_SHA_512
CALG_SKIPJACK
CALG_SSL2_MASTER
CALG_SSL3_MASTER
CALG_SSL3_SHAMD5
CALG_TEK
CALG_TLS1_MASTER
CALG_TLS1PRF

Example values when SSLProvider is set to Internalinclude the following:

obj.config("SSLEnabledCipherSuites=*");
obj.config("SSLEnabledCipherSuites=TLS_DHE_DSS_WITH_AES_128_CBC_SHA");
obj.config("SSLEnabledCipherSuites=TLS_DHE_DSS_WITH_AES_128_CBC_SHA;TLS_ECDH_RSA_WITH_AES_128_CBC_SHA");

Possible values when SSLProvider is set to Internal include the following:

TLS_ECDHE_ECDSA_WITH_AES_256_GCM_SHA384
TLS_ECDHE_ECDSA_WITH_AES_128_GCM_SHA256
TLS_ECDHE_RSA_WITH_AES_128_GCM_SHA256
TLS_ECDHE_RSA_WITH_AES_256_GCM_SHA384
TLS_ECDH_ECDSA_WITH_AES_256_GCM_SHA384
TLS_RSA_WITH_AES_256_GCM_SHA384
TLS_RSA_WITH_AES_128_GCM_SHA256
TLS_ECDH_ECDSA_WITH_AES_128_GCM_SHA256
TLS_DHE_DSS_WITH_AES_256_GCM_SHA384
TLS_DHE_RSA_WITH_AES_256_GCM_SHA384
TLS_ECDH_RSA_WITH_AES_256_GCM_SHA384
TLS_ECDH_RSA_WITH_AES_128_GCM_SHA256
TLS_DHE_RSA_WITH_AES_128_GCM_SHA256
TLS_DHE_DSS_WITH_AES_128_GCM_SHA256
TLS_ECDHE_ECDSA_WITH_AES_256_CBC_SHA384
TLS_ECDHE_ECDSA_WITH_AES_128_CBC_SHA256
TLS_ECDH_ECDSA_WITH_AES_256_CBC_SHA384
TLS_DHE_DSS_WITH_AES_256_CBC_SHA256
TLS_RSA_WITH_AES_256_CBC_SHA256
TLS_ECDHE_RSA_WITH_AES_256_CBC_SHA384
TLS_ECDH_RSA_WITH_AES_256_CBC_SHA384
TLS_DHE_RSA_WITH_AES_256_CBC_SHA256
TLS_DHE_RSA_WITH_AES_128_CBC_SHA256
TLS_ECDHE_RSA_WITH_AES_128_CBC_SHA256
TLS_RSA_WITH_AES_128_CBC_SHA256
TLS_ECDH_ECDSA_WITH_AES_128_CBC_SHA256
TLS_ECDH_RSA_WITH_AES_128_CBC_SHA256
TLS_DHE_DSS_WITH_AES_128_CBC_SHA256
TLS_RSA_WITH_AES_256_CBC_SHA
TLS_ECDHE_ECDSA_WITH_AES_256_CBC_SHA
TLS_ECDHE_RSA_WITH_AES_256_CBC_SHA
TLS_ECDH_ECDSA_WITH_AES_256_CBC_SHA
TLS_DHE_RSA_WITH_AES_256_CBC_SHA
TLS_ECDH_RSA_WITH_AES_256_CBC_SHA
TLS_DHE_DSS_WITH_AES_256_CBC_SHA
TLS_RSA_WITH_AES_128_CBC_SHA
TLS_ECDHE_RSA_WITH_AES_128_CBC_SHA
TLS_ECDHE_ECDSA_WITH_AES_128_CBC_SHA
TLS_ECDH_ECDSA_WITH_AES_128_CBC_SHA
TLS_ECDH_RSA_WITH_AES_128_CBC_SHA
TLS_DHE_RSA_WITH_AES_128_CBC_SHA
TLS_DHE_DSS_WITH_AES_128_CBC_SHA
TLS_ECDHE_ECDSA_WITH_3DES_EDE_CBC_SHA
TLS_ECDHE_RSA_WITH_3DES_EDE_CBC_SHA
TLS_ECDH_ECDSA_WITH_3DES_EDE_CBC_SHA
TLS_ECDH_RSA_WITH_3DES_EDE_CBC_SHA
TLS_DHE_RSA_WITH_3DES_EDE_CBC_SHA
TLS_DHE_DSS_WITH_3DES_EDE_CBC_SHA
TLS_RSA_WITH_3DES_EDE_CBC_SHA
TLS_RSA_WITH_DES_CBC_SHA
TLS_DHE_RSA_WITH_DES_CBC_SHA
TLS_DHE_DSS_WITH_DES_CBC_SHA
TLS_RSA_WITH_RC4_128_MD5
TLS_RSA_WITH_RC4_128_SHA

When TLS 1.3 is negotiated (see SSLEnabledProtocols), only the following cipher suites are supported:

TLS_AES_256_GCM_SHA384
TLS_CHACHA20_POLY1305_SHA256
TLS_AES_128_GCM_SHA256

SSLEnabledCipherSuites is used together with SSLCipherStrength.

SSLEnabledProtocols: Used to enable/disable the supported security protocols.

This configuration setting is used to enable or disable the supported security protocols.

Not all supported protocols are enabled by default. The default value is 4032 for client components, and 3072 for server components. To specify a combination of enabled protocol versions set this config to the binary OR of one or more of the following values:


TLS1.3	12288 (Hex 3000)
TLS1.2	3072 (Hex C00) (Default - Client and Server)
TLS1.1	768 (Hex 300) (Default - Client)
TLS1	192 (Hex C0) (Default - Client)
SSL3	48 (Hex 30)
SSL2	12 (Hex 0C)

Note that only TLS 1.2 is enabled for server components that accept incoming connections. This adheres to industry standards to ensure a secure connection. Client components enable TLS 1.0, TLS 1.1, and TLS 1.2 by default and will negotiate the highest mutually supported version when connecting to a server, which should be TLS 1.2 in most cases.

SSLEnabledProtocols: Transport Layer Security (TLS) 1.3 Notes:

By default when TLS 1.3 is enabled, the component will use the internal TLS implementation when the SSLProvider is set to Automatic for all editions.

In editions that are designed to run on Windows, SSLProvider can be set to Platform to use the platform implementation instead of the internal implementation. When configured in this manner, please note that the platform provider is supported only on Windows 11/Windows Server 2022 and up. The default internal provider is available on all platforms and is not restricted to any specific OS version.

If set to 1 (Platform provider), please be aware of the following notes:

The platform provider is available only on Windows 11/Windows Server 2022 and up.
SSLEnabledCipherSuites and other similar SSL configuration settings are not supported.
If SSLEnabledProtocols includes both TLS 1.3 and TLS 1.2, these restrictions are still applicable even if TLS 1.2 is negotiated. Enabling TLS 1.3 with the platform provider changes the implementation used for all TLS versions.

SSLEnabledProtocols: SSL2 and SSL3 Notes:

SSL 2.0 and 3.0 are not supported by the component when the SSLProvider is set to internal. To use SSL 2.0 or SSL 3.0, the platform security API must have the protocols enabled and SSLProvider needs to be set to platform.

SSLEnableRenegotiation: Whether the renegotiation_info SSL extension is supported.

This configuration setting specifies whether the renegotiation_info SSL extension will be used in the request when using the internal security API. This configuration setting is false by default, but it can be set to true to enable the extension.

This configuration setting is applicable only when SSLProvider is set to Internal.

SSLIncludeCertChain: Whether the entire certificate chain is included in the SSLServerAuthentication event.

This configuration setting specifies whether the Encoded parameter of the SSLServerAuthentication event contains the full certificate chain. By default this value is False and only the leaf certificate will be present in the Encoded parameter of the SSLServerAuthentication event.

If set to True, all certificates returned by the server will be present in the Encoded parameter of the SSLServerAuthentication event. This includes the leaf certificate, any intermediate certificate, and the root certificate.

Note: When SSLProvider is set to Internal this value is automatically set to true. This is needed for proper validation when using the internal provider.

SSLKeyLogFile: The location of a file where per-session secrets are written for debugging purposes.

This configuration setting optionally specifies the full path to a file on disk where per-session secrets are stored for debugging purposes.

When set, the component will save the session secrets in the same format as the SSLKEYLOGFILE environment variable functionality used by most major browsers and tools, such as Chrome, Firefox, and cURL. This file can then be used in tools such as Wireshark to decrypt TLS traffic for debugging purposes. When writing to this file, the component will only append, it will not overwrite previous values.

Note: This configuration setting is applicable only when SSLProvider is set to Internal.

SSLNegotiatedCipher: Returns the negotiated cipher suite.

This configuration setting returns the cipher suite negotiated during the SSL handshake.

Note: For server components (e.g., TCPServer), this is a per-connection configuration setting accessed by passing the ConnectionId. For example: server.Config("SSLNegotiatedCipher[connId]");

SSLNegotiatedCipherStrength: Returns the negotiated cipher suite strength.

This configuration setting returns the strength of the cipher suite negotiated during the SSL handshake.

Note: For server components (e.g., TCPServer), this is a per-connection configuration setting accessed by passing the ConnectionId. For example: server.Config("SSLNegotiatedCipherStrength[connId]");

SSLNegotiatedCipherSuite: Returns the negotiated cipher suite.

This configuration setting returns the cipher suite negotiated during the SSL handshake represented as a single string.

SSLNegotiatedKeyExchange: Returns the negotiated key exchange algorithm.

This configuration setting returns the key exchange algorithm negotiated during the SSL handshake.

SSLNegotiatedKeyExchangeStrength: Returns the negotiated key exchange algorithm strength.

This configuration setting returns the strength of the key exchange algorithm negotiated during the SSL handshake.

SSLNegotiatedVersion: Returns the negotiated protocol version.

This configuration setting returns the protocol version negotiated during the SSL handshake.

Note: For server components (e.g., TCPServer), this is a per-connection configuration setting accessed by passing the ConnectionId. For example: server.Config("SSLNegotiatedVersion[connId]");

SSLSecurityFlags: Flags that control certificate verification.

The following flags are defined (specified in hexadecimal notation). They can be ORed together to exclude multiple conditions:


0x00000001	Ignore time validity status of certificate.
0x00000002	Ignore time validity status of CTL.
0x00000004	Ignore non-nested certificate times.
0x00000010	Allow unknown certificate authority.
0x00000020	Ignore wrong certificate usage.
0x00000100	Ignore unknown certificate revocation status.
0x00000200	Ignore unknown CTL signer revocation status.
0x00000400	Ignore unknown certificate authority revocation status.
0x00000800	Ignore unknown root revocation status.
0x00008000	Allow test root certificate.
0x00004000	Trust test root certificate.
0x80000000	Ignore non-matching CN (certificate CN non-matching server name).

This functionality is currently not available in Java or when the provider is OpenSSL.

SSLServerCACerts: A newline separated list of CA certificates to use during SSL server certificate validation.

This configuration setting is only used by client components (e.g., TCPClient) see SSLClientCACerts for server components (e.g., TCPServer). This configuration setting can be used to optionally specify one or more CA certificates to be used when connecting to the server and verifying the server certificate. When verifying the server's certificate, the certificates trusted by the system will be used as part of the verification process. If the server's CA certificates are not installed to the trusted system store, they may be specified here so they are included when performing the verification process. This configuration setting should be set only if the server's CA certificates are not already trusted on the system and cannot be installed to the trusted system store.

The value of this configuration setting is a newline-separated (CR/LF) list of certificates. For instance:

-----BEGIN CERTIFICATE-----
MIIEKzCCAxOgAwIBAgIRANTET4LIkxdH6P+CFIiHvTowDQYJKoZIhvcNAQELBQAw
... Intermediate Cert...
eWHV5OW1K53o/atv59sOiW5K3crjFhsBOd5Q+cJJnU+SWinPKtANXMht+EDvYY2w
F0I1XhM+pKj7FjDr+XNj
-----END CERTIFICATE-----
\r \n
-----BEGIN CERTIFICATE-----
MIIEFjCCAv6gAwIBAgIQetu1SMxpnENAnnOz1P+PtTANBgkqhkiG9w0BAQUFADBp
... Root Cert...
d8q23djXZbVYiIfE9ebr4g3152BlVCHZ2GyPdjhIuLeH21VbT/dyEHHA
-----END CERTIFICATE-----

TLS12SignatureAlgorithms: Defines the allowed TLS 1.2 signature algorithms when SSLProvider is set to Internal.

This configuration setting specifies the allowed server certificate signature algorithms when SSLProvider is set to Internal and SSLEnabledProtocols is set to allow TLS 1.2.

When specified the component will verify that the server certificate signature algorithm is among the values specified in this configuration setting. If the server certificate signature algorithm is unsupported, the component throws an exception.

The format of this value is a comma-separated list of hash-signature combinations. For instance: component.SSLProvider = TCPClientSSLProviders.sslpInternal; component.Config("SSLEnabledProtocols=3072"); //TLS 1.2 component.Config("TLS12SignatureAlgorithms=sha256-rsa,sha256-dsa,sha1-rsa,sha1-dsa"); The default value for this configuration setting is sha512-ecdsa,sha512-rsa,sha512-dsa,sha384-ecdsa,sha384-rsa,sha384-dsa,sha256-ecdsa,sha256-rsa,sha256-dsa,sha224-ecdsa,sha224-rsa,sha224-dsa,sha1-ecdsa,sha1-rsa,sha1-dsa.

To not restrict the server's certificate signature algorithm, specify an empty string as the value for this configuration setting, which will cause the signature_algorithms TLS 1.2 extension to not be sent.

TLS12SupportedGroups: The supported groups for ECC.

This configuration setting specifies a comma-separated list of named groups used in TLS 1.2 for ECC.

The default value is ecdhe_secp256r1,ecdhe_secp384r1,ecdhe_secp521r1.

When using TLS 1.2 and SSLProvider is set to Internal, the values refer to the supported groups for ECC. The following values are supported:

"ecdhe_secp256r1" (default)
"ecdhe_secp384r1" (default)
"ecdhe_secp521r1" (default)

TLS13KeyShareGroups: The groups for which to pregenerate key shares.

This configuration setting specifies a comma-separated list of named groups used in TLS 1.3 for key exchange. The groups specified here will have key share data pregenerated locally before establishing a connection. This can prevent an additional roundtrip during the handshake if the group is supported by the server.

The default value is set to balance common supported groups and the computational resources required to generate key shares. As a result, only some groups are included by default in this configuration setting.

Note: All supported groups can always be used during the handshake even if not listed here, but if a group is used that is not present in this list, it will incur an additional roundtrip and time to generate the key share for that group.

In most cases, this configuration setting does not need to be modified. This should be modified only if there is a specific reason to do so.

The default value is ecdhe_x25519,ecdhe_secp256r1,ecdhe_secp384r1,ffdhe_2048,ffdhe_3072

The values are ordered from most preferred to least preferred. The following values are supported:

"ecdhe_x25519" (default)
"ecdhe_x448"
"ecdhe_secp256r1" (default)
"ecdhe_secp384r1" (default)
"ecdhe_secp521r1"
"ffdhe_2048" (default)
"ffdhe_3072" (default)
"ffdhe_4096"
"ffdhe_6144"
"ffdhe_8192"

TLS13SignatureAlgorithms: The allowed certificate signature algorithms.

This configuration setting holds a comma-separated list of allowed signature algorithms. Possible values include the following:

"ed25519" (default)
"ed448" (default)
"ecdsa_secp256r1_sha256" (default)
"ecdsa_secp384r1_sha384" (default)
"ecdsa_secp521r1_sha512" (default)
"rsa_pkcs1_sha256" (default)
"rsa_pkcs1_sha384" (default)
"rsa_pkcs1_sha512" (default)
"rsa_pss_sha256" (default)
"rsa_pss_sha384" (default)
"rsa_pss_sha512" (default)

The default value is rsa_pss_sha256,rsa_pss_sha384,rsa_pss_sha512,rsa_pkcs1_sha256,rsa_pkcs1_sha384,rsa_pkcs1_sha512,ecdsa_secp256r1_sha256,ecdsa_secp384r1_sha384,ecdsa_secp521r1_sha512,ed25519,ed448. This configuration setting is applicable only when SSLEnabledProtocols includes TLS 1.3.

TLS13SupportedGroups: The supported groups for (EC)DHE key exchange.

This configuration setting specifies a comma-separated list of named groups used in TLS 1.3 for key exchange. This configuration setting should be modified only if there is a specific reason to do so.

The default value is ecdhe_x25519,ecdhe_x448,ecdhe_secp256r1,ecdhe_secp384r1,ecdhe_secp521r1,ffdhe_2048,ffdhe_3072,ffdhe_4096,ffdhe_6144,ffdhe_8192

The values are ordered from most preferred to least preferred. The following values are supported:

"ecdhe_x25519" (default)
"ecdhe_x448" (default)
"ecdhe_secp256r1" (default)
"ecdhe_secp384r1" (default)
"ecdhe_secp521r1" (default)
"ffdhe_2048" (default)
"ffdhe_3072" (default)
"ffdhe_4096" (default)
"ffdhe_6144" (default)
"ffdhe_8192" (default)

Socket Config Settings

AbsoluteTimeout: Determines whether timeouts are inactivity timeouts or absolute timeouts.

If AbsoluteTimeout is set to True, any method that does not complete within Timeout seconds will be aborted. By default, AbsoluteTimeout is False, and the timeout is an inactivity timeout.

Note: This option is not valid for User Datagram Protocol (UDP) ports.

FirewallData: Used to send extra data to the firewall.

When the firewall is a tunneling proxy, use this property to send custom (additional) headers to the firewall (e.g., headers for custom authentication schemes).

InBufferSize: The size in bytes of the incoming queue of the socket.

This is the size of an internal queue in the Transmission Control Protocol (TCP)/IP stack. You can increase or decrease its size depending on the amount of data that you will be receiving. In some cases, increasing the value of the InBufferSize setting can provide significant improvements in performance.

Some TCP/IP implementations do not support variable buffer sizes. If that is the case, when the component is activated the InBufferSize reverts to its defined size. The same happens if you attempt to make it too large or too small.

OutBufferSize: The size in bytes of the outgoing queue of the socket.

This is the size of an internal queue in the TCP/IP stack. You can increase or decrease its size depending on the amount of data that you will be sending. In some cases, increasing the value of the OutBufferSize setting can provide significant improvements in performance.

Some TCP/IP implementations do not support variable buffer sizes. If that is the case, when the component is activated the OutBufferSize reverts to its defined size. The same happens if you attempt to make it too large or too small.

Base Config Settings

BuildInfo: Information about the product's build.

When queried, this setting will return a string containing information about the product's build.

GUIAvailable: Whether or not a message loop is available for processing events.

In a GUI-based application, long-running blocking operations may cause the application to stop responding to input until the operation returns. The component will attempt to discover whether or not the application has a message loop and, if one is discovered, it will process events in that message loop during any such blocking operation.

In some non-GUI applications, an invalid message loop may be discovered that will result in errant behavior. In these cases, setting GUIAvailable to false will ensure that the component does not attempt to process external events.

LicenseInfo: Information about the current license.

When queried, this setting will return a string containing information about the license this instance of a component is using. It will return the following information:

Product: The product the license is for.
Product Key: The key the license was generated from.
License Source: Where the license was found (e.g., RuntimeLicense, License File).
License Type: The type of license installed (e.g., Royalty Free, Single Server).
Last Valid Build: The last valid build number for which the license will work.

MaskSensitiveData: Whether sensitive data is masked in log messages.

In certain circumstances it may be beneficial to mask sensitive data, like passwords, in log messages. Set this to true to mask sensitive data. The default is true.

This setting only works on these components: AS3Receiver, AS3Sender, Atom, Client(3DS), FTP, FTPServer, IMAP, OFTPClient, SSHClient, SCP, Server(3DS), Sexec, SFTP, SFTPServer, SSHServer, TCPClient, TCPServer.

UseFIPSCompliantAPI: Tells the component whether or not to use FIPS certified APIs.

When set to true, the component will utilize the underlying operating system's certified APIs. Java editions, regardless of OS, utilize Bouncy Castle Federal Information Processing Standards (FIPS), while all other Windows editions make use of Microsoft security libraries.

FIPS mode can be enabled by setting the UseFIPSCompliantAPI configuration setting to true. This is a static setting that applies to all instances of all components of the toolkit within the process. It is recommended to enable or disable this setting once before the component has been used to establish a connection. Enabling FIPS while an instance of the component is active and connected may result in unexpected behavior.

For more details, please see the FIPS 140-2 Compliance article.

Note: This setting is applicable only on Windows.

Note: Enabling FIPS compliance requires a special license; please contact sales@nsoftware.com for details.

UseInternalSecurityAPI: Whether or not to use the system security libraries or an internal implementation.

When set to false, the component will use the system security libraries by default to perform cryptographic functions where applicable. In this case, calls to unmanaged code will be made. In certain environments, this is not desirable. To use a completely managed security implementation, set this setting to true.

Setting this configuration setting to true tells the component to use the internal implementation instead of using the system security libraries.

On Windows, this setting is set to false by default. On Linux/macOS, this setting is set to true by default.

If using the .NET Standard Library, this setting will be true on all platforms. The .NET Standard library does not support using the system security libraries.

Note: This setting is static. The value set is applicable to all components used in the application.

When this value is set, the product's system dynamic link library (DLL) is no longer required as a reference, as all unmanaged code is stored in that file.

Trappable Errors (GoogleCalendars Component)