gpwUser (Type of variable)

ONLINE HELP
WINDEV, WEBDEV AND WINDEV MOBILE

Version:

Home | Sign in | English

Properties specific to the description of gpwUser variables
Functions that use the gpwUser type:

WINDEV

WEBDEV

WINDEV Mobile

Others

See also

gpwUser (Type of variable)

In french: gpwUtilisateur

Not available

The gpwUser type is used to describe and modify the characteristics of a user of WEBDEV or WINDEV User Groupware.

Remark: For more details on the declaration of this type of variable and the use of WLanguage properties, see Declaring a variable.

Versions 22 and later

This type of variable is now available for WINDEV applications in Linux.

This type of variable is now available for WINDEV applications in Windows.

New in version 22

This type of variable is now available for WINDEV applications in Linux.

This type of variable is now available for WINDEV applications in Windows.

This type of variable is now available for WINDEV applications in Linux.

This type of variable is now available for WINDEV applications in Windows.

Versions 25 and later

This type of variable is now available for iPhone/iPad applications.

This type of variable is now available for Android applications.

New in version 25

This type of variable is now available for iPhone/iPad applications.

This type of variable is now available for Android applications.

This type of variable is now available for iPhone/iPad applications.

This type of variable is now available for Android applications.

Example

// Values of new user
clUser is gpwUser
clUser.Email = EDT_Email
clUser.Login = EDT_Login
clUser.Password = EDT_Password
clUser.LastName = EDT_LastName
clUser.FirstName = EDT_FirstName
clUser.PhoneNumber = EDT_Phone

// Add the user
IF gpwAddUser(clUser) = False THEN
Info("Unable to add the user.")
RETURN
END

// Activate the user
SWITCH gpwActivateUser(clUser.Login)
// For an activation by email
CASE gpwActivationByEmail
PopupDisplay(POPUP_ValidateSubscription)

// For an immediate activation
CASE gpwActivationImmédiate
// Connects the user directly
gpwConnectUser(clUser.Login, clUser.Password)
// Displays the confirmation popup
PopupDisplay(POPUP_ConfirmSubscription)

OTHER CASE
Info("Unable to activate the user.")
END

Remarks

Properties specific to the description of gpwUser variables

The following properties can be used to handle a gpwUser variable:

Name	Type used	Effect

Email	Character string	Email address of user.
Enabled	Boolean	True if the user is enabled, False otherwise.
FirstName	Character string	User's first name.
IDExternal	Character string	Identifier of the user in a database external to the groupware. This property can be used for example to link the user of the User Groupware of the User file of the application that is using the groupware by referencing its identifier. Caution: this property is available from version 190056.
Login	Character string	Username.
Name	Character string	User's last name.
Password	Character string	User password. Versions 27 and later This password is not retuned when gpwGetUserInfo is used to get the user information. New in version 27 This password is not retuned when gpwGetUserInfo is used to get the user information. This password is not retuned when gpwGetUserInfo is used to get the user information.
Versions 26 and later PasswordToEnter New in version 26 PasswordToEnter PasswordToEnter	Boolean	True if users must enter their password the first time they log in, False otherwise.
PhoneNumber	Character string	User's phone number.
Supervisor	Boolean	True if the user is supervisor, False otherwise.
Versions 26 and later TOTPKey New in version 26 TOTPKey TOTPKey	Character string	TOTP key linked to the user for the two-factor authentication.
Versions 26 and later TrustList New in version 26 TrustList TrustList	Buffer	If the two-factor authentication is turned on, the user can indicate that the current computer is a trusted computer. This property lists all user-defined trusted devices, computers and browsers. Remark: Users can remove trusted computers in the user profile of the User Groupware.
Versions 26 and later TwoFactorAuthentication New in version 26 TwoFactorAuthentication TwoFactorAuthentication	Integer	Two-factor authentication management mode: 0: Two-factor authentication turned off. The two-factor authentication is turned off for the user and is not required. 1: Two-factor authentication turned on. The two-factor authentication is turned on for the user. 2: The two-factor authentication must be turned on. The two-factor authentication is required but it is turned off.

Functions that use the gpwUser type:


Versions 19 and later gpwAddUser New in version 19 gpwAddUser gpwAddUser	Adds a user to the User Groupware database.
Versions 19 and later gpwModifyUser New in version 19 gpwModifyUser gpwModifyUser	Modifies a user in the database of user groupware.
Versions 19 and later gpwFindUser New in version 19 gpwFindUser gpwFindUser	Retrieves the characteristics of a user of the user groupware.
Versions 09 and later gpwGetUserInfo New in version 09 gpwGetUserInfo gpwGetUserInfo	Retrieves information about the current user (application that is using the User Groupware).