Class JGoogleDataCalendar

Google Calendar data class for the Joomla Platform.

JGoogleData

JGoogleDataCalendar

Package: Joomla\Platform\Google
Deprecated: 4.0 Use the joomla/google package via Composer instead
Copyright: Copyright (C) 2005 - 2017 Open Source Matters, Inc. All rights reserved
License: General Public License version 2 or later; see LICENSE
Since: 12.3
Located at joomla/google/data/calendar.php

Methods summary

`public`	# `__construct( Joomla\Registry\Registry $options = null, JGoogleAuth $auth = null )` Constructor. Constructor. Parameters `$options` `Joomla\Registry\Registry` - $options Google options object `$auth` `JGoogleAuth` - $auth Google data http client object Since 12.3 Overrides `JGoogleData::__construct`
`public boolean`	# `removeCalendar( string $calendarID )` Method to remove a calendar from a user's calendar list Method to remove a calendar from a user's calendar list Parameters `$calendarID` `string` - $calendarID ID of calendar to delete Returns `boolean` - Success or failure Throws `UnexpectedValueException` Since 12.3
`public mixed`	# `getCalendar( string $calendarID )` Method to get a calendar's settings from Google Method to get a calendar's settings from Google Parameters `$calendarID` `string` - $calendarID ID of calendar to get. Returns `mixed` - Data from Google Throws `UnexpectedValueException` Since 12.3
`public mixed`	# `addCalendar( string $calendarID, array $options = array() )` Method to add a calendar to a user's Google Calendar list Method to add a calendar to a user's Google Calendar list Parameters `$calendarID` `string` - $calendarID New calendar ID `$options` `array` - $options New calendar settings Returns `mixed` - Data from Google Throws `UnexpectedValueException` Since 12.3
`public mixed`	# `listCalendars( array $options = array(), integer $maxpages = 1 )` Method to retrieve calendar list from Google Method to retrieve calendar list from Google Parameters `$options` `array` - $options Search settings `$maxpages` `integer` - $maxpages Maximum number of pages of calendars to return Returns `mixed` - Data from Google Throws `UnexpectedValueException` Since 12.3
`public mixed`	# `editCalendarSettings( string $calendarID, array $options )` Method to edit a Google Calendar's settings Method to edit a Google Calendar's settings Parameters `$calendarID` `string` - $calendarID Calendar ID `$options` `array` - $options Calendar settings Returns `mixed` - Data from Google Throws `UnexpectedValueException` Since 12.3
`public boolean`	# `clearCalendar( string $calendarID )` Method to clear a Google Calendar Method to clear a Google Calendar Parameters `$calendarID` `string` - $calendarID ID of calendar to clear Returns `boolean` - Success or failure Throws `UnexpectedValueException` Since 12.3
`public boolean`	# `deleteCalendar( string $calendarID )` Method to delete a calendar from Google Method to delete a calendar from Google Parameters `$calendarID` `string` - $calendarID ID of calendar to delete. Returns `boolean` - Success or failure Throws `UnexpectedValueException` Since 12.3
`public mixed`	# `createCalendar( string $title, array $options = array() )` Method to create a Google Calendar Method to create a Google Calendar Parameters `$title` `string` - $title New calendar title `$options` `array` - $options New calendar settings Returns `mixed` - Data from Google. Throws `UnexpectedValueException` Since 12.3
`public mixed`	# `editCalendar( string $calendarID, array $options )` Method to edit a Google Calendar Method to edit a Google Calendar Parameters `$calendarID` `string` - $calendarID Calendar ID. `$options` `array` - $options Calendar settings. Returns `mixed` - Data from Google. Throws `UnexpectedValueException` Since 12.3
`public boolean`	# `deleteEvent( string $calendarID, string $eventID )` Method to delete an event from a Google Calendar Method to delete an event from a Google Calendar Parameters `$calendarID` `string` - $calendarID ID of calendar to delete from `$eventID` `string` - $eventID ID of event to delete. Returns `boolean` - Success or failure. Throws `UnexpectedValueException` Since 12.3
`public mixed`	# `getEvent( string $calendarID, string $eventID, array $options = array() )` Method to get an event from a Google Calendar Method to get an event from a Google Calendar Parameters `$calendarID` `string` - $calendarID ID of calendar `$eventID` `string` - $eventID ID of event to get `$options` `array` - $options Options to send to Google Returns `mixed` - Data from Google. Throws `UnexpectedValueException` Since 12.3
`public mixed`	# `createEvent( string $calendarID, mixed $start, mixed $end = false, array $options = array(), mixed $timezone = false, boolean $allday = false, boolean $notify = false )` Method to create a Google Calendar event Method to create a Google Calendar event Parameters `$calendarID` `string` - $calendarID ID of calendar `$start` `mixed` - $start Event start time `$end` `mixed` - $end Event end time `$options` `array` - $options New event settings `$timezone` `mixed` - $timezone Timezone for event `$allday` `boolean` - $allday Treat event as an all-day event `$notify` `boolean` - $notify Notify participants Returns `mixed` - Data from Google. Throws `InvalidArgumentException` `UnexpectedValueException` Since 12.3
`public mixed`	# `listRecurrences( string $calendarID, string $eventID, array $options = array(), integer $maxpages = 1 )` Method to retrieve a list of events on a Google calendar Method to retrieve a list of events on a Google calendar Parameters `$calendarID` `string` - $calendarID Calendar ID `$eventID` `string` - $eventID ID of the event to change `$options` `array` - $options Search settings `$maxpages` `integer` - $maxpages Minimum number of events to retrieve (more may be retrieved depending on page size) Returns `mixed` - Data from Google. Throws `UnexpectedValueException` Since 12.3
`public mixed`	# `listEvents( string $calendarID, array $options = array(), integer $maxpages = 1 )` Method to retrieve a list of events on a Google calendar Method to retrieve a list of events on a Google calendar Parameters `$calendarID` `string` - $calendarID Calendar ID `$options` `array` - $options Calendar settings `$maxpages` `integer` - $maxpages Cycle through pages of data to generate a complete list Returns `mixed` - Data from Google. Throws `UnexpectedValueException` Since 12.3
`public mixed`	# `moveEvent( string $calendarID, string $eventID, string $destID, boolean $notify = false )` Method to move an event from one calendar to another Method to move an event from one calendar to another Parameters `$calendarID` `string` - $calendarID Calendar ID `$eventID` `string` - $eventID ID of the event to change `$destID` `string` - $destID Calendar ID `$notify` `boolean` - $notify Notify participants of changes Returns `mixed` - Data from Google. Throws `UnexpectedValueException` Since 12.3
`public mixed`	# `editEvent( string $calendarID, string $eventID, array $options, boolean $notify = false )` Method to edit a Google Calendar event Method to edit a Google Calendar event Parameters `$calendarID` `string` - $calendarID Calendar ID `$eventID` `string` - $eventID ID of the event to change `$options` `array` - $options Event settings `$notify` `boolean` - $notify Notify participants of changes Returns `mixed` - Data from Google. Throws `UnexpectedValueException` Since 12.3

Methods inherited from JGoogleData

authenticate(), getOption(), isAuthenticated(), listGetData(), query(), safeXml(), setOption()

Magic methods summary

Properties summary

Properties inherited from JGoogleData

$auth, $options

Namespaces

Classes

Interfaces

Exceptions

Constants

Functions

Class JGoogleDataCalendar

Methods summary

Parameters

Since

Overrides

Parameters

Returns

Throws

Since

Parameters

Returns

Throws

Since

Parameters

Returns

Throws

Since

Parameters

Returns

Throws

Since

Parameters

Returns

Throws

Since

Parameters

Returns

Throws

Since

Parameters

Returns

Throws

Since

Parameters

Returns

Throws

Since

Parameters

Returns

Throws

Since

Parameters

Returns

Throws

Since

Parameters

Returns

Throws

Since

Parameters

Returns

Throws

Since

Parameters

Returns

Throws

Since

Parameters

Returns

Throws

Since

Parameters

Returns

Throws

Since

Parameters

Returns

Throws

Since

Methods inherited from JGoogleData

Magic methods summary

Properties summary

Properties inherited from JGoogleData