Docs For Class JGoogleDataCalendar

JGoogleDataCalendar

Description

Google Calendar data class for the Joomla Platform.

since: 12.3

Located in /libraries/joomla/google/data/calendar.php (line 19)

JGoogleData
   |
   --JGoogleDataCalendar

Method Summary

JGoogleDataCalendar __construct ([JRegistry $options = null], [JGoogleAuth $auth = null])

mixed addCalendar (string $calendarID, [array $options = array()])

boolean clearCalendar (string $calendarID)

mixed createCalendar (string $title, [array $options = array()])

mixed createEvent (string $calendarID, mixed $start, [mixed $end = false], [array $options = array()], [mixed $timezone = false], [boolean $allday = false], [boolean $notify = false])

boolean deleteCalendar (string $calendarID)

boolean deleteEvent (string $calendarID, string $eventID)

mixed editCalendar (string $calendarID, array $options)

mixed editCalendarSettings (string $calendarID, array $options)

mixed editEvent (string $calendarID, string $eventID, array $options, [boolean $notify = false])

mixed getCalendar (string $calendarID)

mixed getEvent (string $calendarID, string $eventID, [array $options = array()])

mixed listCalendars ([array $options = array()], [int $maxpages = 1])

mixed listEvents (string $calendarID, [array $options = array()], [int $maxpages = 1])

mixed listRecurrences (string $calendarID, string $eventID, [array $options = array()], [int $maxpages = 1])

mixed moveEvent (string $calendarID, string $eventID, string $destID, [boolean $notify = false])

boolean removeCalendar (string $calendarID)

Variables

Inherited Variables

Inherited from JGoogleData

JGoogleData::$auth
JGoogleData::$options

Methods

Constructor __construct (line 29)

Constructor.

since: 12.3
access: public

JGoogleDataCalendar __construct ([JRegistry $options = null], [JGoogleAuth $auth = null])

JRegistry $options: Google options object
JGoogleAuth $auth: Google data http client object

Redefinition of:

JGoogleData::__construct(): Constructor.

addCalendar (line 109)

Method to add a calendar to a user's Google Calendar list

return: Data from Google
since: 12.3
throws: UnexpectedValueException
access: public

mixed addCalendar (string $calendarID, [array $options = array()])

string $calendarID: New calendar ID
array $options: New calendar settings

clearCalendar (line 202)

Method to clear a Google Calendar

return: Success or failure
since: 12.3
throws: UnexpectedValueException
access: public

boolean clearCalendar (string $calendarID)

string $calendarID: ID of calendar to clear

createCalendar (line 259)

Method to create a Google Calendar

return: Data from Google.
since: 12.3
throws: UnexpectedValueException
access: public

mixed createCalendar (string $title, [array $options = array()])

string $title: New calendar title
array $options: New calendar settings

createEvent (line 398)

Method to create a Google Calendar event

return: Data from Google.
throws: InvalidArgumentException
throws: UnexpectedValueException
since: 12.3
access: public

mixed createEvent (string $calendarID, mixed $start, [mixed $end = false], [array $options = array()], [mixed $timezone = false], [boolean $allday = false], [boolean $notify = false])

string $calendarID: ID of calendar
mixed $start: Event start time
mixed $end: Event end time
array $options: New event settings
mixed $timezone: Timezone for event
boolean $allday: Treat event as an all-day event
boolean $notify: Notify participants

deleteCalendar (line 230)

Method to delete a calendar from Google

return: Success or failure
since: 12.3
throws: UnexpectedValueException
access: public

boolean deleteCalendar (string $calendarID)

string $calendarID: ID of calendar to delete.

deleteEvent (line 327)

Method to delete an event from a Google Calendar

return: Success or failure.
since: 12.3
throws: UnexpectedValueException
access: public

boolean deleteEvent (string $calendarID, string $eventID)

string $calendarID: ID of calendar to delete from
string $eventID: ID of event to delete.

editCalendar (line 293)

Method to edit a Google Calendar

return: Data from Google.
since: 12.3
throws: UnexpectedValueException
access: public

mixed editCalendar (string $calendarID, array $options)

string $calendarID: Calendar ID.
array $options: Calendar settings.

editCalendarSettings (line 170)

Method to edit a Google Calendar's settings

return: Data from Google
since: 12.3
throws: UnexpectedValueException
access: public

mixed editCalendarSettings (string $calendarID, array $options)

string $calendarID: Calendar ID
array $options: Calendar settings

editEvent (line 598)

Method to edit a Google Calendar event

return: Data from Google.
since: 12.3
throws: UnexpectedValueException
access: public

mixed editEvent (string $calendarID, string $eventID, array $options, [boolean $notify = false])

string $calendarID: Calendar ID
string $eventID: ID of the event to change
array $options: Event settings
boolean $notify: Notify participants of changes

getCalendar (line 77)

Method to get a calendar's settings from Google

return: Data from Google
since: 12.3
throws: UnexpectedValueException
access: public

mixed getCalendar (string $calendarID)

string $calendarID: ID of calendar to get.

getEvent (line 358)

Method to get an event from a Google Calendar

return: Data from Google.
since: 12.3
throws: UnexpectedValueException
access: public

mixed getEvent (string $calendarID, string $eventID, [array $options = array()])

string $calendarID: ID of calendar
string $eventID: ID of event to get
array $options: Options to send to Google

listCalendars (line 143)

Method to retrieve calendar list from Google

return: Data from Google
since: 12.3
throws: UnexpectedValueException
access: public

mixed listCalendars ([array $options = array()], [int $maxpages = 1])

array $options: Search settings
int $maxpages: Maximum number of pages of calendars to return

listEvents (line 533)

Method to retrieve a list of events on a Google calendar

return: Data from Google.
since: 12.3
throws: UnexpectedValueException
access: public

mixed listEvents (string $calendarID, [array $options = array()], [int $maxpages = 1])

string $calendarID: Calendar ID
array $options: Calendar settings
int $maxpages: Cycle through pages of data to generate a complete list

listRecurrences (line 504)

Method to retrieve a list of events on a Google calendar

return: Data from Google.
since: 12.3
throws: UnexpectedValueException
access: public

mixed listRecurrences (string $calendarID, string $eventID, [array $options = array()], [int $maxpages = 1])

string $calendarID: Calendar ID
string $eventID: ID of the event to change
array $options: Search settings
int $maxpages: Minimum number of events to retrieve (more may be retrieved depending on page size)

moveEvent (line 562)

Method to move an event from one calendar to another

return: Data from Google.
since: 12.3
throws: UnexpectedValueException
access: public

mixed moveEvent (string $calendarID, string $eventID, string $destID, [boolean $notify = false])

string $calendarID: Calendar ID
string $eventID: ID of the event to change
string $destID: Calendar ID
boolean $notify: Notify participants of changes

removeCalendar (line 49)

Method to remove a calendar from a user's calendar list

return: Success or failure
since: 12.3
throws: UnexpectedValueException
access: public

boolean removeCalendar (string $calendarID)

string $calendarID: ID of calendar to delete

Inherited Methods

Inherited From JGoogleData

JGoogleData::__construct()
JGoogleData::authenticate()
JGoogleData::getOption()
JGoogleData::isAuthenticated()
JGoogleData::listGetData()
JGoogleData::query()
JGoogleData::safeXML()
JGoogleData::setOption()

Documentation generated on Tue, 19 Nov 2013 14:54:57 +0100 by phpDocumentor 1.4.3