GglListContact (Function)

WINDEV, WEBDEV AND WINDEV MOBILE
ONLINE HELP

Version:

Home | Sign in | English

Possible error cases:

WINDEV

WEBDEV

WINDEV Mobile

Others

See also

GglListContact (Function)

In french: GglListeContact

Retrieves the list of contacts associated with the specified Google account.

Caution: the access to the Google Contacts 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 Contacts.

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 Contacts, the application must use the "Contacts 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

// Connection
Cnt is gglConnection
...
// Retrieves all the contacts
arrContacts is array of 0 gglContact = GglListContact(Cnt)

// Example with 10 contacts per page:
// First page
// Retrieves all the contacts, with a maximum of 10 contacts, starting from index 1
arrContacts = GglListContact(Cnt, "", 1, 10)
// Second page
// Retrieves all the contacts, with a maximum of 10 contacts, starting from index 11
arrContacts = GglListContact(Cnt, "", 11, 10)
// Browse the contacts
MyContact is dynamic gglContact
FOR EACH MyContact OF arrContacts
Trace(MyContact..Name)
END

Syntax

<Result> = GglListContact(<Google connection> [, <Group of contacts> [, <First element> [, <Maximum number of contacts>]]])

<Result>: Array of gglContact variables

Array of gglContact variables.

<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.

<Group of contacts>: Optional Unicode character string

Name or identifier of the group of contacts to list. If this parameter corresponds to an empty string (""), all the groups are listed. This parameter corresponds to an empty string by default.

<First element>: Optional integer

Number of the first contact to retrieve (1 by default). This parameter must be greater than or equal to 1.

<Maximum number of contacts>: Optional integer

Maximum number of contacts to retrieve (0 by default). If this parameter corresponds to 0, the maximum number of contacts is unlimited. This parameter must be greater than or equal to 0.

Remarks

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.

Component : wd240ggl.dll