gpwAddAuthLogin (Function)

ONLINE HELP
WINDEV, WEBDEV AND WINDEV MOBILE

Version:

Home | Sign in | English

Help / WLanguage / WLanguage functions / Controls, pages and windows / User Groupware functions

WINDEV

WEBDEV

WINDEV Mobile

Others

See also

gpwAddAuthLogin (Function)

In french: gpwAjouteAuthLogin

Adds a login button that represents a type of authentication (Facebook, Google, Microsoft, etc.) for the User Groupware in the login window or page.

Remarks:

This setting is only allowed if the User Groupware is configured for manual run.
It is necessary to have previously registered the application in each service used.

Example

// Log in with Google
GoogleOpenIDParams is OpenIDParameters
GoogleOpenIDParams.ClientID = "106034950???????.apps.googleusercontent.com" 
GoogleOpenIDParams.ClientSecret = "oBTQL??????MpiM"
gpwAddAuthLogin(GoogleOpenIDParams, gpwGoogle)

// Log in with Facebook
FacebookOAuthParams is OAuth2Parameters
FacebookOAuthParams.ClientID = "1702?????741"
FacebookOAuthParams.ClientSecret = "badf00d?????1ce8ecd"
gpwAddAuthLogin(FacebookOAuthParams, gpwFacebook)

// Log in with my custom domain
CustomOpenIDParams is OpenIDParameters
CustomOpenIDParams.ClientID = "1745?????4741"
CustomOpenIDParams.ClientSecret = "dbeefba?????1ce8ecd"
gpwAddAuthLogin(CustomOpenIDParams, "CustomDomain", fExeDir() + "\customdomain.png")

// Opens the User Groupware login window 
nRes is int = gpwOpen()
// If the login failed 
IF nRes <> gpwOk THEN 
	SWITCH nRes 
		CASE gpwCancel: Info("The Cancel button was clicked.")
		CASE gpwError: Error("Error while initializing the groupware.")
		CASE gpwUnknownUser: Error("Unknown user.")
		CASE gpwInvalidPassword: Error("Invalid password")
	END 
	EndProgram()
END 
// Retrieve the user's first name 
FirstName is string = gpwGetUserInfo(gpwInfoFirstName)
Info("Welcome, " + FirstName)

Syntax

Adding a login button to one of the services available by default Hide the details

gpwAddAuthLogin(<Type of authentication> , <Type>)

<Type of authentication>: OAuth2Parameters variable or OpenIDParameters variable

Name of a variable of type OAuth2Parameters to authenticate to a web service that uses OAuth 2.0.
Name of a variable of type OpenIDParameters to authenticate to a web service that uses OpenID.
Remark: the AuthURL, RedirectionURL and TokenURL properties are optional. The default URLs are used.

<Type>: Integer constant

Type of web service to use:
gpwFacebook Use of a Facebook account.
gpwGoogle Use of a Google Account.
gpwMicrosoft Use of a Microsoft account.
gpwSalesforce Use of a Salesforce account.
gpwYahoo Use of a Yahoo account.

Adding a custom login button Hide the details

gpwAddAuthLogin(<Type of authentication> , <Caption> [, <Image>])

<Type of authentication>: OAuth2Parameters variable or OpenIDParameters variable

Name of a variable of type OAuth2Parameters to authenticate to a web service that uses OAuth 2.0.
Name of a variable of type OpenIDParameters to authenticate to a web service that uses OpenID.

<Caption>: Character string

Caption of the service displayed in the button.

<Image>: Optional character string

Name and path of the image file that corresponds to the service logo.
This image can be in one of the following formats: .ICO, .PNG, .JPG, .GIF.
Its dimensions must be 24 x 24 pixels.

Business / UI classification: Neutral code

Component: wd300gpu.dll