Plugin GgCal

Go to the main Plugins page.

Go to the complete Plugin List.

Plugin Description

Access data on your Google Calendar(s). You can create calendar events, get a list of events, and automatically trigger timed events in VoxCommando that correspond to your calendar events. A number of things need to be set in the GgCal plugin settings for these actions to work.

Actions for the GgCal plugin

GetToday

GgCal.GetToday
Gets events for the rest of today (after current time). Events will be returned as matches that can be accessed using {Match.1} {Match.2} etc.
<Feed> (a calendar name) is case sensitive. Feed names can be seen in plugin settings. Will use default feed if none is specified. Default feed is specified in the GgCal plugin settings.

• Parameters: 0-1

1. Feed : Which calendar to get events for [string]

GetDay

GgCal.GetDay
Gets Calendar events for <Day> (0 for today, 1 for tomorrow) from the calendar named <Feed>
Events will be returned as matches that can be accessed using {Match.1} {Match.2} etc.
<Feed> (a calendar name) is case sensitive. Feed names can be seen in plugin settings. Will use default feed if none is specified. Default feed is specified in the GgCal plugin settings.

• Parameters: 1-2

1. Day : -1 yesterday, 0 today, 1 tomorrow [integer]
2. Feed : Which calendar to get events for [string]

QuickAdd

GgCal.QuickAdd
Sends the <QuickString> to calendar <Feed>. What happens next is up to google. An example string that works in English is:
-Dinner with Joe tomorrow at 18:30 in Montreal.
-Visit Grandma on Friday
If <Feed> is ommited it will use the default Feed as defined in GgCal plugin settings.

• Parameters: 1-2

1. QuickString : [string]
2. Feed : Which calendar to create the events in [string]

SetFeed

GgCal.SetFeed
Temporarily sets the default feed to a new one, but does not save it in options. This Feed will be used as the default Feed until VoxCommando is restarted.

• Parameters: 1

1. Feed : new default Feed Name [string]

GetRange

GgCal.GetRange
Gets calendar events from a range of days. Example to get events from yesterday, today, and tomorrow use StartOffset = -1 and EndOffset = 1
<Feed> (a calendar name) is case sensitive. Feed names can be seen in plugin settings. Will use default feed if none is specified. Default feed is specified in the GgCal plugin settings.
Events will be returned as matches that can be accessed using {Match.1} {Match.2} etc.

• Parameters: 2-3

1. StartOffset : 0 = today, 1 = tomorrow [integer]
2. EndOffset : 0 = today, 1 = tomorrow [integer]
3. Feed : Which calendar to get events for [string]

AddEvent

GgCal.AddEvent
Adds a new calendar event to the specified <Feed> according to the parameters specified.

• Parameters: 1-5

1. Title : Title of new event [string]
2. Date : Start Date of New event [string]
3. Time : Start Time of New Event [string]
4. Feed : Name of Calendar [string]
5. Location : Location of Event [string]

SetTimers

GgCal.SetTimers
Scans your feed(s) for upcoming scheduled items over the next 7 days, and creates event timers that will trigger VoxCommando events at the appropriate time. Set event scanning & generation options in the GgCal plugin settings.

The event name will take the form, ggCal.Event.<Name of calendar feed>. You can use this to trigger specific commands. Events will carry payloads that provide information about the calendar entry: {1} entry title, {2} calendar feed name, {3} description, {4} date/start time, {5} date/end time, {6} location.

Existing event timers will be cleared, and replaced.

• Parameters: 0+

1. Feed : Calendar feed name to scan [string]
2. Feed : Calendar feed name to scan [string]
3. Feed : Calendar feed name to scan [string]