GCalendar Class
Properties Methods Events Configuration Settings Errors
The GCalendar component implements the Google Calendar Data API.
Syntax
ingoogle.gcalendar()
Remarks
GCalendar allows you to easily manage your calendars and events.
The component provide a simple way to list, create, and manage your calendars and events. To obtain details of all of the events associated with your calendar call ListEvents. To view the details of a specific event set EventIndex and check the desired property such as EventStartDate. For a full list of properties that are populated when EventIndex is set, see the help section for EventIndex.
The class has additional methods such as CreateCalendar, CreateEvent, DeleteCalendar, DeleteEvent, ListCalendars, UpdateCalendar and UpdateEvent to allow you to further manage your calendars and events.
Authorization
This service supports authentication via OAuth 2.0. First, perform OAuth authentication using the OAuth class or
a separate process. Once complete you should have an authorization string which looks like:
Bearer ya29.AHES6ZSZEJzATdZYjeihDn5W-VrXSsxEZu5p0pclxGdKKQAssign this value to the Authorization property before attempting any operations. Consult the Google documentation for this particular service for more information about supported scope values and more details on OAuth authentication.
Property List
The following is the full list of the properties of the class with short descriptions. Click on the links for further details.
| ACLRuleCount | The number of ACL rules for the calendar. |
| ACLRuleETag | The ETag of the current rule. |
| ACLRuleId | The Id of the ACL rule. |
| ACLRuleIndex | The index of the current ACL rule. |
| ACLRuleMarker | A marker when ACL rules are paged. |
| ACLRuleRole | The role specified for the ACL rule. |
| ACLRuleScopeType | The scope type of the rule. |
| ACLRuleScopeValue | The value for the rule scope. |
| Authorization | OAuth 2.0 Authorization Token. |
| CalendarAccessRole | The access role that the authenticated user has on the calendar. |
| CalendarCount | The number of calendars available in the account. |
| CalendarDefaultReminderCount | The number of records in the CalendarDefaultReminder arrays. |
| CalendarDefaultReminderMethod | The type of reminder. |
| CalendarDefaultReminderMinutes | The number of minutes prior to send the reminder. |
| CalendarDescription | The description of the calendar. |
| CalendarETag | The ETag of the current calendar. |
| CalendarId | The ID of the calendar. |
| CalendarIndex | The index of the current calendar. |
| CalendarLocation | The geographic location of the calendar. |
| CalendarMarker | A marker when calendars are paged. |
| CalendarOperationScope | The scope of the calendar operations. |
| CalendarPrimary | Indicates if the current calendar is the primary calendar. |
| CalendarSummary | Contains a summary of the calendar that is used to describe its purpose. |
| CalendarTimezone | Contains the time zone for the calendar. |
| CookieCount | The number of records in the Cookie arrays. |
| CookieDomain | The domain of a received cookie. |
| CookieExpiration | This property contains an expiration time for the cookie (if provided by the server). |
| CookieName | The name of the cookie. |
| CookiePath | This property contains a path name to limit the cookie to (if provided by the server). |
| CookieSecure | This property contains the security flag of the received cookie. |
| CookieValue | This property contains the value of the cookie. |
| EventAttendeeCount | The number of records in the EventAttendee arrays. |
| EventAttendeeAdditionalGuests | Number of additional guests. |
| EventAttendeeComment | A comment from the attendee. |
| EventAttendeeDisplayName | The display name of the attendee. |
| EventAttendeeEmail | The attendee's e-mail address. |
| EventAttendeeId | The attendee's profile Id. |
| EventAttendeeOptional | Whether or not the attendee is optional. |
| EventAttendeeOrganizer | Whether the attendee is the organizer. |
| EventAttendeeResource | Whether the attendee is a resource. |
| EventAttendeeStatus | The response status of the attendee. |
| EventBusy | Determines if an event is marked as busy. |
| EventCount | The number of events contained within a Google Calendar Event feed. |
| EventCreatorEmail | The email of the identity. |
| EventCreatorId | The profile Id of the identity. |
| EventCreatorName | The display name of the identity. |
| EventCustomReminderCount | The number of records in the EventCustomReminder arrays. |
| EventCustomReminderMethod | The type of reminder. |
| EventCustomReminderMinutes | The number of minutes prior to send the reminder. |
| EventDateCreated | Contains the date that an event was created. |
| EventDateUpdated | Contains the date that an event was updated. |
| EventDescription | The description of the event. |
| EventEndDate | The date of the all-day event. |
| EventEndDateTime | The DateTime of the event. |
| EventEndTimeZone | The time zone. |
| EventETag | The ETag of the current event in a Google Calendar Event feed. |
| EventICalUID | The event Id in the iCalendar format. |
| EventId | The event's Id. |
| EventIndex | The index of the current event in a Google Calendar Event feed. |
| EventLocation | Contains the location where the event is being held. |
| EventLocked | Whether the event is locked. |
| EventMarker | A marker when events are paged. |
| EventOrganizerEmail | The email of the identity. |
| EventOrganizerId | The profile Id of the identity. |
| EventOrganizerName | The display name of the identity. |
| EventOriginalStartDate | The date of the all-day event. |
| EventOriginalStartDateTime | The DateTime of the event. |
| EventOriginalStartTimeZone | The time zone. |
| EventRecurrenceDates | Individual dates on which the event will recur. |
| EventRecurrenceExceptionDates | Defines the list of DATE-TIME exceptions to the recurrence set. |
| EventRecurrenceExceptionRule | Defines a rule or repeating pattern for an exception to the recurrence set. |
| EventRecurrenceRule | This property defines the recurrence rule for the event. |
| EventRecurringId | The Id of the recurring event itself. |
| EventStartDate | The date of the all-day event. |
| EventStartDateTime | The DateTime of the event. |
| EventStartTimeZone | The time zone. |
| EventStatus | Contains the status of the event. |
| EventSummary | The summary of the event. |
| EventUseDefaultReminders | Whether default reminders are applied to this event. |
| FirewallAutoDetect | This property tells the component whether or not to automatically detect and use firewall system settings, if available. |
| FirewallType | This property determines the type of firewall to connect through. |
| FirewallHost | This property contains the name or IP address of firewall (optional). |
| FirewallPassword | This property contains a password if authentication is to be used when connecting through the firewall. |
| FirewallPort | This property contains the TCP port for the firewall Host . |
| FirewallUser | This property contains a user name if authentication is to be used connecting through a firewall. |
| Idle | The current status of the component. |
| LocalHost | The name of the local host or user-assigned IP interface through which connections are initiated or accepted. |
| OtherHeaders | Other headers as determined by the user (optional). |
| ParsedHeaderCount | The number of records in the ParsedHeader arrays. |
| ParsedHeaderField | This property contains the name of the HTTP header (same case as it is delivered). |
| ParsedHeaderValue | This property contains the header contents. |
| ProxyAuthScheme | This property is used to tell the component which type of authorization to perform when connecting to the proxy. |
| ProxyAutoDetect | This property tells the component whether or not to automatically detect and use proxy system settings, if available. |
| ProxyPassword | This property contains a password if authentication is to be used for the proxy. |
| ProxyPort | This property contains the TCP port for the proxy Server (default 80). |
| ProxyServer | If a proxy Server is given, then the HTTP request is sent to the proxy instead of the server otherwise specified. |
| ProxySSL | This property determines when to use SSL for the connection to the proxy. |
| ProxyUser | This property contains a user name, if authentication is to be used for the proxy. |
| QueryParamsCount | The number of records in the QueryParams arrays. |
| QueryParamsName | This property contains the name of the parameter to be used in a Query request. |
| QueryParamsValue | This property contains the value of the parameter to be used in a Query request. |
| SSLAcceptServerCertEncoded | The certificate (PEM/base64 encoded). |
| SSLCertEncoded | The certificate (PEM/base64 encoded). |
| SSLCertStore | The name of the certificate store for the client certificate. |
| SSLCertStorePassword | 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. |
| SSLCertStoreType | The type of certificate store for this certificate. |
| SSLCertSubject | The subject of the certificate used for client authentication. |
| SSLServerCertEncoded | The certificate (PEM/base64 encoded). |
| Timeout | A timeout for the component. |
| XChildrenCount | The number of records in the XChild arrays. |
| XChildName | The Name property provides the local name of the element. |
| XChildXText | This property contains the inner text of the 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 response. |
| XSubTree | A snapshot of the current element in the document. |
| XText | The text of the current element. |
Method List
The following is the full list of the methods of the class with short descriptions. Click on the links for further details.
| AddQueryParam | Adds a query parameter to the QueryParams properties. |
| ClearCalendar | Clears all data associated with the primary calendar. |
| Config | Sets or retrieves a configuration setting . |
| CreateACLRule | Creates a new ACL rule for the calendar. |
| CreateCalendar | Create a new calendar. |
| CreateEvent | Creates a new event. |
| DeleteACLRule | Deletes an ACL rule. |
| DeleteCalendar | Deletes the specified calendar. |
| DeleteEvent | Deletes the specified event. |
| GetACLRule | Gets the specified ACL rule. |
| GetCalendar | Retrieves information about the specified calendar. |
| GetEvent | Retrieves the event. |
| ImportEvent | Imports an event. |
| ListACLRules | Lists the ACL rules for the calendar. |
| ListCalendars | Lists all calendars. |
| ListEvents | Lists events. |
| ListRecurringEventInstances | Lists the instances of a recurring event. |
| MoveEvent | Move the event to a different calendar. |
| QuickAdd | Creates a new event in the specified calendar. |
| UpdateACLRule | Updates an ACL rule. |
| UpdateCalendar | Updates the specified calendar. |
| UpdateEvent | Updates an event. |
Event List
The following is the full list of the events fired by the class with short descriptions. Click on the links for further details.
| ACLRuleList | Fires for each ACL rule when ListACLRules is called. |
| CalendarList | Fires for each calendar when ListCalendars is called. |
| Connected | Fired immediately after a connection completes (or fails). |
| Disconnected | Fired when a connection is closed. |
| EndTransfer | Fired when a document finishes transferring. |
| Error | Information about errors during data delivery. |
| EventList | Fires for each calendar event when ListEvents is called. |
| Header | Fired every time a header line comes in. |
| SetCookie | Fired for every cookie set by the server. |
| SSLServerAuthentication | Fired after the server presents its certificate to the client. |
| SSLStatus | Shows the progress of the secure connection. |
| StartTransfer | Fired when a document starts transferring (after the headers). |
| Status | Fired when the HTTP status line is received from the server. |
| Transfer | Fired while a document transfers (delivers document). |
Configuration Settings
The following is a list of configuration settings for the class with short descriptions. Click on the links for further details.
| CalendarSummaryOverride | Overrides the calendar summary. |
| EventColorId | Specifies the Id of the color for the event. |
| EventEndTimeSpecified | Whether the end time is actually specified. |
| EventVisibility | The visibility of the event. |
| FeedURL | Specifies the URL where the request is sent. |
| MaxResults | Limits the number of results. |
| ReturnRawString | Whether the raw string will be returned. |
| AcceptEncoding | Used to tell the server which types of content encodings the client supports. |
| AllowHTTPCompression | This property enables HTTP compression for receiving data. |
| AllowIdenticalRedirectURL | Allow redirects to the same URL. |
| 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. |
| 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. |
| 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. |
| MaxRedirectAttempts | Limits the number of redirects that are followed in a request. |
| 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. |
| TransferredDataLimit | The maximum number of incoming bytes to be stored by the component. |
| TransferredHeaders | The full set of headers as received from the server. |
| UseChunkedEncoding | Enables or Disables HTTP chunked encoding for transfers. |
| ChunkSize | Specifies the chunk size in bytes when using chunked encoding. |
| UserAgent | Information about the user agent (browser). |
| KerberosSPN | The Service Principal Name for the Kerberos Domain Controller. |
| 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). |
| 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. |
| KeepAliveTime | The inactivity time in milliseconds before a TCP keep-alive packet is sent. |
| KeepAliveInterval | The retry interval, in milliseconds, to be used when a TCP keep-alive packet is sent and no response is received. |
| 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 TCP 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. |
| RecordLength | The length of received data records. |
| TCPKeepAlive | Determines whether or not the keep alive socket option is enabled. |
| UseIPv6 | Whether to use IPv6. |
| TcpNoDelay | Whether or not to delay when sending packets. |
| ReuseSSLSession | Determines if the SSL session is reused. |
| SSLCipherStrength | The minimum cipher strength used for bulk encryption. |
| SSLEnabledProtocols | Used to enable/disable the supported security protocols. |
| SSLProvider | The name of the security provider to use. |
| SSLSecurityFlags | Flags that control certificate verification. |
| OpenSSLCADir | The path to a directory containing CA certificates. |
| OpenSSLCAFile | Name of the file containing the list of CA's trusted by your application. |
| OpenSSLCipherList | A string that controls the ciphers to be used by SSL. |
| OpenSSLPrngSeedData | The data to seed the pseudo random number generator (PRNG). |
| 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. |
| CodePage | The system code page used for Unicode to Multibyte translations. |