|
| __construct (Registry $options=null, JGoogleAuth $auth=null) |
|
| removeCalendar ($calendarID) |
|
| getCalendar ($calendarID) |
|
| addCalendar ($calendarID, $options=array()) |
|
| listCalendars ($options=array(), $maxpages=1) |
|
| editCalendarSettings ($calendarID, $options) |
|
| clearCalendar ($calendarID) |
|
| deleteCalendar ($calendarID) |
|
| createCalendar ($title, $options=array()) |
|
| editCalendar ($calendarID, $options) |
|
| deleteEvent ($calendarID, $eventID) |
|
| getEvent ($calendarID, $eventID, $options=array()) |
|
| createEvent ($calendarID, $start, $end=false, $options=array(), $timezone=false, $allday=false, $notify=false) |
|
| listRecurrences ($calendarID, $eventID, $options=array(), $maxpages=1) |
|
| listEvents ($calendarID, $options=array(), $maxpages=1) |
|
| moveEvent ($calendarID, $eventID, $destID, $notify=false) |
|
| editEvent ($calendarID, $eventID, $options, $notify=false) |
|
| __construct (Registry $options=null, JGoogleAuth $auth=null) |
|
| authenticate () |
|
| isAuthenticated () |
|
| getOption ($key) |
|
| setOption ($key, $value) |
|
Google Calendar data class for the Joomla Platform.
- Depuis
- 3.1.4
- Obsolète:
- 4.0 Use the
joomla/google
package via Composer instead
◆ __construct()
Constructor.
- Paramètres
-
Registry | $options | Google options object |
JGoogleAuth | $auth | Google data http client object |
- Depuis
- 3.1.4
Références $options.
◆ addCalendar()
addCalendar |
( |
|
$calendarID, |
|
|
|
$options = array() |
|
) |
| |
Method to add a calendar to a user's Google Calendar list
- Paramètres
-
string | $calendarID | New calendar ID |
array | $options | New calendar settings |
- Renvoie
- mixed Data from Google
- Depuis
- 3.1.4
- Exceptions
-
Références $data, $options, $url, et json_encode.
◆ clearCalendar()
clearCalendar |
( |
|
$calendarID | ) |
|
Method to clear a Google Calendar
- Paramètres
-
string | $calendarID | ID of calendar to clear |
- Renvoie
- boolean Success or failure
- Depuis
- 3.1.4
- Exceptions
-
Références $data, et null.
◆ createCalendar()
createCalendar |
( |
|
$title, |
|
|
|
$options = array() |
|
) |
| |
Method to create a Google Calendar
- Paramètres
-
string | $title | New calendar title |
array | $options | New calendar settings |
- Renvoie
- mixed Data from Google.
- Depuis
- 3.1.4
- Exceptions
-
Références $data, $options, $title, $url, et json_encode.
◆ createEvent()
createEvent |
( |
|
$calendarID, |
|
|
|
$start, |
|
|
|
$end = false , |
|
|
|
$options = array() , |
|
|
|
$timezone = false , |
|
|
|
$allday = false , |
|
|
|
$notify = false |
|
) |
| |
Method to create a Google Calendar event
- Paramètres
-
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 |
- Renvoie
- mixed Data from Google.
- Depuis
- 3.1.4
- Exceptions
-
InvalidArgumentException | |
UnexpectedValueException | |
Références $data, $options, $start, $url, elseif, et json_encode.
◆ deleteCalendar()
deleteCalendar |
( |
|
$calendarID | ) |
|
Method to delete a calendar from Google
- Paramètres
-
string | $calendarID | ID of calendar to delete. |
- Renvoie
- boolean Success or failure
- Depuis
- 3.1.4
- Exceptions
-
Références $data, et null.
◆ deleteEvent()
deleteEvent |
( |
|
$calendarID, |
|
|
|
$eventID |
|
) |
| |
Method to delete an event from a Google Calendar
- Paramètres
-
string | $calendarID | ID of calendar to delete from |
string | $eventID | ID of event to delete. |
- Renvoie
- boolean Success or failure.
- Depuis
- 3.1.4
- Exceptions
-
Références $data, $url, et null.
◆ editCalendar()
editCalendar |
( |
|
$calendarID, |
|
|
|
$options |
|
) |
| |
Method to edit a Google Calendar
- Paramètres
-
string | $calendarID | Calendar ID. |
array | $options | Calendar settings. |
- Renvoie
- mixed Data from Google.
- Depuis
- 3.1.4
- Exceptions
-
Références $data, $options, $url, et json_encode.
◆ editCalendarSettings()
editCalendarSettings |
( |
|
$calendarID, |
|
|
|
$options |
|
) |
| |
Method to edit a Google Calendar's settings
- Paramètres
-
string | $calendarID | Calendar ID |
array | $options | Calendar settings |
- Renvoie
- mixed Data from Google
- Depuis
- 3.1.4
- Exceptions
-
Références $data, $options, $url, et json_encode.
◆ editEvent()
editEvent |
( |
|
$calendarID, |
|
|
|
$eventID, |
|
|
|
$options, |
|
|
|
$notify = false |
|
) |
| |
Method to edit a Google Calendar event
- Paramètres
-
string | $calendarID | Calendar ID |
string | $eventID | ID of the event to change |
array | $options | Event settings |
boolean | $notify | Notify participants of changes |
- Renvoie
- mixed Data from Google.
- Depuis
- 3.1.4
- Exceptions
-
Références $data, $options, $url, et json_encode.
◆ getCalendar()
getCalendar |
( |
|
$calendarID | ) |
|
Method to get a calendar's settings from Google
- Paramètres
-
string | $calendarID | ID of calendar to get. |
- Renvoie
- mixed Data from Google
- Depuis
- 3.1.4
- Exceptions
-
Références $data.
◆ getEvent()
getEvent |
( |
|
$calendarID, |
|
|
|
$eventID, |
|
|
|
$options = array() |
|
) |
| |
Method to get an event from a Google Calendar
- Paramètres
-
string | $calendarID | ID of calendar |
string | $eventID | ID of event to get |
array | $options | Options to send to Google |
- Renvoie
- mixed Data from Google.
- Depuis
- 3.1.4
- Exceptions
-
Références $data, $options, et $url.
◆ listCalendars()
listCalendars |
( |
|
$options = array() , |
|
|
|
$maxpages = 1 |
|
) |
| |
Method to retrieve calendar list from Google
- Paramètres
-
array | $options | Search settings |
int | $maxpages | Maximum number of pages of calendars to return |
- Renvoie
- mixed Data from Google
- Depuis
- 3.1.4
- Exceptions
-
Références $options, $url, et null.
◆ listEvents()
listEvents |
( |
|
$calendarID, |
|
|
|
$options = array() , |
|
|
|
$maxpages = 1 |
|
) |
| |
Method to retrieve a list of events on a Google calendar
- Paramètres
-
string | $calendarID | Calendar ID |
array | $options | Calendar settings |
int | $maxpages | Cycle through pages of data to generate a complete list |
- Renvoie
- mixed Data from Google.
- Depuis
- 3.1.4
- Exceptions
-
Références $options, $url, et null.
◆ listRecurrences()
listRecurrences |
( |
|
$calendarID, |
|
|
|
$eventID, |
|
|
|
$options = array() , |
|
|
|
$maxpages = 1 |
|
) |
| |
Method to retrieve a list of events on a Google calendar
- Paramètres
-
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) |
- Renvoie
- mixed Data from Google.
- Depuis
- 3.1.4
- Exceptions
-
Références $options, $url, et null.
◆ moveEvent()
moveEvent |
( |
|
$calendarID, |
|
|
|
$eventID, |
|
|
|
$destID, |
|
|
|
$notify = false |
|
) |
| |
Method to move an event from one calendar to another
- Paramètres
-
string | $calendarID | Calendar ID |
string | $eventID | ID of the event to change |
string | $destID | Calendar ID |
boolean | $notify | Notify participants of changes |
- Renvoie
- mixed Data from Google.
- Depuis
- 3.1.4
- Exceptions
-
Références $data, $url, et null.
◆ removeCalendar()
removeCalendar |
( |
|
$calendarID | ) |
|
Method to remove a calendar from a user's calendar list
- Paramètres
-
string | $calendarID | ID of calendar to delete |
- Renvoie
- boolean Success or failure
- Depuis
- 3.1.4
- Exceptions
-
Références null.
La documentation de cette classe a été générée à partir du fichier suivant :