Google Calendar Driver

RSS

This driver is used to retrieve Google Calendar events.

Manufacturer: Google

Primary Communications Port: Network

Table of Contents [Hide/Show]

Configuration Settings
Events
   Ready State Changed
   Reminder
   Event Start
   Event Stop
Instance Properties
   CalendarEntries
   FormattedEntries
   DeviceDisplayName
   DeviceStartTime
   DeviceLifecycleStage
   DeviceIsRunningAndReady
Instance Methods
   SetPropertyForDuration ( String, TimeSpan, Object, Object )
   SetPropertyForDuration ( String, Number, TimeSpan, Object, Object )

Configuration Settings

Date Format : (optional) Simple or custom C# date format for the report format
Text Format : (optional) Format to use to display each entry in the formatted calendar report
Format Item Count : (optional) Number of next items to return for the formatted calendar report
Reload Interval : (optional) Interval in seconds to Reload Calendar
Calendar URL : URL for a Google Calendar.

This value is typically http://www.google.com/calendar/feeds/default/private/full for working with your primary calendar. To use a non-primary calendar, find the address in the Google Calendar UI by clicking the arrow next to the calendar, choosing calendar settings and copy and paste the XML URL for the 'Calendar Address' seen on the settings tab. Please replace the word public with the word private in the URL.

Username : Username for the supplied Google Calendar URL.
Password : Password for the supplied Google Calendar URL.
StartDate : (optional) Date/Time to begin including calendar entries.
EndDate : (optional) Date/Time to stop including calendar entries.

Events

Ready State Changed

The device's running and ready state changed.

Whenever Filter:

none

EventArgs:

Number NewValue : The new property value.
Number PreviousValue : The previous property value.

Reminder

Occurs when a reminder fires

Whenever Filter:

TitleRegex : (optional) Regular Expression describing which event titles reminders that this rule applies to
ContentRegex : (optional) Regular Expression describing which event content reminders that this rule applies to

EventArgs:

Object CalendarEvent : CalendarEvent that had a matching reminder

Event Start

Occurs at the start of a calendar event

Whenever Filter:

ContentRegex : (optional) Regular Expression describing which event content that this rule applies to
TitleRegex : (optional) Regular Expression describing which event titles that this rule applies to

EventArgs:

Object CalendarEvent : Matching CalendarEvent

Event Stop

Occurs at the stop of a calendar event

Whenever Filter:

TitleRegex : (optional) Regular Expression describing which event titles that this rule applies to
ContentRegex : (optional) Regular Expression describing which event content that this rule applies to

EventArgs:

Object CalendarEvent : Matching CalendarEvent

Instance Properties

CalendarEntries

Gets all Calendar entries

Accessibility : Read Only

Type: Array

FormattedEntries

Get formatted entries. Number and format controlled by other DriverSettings

Accessibility : Read Only

Type: Array

DeviceDisplayName

The display name for this device.

Accessibility : Read Only

Type: String

DeviceStartTime

The date and time when this device was started.

Accessibility : Read Only

Type: DateTime

DeviceLifecycleStage

The current lifecycle stage of the device. The stages in order are: Pending Start, Starting, Running, Stopping

Accessibility : Read Only

Type: Number

DeviceIsRunningAndReady

Indicates if the device is ready for use, ie it is in the Running lifecycle stage and all properties are valid and all methods are ready to be used.

Accessibility : Read Only

Type: Boolean

Instance Methods

SetPropertyForDuration ( String, TimeSpan, Object, Object )

Sets a property for a duration of time and then sets the property to a subequent value asynchronously. This action returns after setting the first value and the timer and subsequent property set run in the background. Subsequent sets of the same property will reset the timer if the subsequent value has not yet been set. This is an advanced feature, be sure to set the property name correctly.

Syntax

void SetPropertyForDuration( String propertyName, unknown duration, Object initialValue, Object finalValue )

Parameters

propertyName : The name of the property to set.

duration : The amount of time to wait after setting the initial value to set the subsequent value.

initialValue : The value to set the property to initially.

finalValue : The value to set the property to after the duration of time has passed.

SetPropertyForDuration ( String, Number, TimeSpan, Object, Object )

void SetPropertyForDuration( String propertyName, Number arrayIndex, unknown duration, Object initialValue, Object finalValue )

Parameters

propertyName : The name of the property to set.

arrayIndex : The property's array index to set.

duration : The amount of time to wait after setting the initial value to set the subsequent value.

initialValue : The value to set the property to initially.

finalValue : The value to set the property to after the duration of time has passed.