GglListDocument (Function)

WINDEV, WEBDEV AND WINDEV MOBILE
ONLINE HELP

Version:

Home | Sign in | English

Possible error cases:

WINDEV

WEBDEV

WINDEV Mobile

Others

See also

GglListDocument (Function)

In french: GglListeDocument

Retrieves the list of documents available on the Google server for the current user.

Warning
From version 20 (51), the management of Google documents evolves.
Indeed, the management of Google documents in WLanguage was using the "Google Documents List" service. The "Google Documents List" service will no longer be accessible from April 2015.

From now on, only the "Drive" API can be used. Using this API in your applications requires:

the declaration of the application in the Google console,
the activation of "Drive" API in the Google console.

See the help about gglConnect ("Prerequisite for the OAuth 2.0 authentication" paragraph) for more details.

The WLanguage functions and types used to manage the Google documents evolve in order to manage the "Drive" API from version 200051.

Remark: If you are using an earlier version of WINDEV, WEBDEV or WINDEV Mobile, the functions for managing the Google documents can no longer be used from April 2015.

Example

// Connection
Cnt is gglConnection
...
IF GglConnect(Cnt) = False THEN
Error(ErrorInfo())
END
...

// List of all documents
arrDocuments is array of 0 gglDocument dynamic
arrDocuments = GglListDocument(Cnt)

// List the documents containing the "Test" text
arrDocuments = GglListDocument(Cnt, "fullText contains 'Test'")

// List of favorite text documents found in the "Custom" folder
arrDocuments = GglListDocument(Cnt, gglWordProcessing, "Custom")

// Display the title of each listed document
Doc is gglDocument dynamic
FOR EACH Doc OF arrDocuments
Trace(Doc..Title)
END

Syntax

Versions 20 and later

Syntax that is using the Google Drive API (recommended) Hide the details

<Result> = GglListDocument(<Google connection> , <Search to perform>)

<Result>: Array of gglDocument variables

Array of gglDocument variables: each array element contains the characteristics of a document found on the Google server.

<Google connection>: gglConnection variable

Name of gglConnection variable to use. This connection was validated by GglConnect.

<Search to perform>: Character string (with quotes)

Search formula. See the documentation about the "Drive" API to find out the parameters that can be used: https://developers.google.com/drive/web/search-parameters

New in version 20

Syntax that is using the Google Drive API (recommended) Hide the details

<Result> = GglListDocument(<Google connection> , <Search to perform>)

<Result>: Array of gglDocument variables

Array of gglDocument variables: each array element contains the characteristics of a document found on the Google server.

<Google connection>: gglConnection variable

Name of gglConnection variable to use. This connection was validated by GglConnect.

<Search to perform>: Character string (with quotes)

Search formula. See the documentation about the "Drive" API to find out the parameters that can be used: https://developers.google.com/drive/web/search-parameters

Syntax that is using the Google Drive API (recommended) Hide the details

<Result> = GglListDocument(<Google connection> , <Search to perform>)

<Result>: Array of gglDocument variables

Array of gglDocument variables: each array element contains the characteristics of a document found on the Google server.

<Google connection>: gglConnection variable

Name of gglConnection variable to use. This connection was validated by GglConnect.

<Search to perform>: Character string (with quotes)

Search formula. See the documentation about the "Drive" API to find out the parameters that can be used: https://developers.google.com/drive/web/search-parameters

Syntax kept for backward compatibility, adapted to the "Drive" API Hide the details

<Result> = GglListDocument(<Google connection> [, <Filter> [, <Folder> [, <String to find>]]])

<Result>: Array of gglDocument variables

Array of gglDocument variables: each array element contains the characteristics of a document found on the Google server.

<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 document to list:
gglWorksheet Lists the "Worksheets" files only (files with a csv, xls or ods extension).
gglPresentation Lists the "Presentation" files only (files with a ppt or pps extension).
gglStarred Constant that can be combined with the other choices. Used to retrieve the documents tagged as "starred".
gglAll
(Default value) Lists all the documents found on the Google server in the specified folder.
gglWordProcessing Lists the "Word processing" files only (files with a txt, rtf, doc, odt, sxw or html extension)

<Folder>: Optional character string (with quotes)

Name of the folder containing the files to list. If this parameter is not specified, all the files found in all the folders are taken into account.

<String to find>: Optional character string (with quotes)

Caution: From version 20, this parameter evolves with the implementation of the "Drive" API. Search formula. See the documentation about the "Drive" API to find out the parameters that can be used: https://developers.google.com/drive/web/search-parameters

Remarks

Possible error cases:

The Internet connection is not valid.
The authentication was not performed properly.
Caution: you cannot perform a search that is using both:
- a filter applied to a type of document,
- a filter applied to the "Starred" documents,
- a filter applied to a specific folder.

Related Examples:

Unit examples (WINDEV): Accessing the Google documents

[ + ] Using the gglXxx functions to access the documents defined in your Google account.

Component : wd250ggl.dll