GglListCalendar (Function)

WINDEV, WEBDEV AND WINDEV MOBILE
ONLINE HELP

Version:

Home | Sign in | English

Special cases
Possible error cases:
Limit

WINDEV

WEBDEV

WINDEV Mobile

Others

See also

GglListCalendar (Function)

In french: GglListeAgenda

Retrieves the list of Google calendars associated with the specified Google account. This function is using the Google Calendar service.

Caution: the access to the Google Calendars changes from November 17, 2014

From November 17 2014, Google is only using the Google API version 3 (Google API version 2 is abandoned). This change of version has modified the exchange format of data used by the functions for accessing the Google Calendars.

An "OAuth 2.0" authentication is now required to access this service. This authentication mode requires:

the declaration of the application in the Google console. To use the Google Calendars, the application must use the "Calendar API" service.
the use of new properties in the gglConnection variable.

See the help about GglConnect for more details.

Caution: The gglCalendar, gglEvent and gglLocation variables are also modified. Some properties become obsolete with the Google API version 3: they must not be specified anymore.

Example

See additional examples

// Connection
Cnt is gglConnection
...
IF GglConnect(Cnt) = False THEN
Error(ErrorInfo())
RETURN
END
arrCalendars is array of gglCalendar
arrCalendars = GglListCalendar(Cnt, gglAll)
// Display the title of each calendar
Calendar is gglCalendar
FOR EACH Calendar OF arrCalendars
Trace(Calendar..Title)
END

Syntax

<Result> = GglListCalendar(<Google connection> [, <Filter>])

<Result>: Array of gglCalendar variables

List of Google calendars for the specified account.

<Google connection>: gglConnection variable

Name of the gglConnection variable to use. This connection was validated by GglConnect.
Versions 20 and later
Caution: the properties of the gglConnection variable must be revised for the OAuth 2.0 authentication.
New in version 20
Caution: the properties of the gglConnection variable must be revised for the OAuth 2.0 authentication.
Caution: the properties of the gglConnection variable must be revised for the OAuth 2.0 authentication.

<Filter>: Optional Integer constant

Indicates the type of calendar to list:
gglAll
(Default value) Lists all the calendars subscribed (shared) and created by the current user.
gglUser Lists the calendars created by the current user.

Remarks

Special cases

The returned calendars contain no event. To retrieve the events from the calendars, use GglFillCalendar or GglFillCalendarByRequest.

To retrieve the calendar with the associated events, use GglGetCalendar.

Possible error cases:

The Internet connection is not valid.
The authentication was not performed properly.
The XML response of the server cannot be read.

To find out whether an error occurred, use the ErrorOccurred variable.

Limit

Only the first 100 calendars are returned.

Component : wd240ggl.dll