jquery-unison's Introduction

jquery-unison

JQuery Plugin that aggregates multiple Google Calendars in javascript using the GData library

##input:#

@param /*{Object}*/ options
{
  calendars: /*Array of Calendar Objects*/,
  eventParser: /*Function - callback function that preforms custom logic on events returned by the GData api*/
}

##functions:#

getEventsOnDate - Retrieves all the events on the specific date, and passes that data to the callback in an EventsContainer

@param /*{Object}*/ options
{
  date: /*Date*/,
  timezone: /*Int - timezone offset, 0 = utc (utc offset eg. -7, +3)*/
  
  keys: /*Array of Strings - Optional list of calendars to retrieve events from*/
}
@param *{Function}* callback(**EventsContainer**, **ErrorContainer**)

getEventsInMonth

@param /*{Object}*/ options
{
  date: /*Date*/,
  timezone: /*Int - timezone offset, 0 = utc (utc offset eg. -7, +3)*/ 
  
  keys: /*Array of Strings - Optional list of calendars to retrieve events from*/
}
@param *{Function}* callback(**EventsContainer**, **ErrorContainer**)

getEventsInRange

@param /*{Object}*/ options
{
  startDate: /*Date*/,
  endDate: /*Date*/,
  timezone: /*Int - timezone offset, 0 = utc (utc offset eg. -7, +3)*/ 
  
  keys: /*Array of Strings - Optional list of calendars to retrieve events from*/
}
@param *{Function}* callback(**EventsContainer**, **ErrorContainer**)

###containers:### Calendar:

{
  key:/*String - calendarKey*/, 
  id:/*String - Google Calendar ID*/
}

EventsContainer:

{
  key: /*String - calendarKey*/,
  events:/*Array of Event Objects*/
  
  flatten:/*Function - returns a sorted array of events contained within the container. (ordered by start date, title)*/
}

Event: https://developers.google.com/google-apps/calendar/v3/reference/events#resource

##features:#