PC SOFT

ONLINE HELP
FOR WINDEV, WEBDEV AND WINDEV MOBILE

Home | Sign in | English US
New WINDEV, WEBDEV, WINDEV Mobile 24 feature!
  • Possible error cases:
  • Prerequisites for the OAuth 2.0 authentication
  • OAuth 2.0 authentication
  • Persistence of connection
WINDEV
WindowsLinuxUniversal Windows 10 AppJavaReports and QueriesUser code (UMC)
WEBDEV
WindowsLinuxPHPWEBDEV - Browser code
WINDEV Mobile
AndroidAndroid Widget iPhone/iPadApple WatchUniversal Windows 10 AppWindows Mobile
Others
Stored procedures
Allows you to authenticate yourself to a Google server. This function is automatically run when running a Gglxxx function.
Notes:
  • We recommend that you use <gglConnection variable>.Connect (syntax 2) to group the authorizations requests made by Google.
  • The disconnection is automatically performed when closing the application.
Example
// Connection by using the "OAuth 2.0" authentication mode
Cnt is gglConnection
Cnt..Email = "email_final_user@gmail.com"
Cnt..ClientID = "387756281032-qffa6dajjd5348iqhi558dkd98xxxxxx.apps.googleusercontent.com"
Cnt..ClientSecret = "S13DCA6KkYh1EgPv9-jLxxxh"
// During the connection, the user will have to validate the services used
// (See the additional examples for more details)
IF Cnt.Connect =False THEN
Error(ErrorInfo())
END
Syntax

Connecting with the basic authentication Hide the details

<Result> = <Google connection>.Connect()
<Result>: Boolean
  • True if the authentication was performed,
  • False if a problem occurred. To find out the error details, use ErrorInfo.
<Google connection>: gglConnection variable
Name of the gglConnection variable to use.
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.

Connecting by specifying the services used Hide the details

<Result> = <Google connection>.Connect(<Google service>)
<Result>: Boolean
  • True if the authentication was performed,
  • False if a problem occurred. To find out the error details, use ErrorInfo.
<Google connection>: gglConnection variable
Name of gglConnection variable to use.
<Google service>: Integer constant (or combination of constants)
Google service to enable (the application must access these services):
gglServiceCalendar"Google Calendar" service: Google calendar
gglServiceContacts"Google Contacts" service: Management of Google contacts
gglServiceDocuments"Google Documents List" service: Management of documents
gglServicePicasa"Picasa" service
Remarks

Possible error cases:

  • The Internet connection is not valid.
  • The authentication was not performed properly.
Versions 20 and later

Prerequisites for the OAuth 2.0 authentication

To connect with the OAuth 2.0 authentication, the application must be declared on your Google developer console: https://developers.google.com/console.
In the console:
  1. Click "Create a project". Give the name of your project. An identifier is automatically proposed for your project.
  2. Validate
  3. The project is created.
  4. In the menu on the left, click "API and authentication" then "API".
  5. Choose the services required by the application:
    • To access the calendars, choose "Calendar API" ("Google Apps APIs" category).
    • To access the contacts, choose "Contacts API" ("Google Apps APIs" category).
    • To access the Google documents, choose "Drive API" ("Google Apps APIs" category).
    • To access the Picasa albums and the documents, there is no need to select a specific API.
  6. In the menu on the left, click "Identifiers".
  7. Then, click the "Create a client identifier" button.
    • Select the type of application: "Application installed".
    • The authorization screen must be configured during the first creation of client identifier.
    • In the authorisation screen, in the "Product name" area, enter the name of your application for example.
    • Click "Save".
    • The screen for creating the client identifier is re-displayed.
      • Validate. The client identifiers are created:
        • Client identifier. This identifier must be stored. It will be used in the gglConnection variable.
        • Secret code of client. This identifier must be stored. It will be used in the gglConnection variable.
    New in version 20

    Prerequisites for the OAuth 2.0 authentication

    To connect with the OAuth 2.0 authentication, the application must be declared on your Google developer console: https://developers.google.com/console.
    In the console:
    1. Click "Create a project". Give the name of your project. An identifier is automatically proposed for your project.
    2. Validate
    3. The project is created.
    4. In the menu on the left, click "API and authentication" then "API".
    5. Choose the services required by the application:
      • To access the calendars, choose "Calendar API" ("Google Apps APIs" category).
      • To access the contacts, choose "Contacts API" ("Google Apps APIs" category).
      • To access the Google documents, choose "Drive API" ("Google Apps APIs" category).
      • To access the Picasa albums and the documents, there is no need to select a specific API.
    6. In the menu on the left, click "Identifiers".
    7. Then, click the "Create a client identifier" button.
      • Select the type of application: "Application installed".
      • The authorization screen must be configured during the first creation of client identifier.
      • In the authorisation screen, in the "Product name" area, enter the name of your application for example.
      • Click "Save".
      • The screen for creating the client identifier is re-displayed.
        • Validate. The client identifiers are created:
          • Client identifier. This identifier must be stored. It will be used in the gglConnection variable.
          • Secret code of client. This identifier must be stored. It will be used in the gglConnection variable.

      Prerequisites for the OAuth 2.0 authentication

      To connect with the OAuth 2.0 authentication, the application must be declared on your Google developer console: https://developers.google.com/console.
      In the console:
      1. Click "Create a project". Give the name of your project. An identifier is automatically proposed for your project.
      2. Validate
      3. The project is created.
      4. In the menu on the left, click "API and authentication" then "API".
      5. Choose the services required by the application:
        • To access the calendars, choose "Calendar API" ("Google Apps APIs" category).
        • To access the contacts, choose "Contacts API" ("Google Apps APIs" category).
        • To access the Google documents, choose "Drive API" ("Google Apps APIs" category).
        • To access the Picasa albums and the documents, there is no need to select a specific API.
      6. In the menu on the left, click "Identifiers".
      7. Then, click the "Create a client identifier" button.
        • Select the type of application: "Application installed".
        • The authorization screen must be configured during the first creation of client identifier.
        • In the authorisation screen, in the "Product name" area, enter the name of your application for example.
        • Click "Save".
        • The screen for creating the client identifier is re-displayed.
          • Validate. The client identifiers are created:
            • Client identifier. This identifier must be stored. It will be used in the gglConnection variable.
            • Secret code of client. This identifier must be stored. It will be used in the gglConnection variable.
        Versions 20 and later

        OAuth 2.0 authentication

        The call to <gglConnection variable>.Connect triggers:
        1. The opening of a login window for the end user. If the ..Email property of the gglConnection variable is specified, Google pre-fills the login window with the specified email address. The login window is not displayed if the user is already connected.
        2. The opening of the authorisation window. The end user must allow the application to access his account. This window is automatically closed when the user accepts or cancels.
        Notes:
        • If the syntax 1 is used (connection with basic authentication), an authorization window will be displayed whenever an attempt is performed to access a new service.
        • If the syntax 2 is used (connection by specifying the services used), an authorization window will be displayed for all the services requested at the beginning of the application.
        • The authorization window can be displayed during the first application start if the persistence of connection is managed (see next paragraph).
        New in version 20

        OAuth 2.0 authentication

        The call to <gglConnection variable>.Connect triggers:
        1. The opening of a login window for the end user. If the ..Email property of the gglConnection variable is specified, Google pre-fills the login window with the specified email address. The login window is not displayed if the user is already connected.
        2. The opening of the authorisation window. The end user must allow the application to access his account. This window is automatically closed when the user accepts or cancels.
        Notes:
        • If the syntax 1 is used (connection with basic authentication), an authorization window will be displayed whenever an attempt is performed to access a new service.
        • If the syntax 2 is used (connection by specifying the services used), an authorization window will be displayed for all the services requested at the beginning of the application.
        • The authorization window can be displayed during the first application start if the persistence of connection is managed (see next paragraph).

        OAuth 2.0 authentication

        The call to <gglConnection variable>.Connect triggers:
        1. The opening of a login window for the end user. If the ..Email property of the gglConnection variable is specified, Google pre-fills the login window with the specified email address. The login window is not displayed if the user is already connected.
        2. The opening of the authorisation window. The end user must allow the application to access his account. This window is automatically closed when the user accepts or cancels.
        Notes:
        • If the syntax 1 is used (connection with basic authentication), an authorization window will be displayed whenever an attempt is performed to access a new service.
        • If the syntax 2 is used (connection by specifying the services used), an authorization window will be displayed for all the services requested at the beginning of the application.
        • The authorization window can be displayed during the first application start if the persistence of connection is managed (see next paragraph).
        Versions 20 and later

        Persistence of connection

        During the connection to the Google services, the authentication tokens are not saved. It is therefore necessary to re-login and re-authorize the access to the application each time the application is run (i.e. each time a gglConnection "blank" variable is used).
        In order for the access authorization to be persistent, all you have to do is call the serialization functions of WLanguage.
        Example for implementing the persistence by using an XML file:
        let sAuthPersistenceFile = SysDir(srLocalAppData) + [fSep] + "gglauth.xml"
         
        cnt is gglConnection
        // If connection already established
        IF fFileExist(sAuthPersistenceFile) THEN
        // Restore the connection
        let bufDeserialize = fLoadBuffer(sAuthPersistenceFile)
        Deserialize(cnt, bufDeserialize, psdXML)
        ELSE
        // New connection
        cnt.Email = "email@gmail.com"
        cnt.ClientID = "387756281032-qffa6dajjd5348iqhi558xxxxxxxx.apps.googleusercontent.com"
        cnt.ClientSecret = "Sxxxxx-jLMwwh"
        END
         
        IF cnt.Connect(gglServiceCalendar) THEN
        // Save the connection in order to re-use it later
        bufSerialize is Buffer
        Serialize(cnt, bufSerialize, psdXML)
        fSaveBuffer(sAuthPersistenceFile, bufSerialize)
        END
         
        Note: The authentication tokens of a gglConnection variable can be cleared via <gglConnection variable>.Disconnect.
        New in version 20

        Persistence of connection

        During the connection to the Google services, the authentication tokens are not saved. It is therefore necessary to re-login and re-authorize the access to the application each time the application is run (i.e. each time a gglConnection "blank" variable is used).
        In order for the access authorization to be persistent, all you have to do is call the serialization functions of WLanguage.
        Example for implementing the persistence by using an XML file:
        let sAuthPersistenceFile = SysDir(srLocalAppData) + [fSep] + "gglauth.xml"
         
        cnt is gglConnection
        // If connection already established
        IF fFileExist(sAuthPersistenceFile) THEN
        // Restore the connection
        let bufDeserialize = fLoadBuffer(sAuthPersistenceFile)
        Deserialize(cnt, bufDeserialize, psdXML)
        ELSE
        // New connection
        cnt.Email = "email@gmail.com"
        cnt.ClientID = "387756281032-qffa6dajjd5348iqhi558xxxxxxxx.apps.googleusercontent.com"
        cnt.ClientSecret = "Sxxxxx-jLMwwh"
        END
         
        IF cnt.Connect(gglServiceCalendar) THEN
        // Save the connection in order to re-use it later
        bufSerialize is Buffer
        Serialize(cnt, bufSerialize, psdXML)
        fSaveBuffer(sAuthPersistenceFile, bufSerialize)
        END
         
        Note: The authentication tokens of a gglConnection variable can be cleared via <gglConnection variable>.Disconnect.

        Persistence of connection

        During the connection to the Google services, the authentication tokens are not saved. It is therefore necessary to re-login and re-authorize the access to the application each time the application is run (i.e. each time a gglConnection "blank" variable is used).
        In order for the access authorization to be persistent, all you have to do is call the serialization functions of WLanguage.
        Example for implementing the persistence by using an XML file:
        let sAuthPersistenceFile = SysDir(srLocalAppData) + [fSep] + "gglauth.xml"
         
        cnt is gglConnection
        // If connection already established
        IF fFileExist(sAuthPersistenceFile) THEN
        // Restore the connection
        let bufDeserialize = fLoadBuffer(sAuthPersistenceFile)
        Deserialize(cnt, bufDeserialize, psdXML)
        ELSE
        // New connection
        cnt.Email = "email@gmail.com"
        cnt.ClientID = "387756281032-qffa6dajjd5348iqhi558xxxxxxxx.apps.googleusercontent.com"
        cnt.ClientSecret = "Sxxxxx-jLMwwh"
        END
         
        IF cnt.Connect(gglServiceCalendar) THEN
        // Save the connection in order to re-use it later
        bufSerialize is Buffer
        Serialize(cnt, bufSerialize, psdXML)
        fSaveBuffer(sAuthPersistenceFile, bufSerialize)
        END
         
        Note: The authentication tokens of a gglConnection variable can be cleared via <gglConnection variable>.Disconnect.
        Component : wd240ggl.dll
        Minimum required version
        • Version 24
        This page is also available for…
        Comments
        Click [Add] to post a comment