Joomla CMS  3.8.5 (avec JPlatform 13.1 inclus)
Documentation des API du CMS Joomla en version 3.8.5 et du framework Joomla Platform intégré
Référence de la classe JGoogleDataCalendar
+ Graphe d'héritage de JGoogleDataCalendar:

Fonctions membres publiques

 __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)
 
- Fonctions membres publiques hérités de JGoogleData
 __construct (Registry $options=null, JGoogleAuth $auth=null)
 
 authenticate ()
 
 isAuthenticated ()
 
 getOption ($key)
 
 setOption ($key, $value)
 

Membres hérités additionnels

- Fonctions membres protégées hérités de JGoogleData
 listGetData ($url, $maxpages=1, $token=null)
 
 query ($url, $data=null, $headers=null, $method='get')
 
- Fonctions membres protégées statiques hérités de JGoogleData
static safeXml ($data)
 
- Attributs protégés hérités de JGoogleData
 $options
 
 $auth
 

Description détaillée

Google Calendar data class for the Joomla Platform.

Depuis
12.3
Obsolète:
4.0 Use the joomla/google package via Composer instead

Documentation des constructeurs et destructeur

◆ __construct()

__construct ( Registry  $options = null,
JGoogleAuth  $auth = null 
)

Constructor.

Paramètres
Registry$optionsGoogle options object
JGoogleAuth$authGoogle data http client object
Depuis
12.3

Références $options.

Documentation des fonctions membres

◆ addCalendar()

addCalendar (   $calendarID,
  $options = array() 
)

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

Paramètres
string$calendarIDNew calendar ID
array$optionsNew calendar settings
Renvoie
mixed Data from Google
Depuis
12.3
Exceptions
UnexpectedValueException

Références $data, $options, $url, et json_encode.

◆ clearCalendar()

clearCalendar (   $calendarID)

Method to clear a Google Calendar

Paramètres
string$calendarIDID of calendar to clear
Renvoie
boolean Success or failure
Depuis
12.3
Exceptions
UnexpectedValueException

Références $data, et null.

◆ createCalendar()

createCalendar (   $title,
  $options = array() 
)

Method to create a Google Calendar

Paramètres
string$titleNew calendar title
array$optionsNew calendar settings
Renvoie
mixed Data from Google.
Depuis
12.3
Exceptions
UnexpectedValueException

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$calendarIDID of calendar
mixed$startEvent start time
mixed$endEvent end time
array$optionsNew event settings
mixed$timezoneTimezone for event
boolean$alldayTreat event as an all-day event
boolean$notifyNotify participants
Renvoie
mixed Data from Google.
Depuis
12.3
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$calendarIDID of calendar to delete.
Renvoie
boolean Success or failure
Depuis
12.3
Exceptions
UnexpectedValueException

Références $data, et null.

◆ deleteEvent()

deleteEvent (   $calendarID,
  $eventID 
)

Method to delete an event from a Google Calendar

Paramètres
string$calendarIDID of calendar to delete from
string$eventIDID of event to delete.
Renvoie
boolean Success or failure.
Depuis
12.3
Exceptions
UnexpectedValueException

Références $data, $url, et null.

◆ editCalendar()

editCalendar (   $calendarID,
  $options 
)

Method to edit a Google Calendar

Paramètres
string$calendarIDCalendar ID.
array$optionsCalendar settings.
Renvoie
mixed Data from Google.
Depuis
12.3
Exceptions
UnexpectedValueException

Références $data, $options, $url, et json_encode.

◆ editCalendarSettings()

editCalendarSettings (   $calendarID,
  $options 
)

Method to edit a Google Calendar's settings

Paramètres
string$calendarIDCalendar ID
array$optionsCalendar settings
Renvoie
mixed Data from Google
Depuis
12.3
Exceptions
UnexpectedValueException

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$calendarIDCalendar ID
string$eventIDID of the event to change
array$optionsEvent settings
boolean$notifyNotify participants of changes
Renvoie
mixed Data from Google.
Depuis
12.3
Exceptions
UnexpectedValueException

Références $data, $options, $url, et json_encode.

◆ getCalendar()

getCalendar (   $calendarID)

Method to get a calendar's settings from Google

Paramètres
string$calendarIDID of calendar to get.
Renvoie
mixed Data from Google
Depuis
12.3
Exceptions
UnexpectedValueException

Références $data.

◆ getEvent()

getEvent (   $calendarID,
  $eventID,
  $options = array() 
)

Method to get an event from a Google Calendar

Paramètres
string$calendarIDID of calendar
string$eventIDID of event to get
array$optionsOptions to send to Google
Renvoie
mixed Data from Google.
Depuis
12.3
Exceptions
UnexpectedValueException

Références $data, $options, et $url.

◆ listCalendars()

listCalendars (   $options = array(),
  $maxpages = 1 
)

Method to retrieve calendar list from Google

Paramètres
array$optionsSearch settings
int$maxpagesMaximum number of pages of calendars to return
Renvoie
mixed Data from Google
Depuis
12.3
Exceptions
UnexpectedValueException

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$calendarIDCalendar ID
array$optionsCalendar settings
int$maxpagesCycle through pages of data to generate a complete list
Renvoie
mixed Data from Google.
Depuis
12.3
Exceptions
UnexpectedValueException

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$calendarIDCalendar ID
string$eventIDID of the event to change
array$optionsSearch settings
int$maxpagesMinimum number of events to retrieve (more may be retrieved depending on page size)
Renvoie
mixed Data from Google.
Depuis
12.3
Exceptions
UnexpectedValueException

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$calendarIDCalendar ID
string$eventIDID of the event to change
string$destIDCalendar ID
boolean$notifyNotify participants of changes
Renvoie
mixed Data from Google.
Depuis
12.3
Exceptions
UnexpectedValueException

Références $data, $url, et null.

◆ removeCalendar()

removeCalendar (   $calendarID)

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

Paramètres
string$calendarIDID of calendar to delete
Renvoie
boolean Success or failure
Depuis
12.3
Exceptions
UnexpectedValueException

Références null.


La documentation de cette classe a été générée à partir du fichier suivant :