gpwUser (Type of variable)

ONLINE HELP
WINDEV, WEBDEV AND WINDEV MOBILE

Version:

Home | Sign in | English

Help

WLanguage

WLanguage functions

Controls, pages and windows

User Groupware functions

gpwUser

Presentation

Example

Properties specific to gpwUser variables

Functions that use the gpwUser type:

See also

gpwUser (Type of variable)

In french: gpwUtilisateur

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.

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 gpwUser variables

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

Name	Type used	Effect

AccessRights	Integer constant	User access rights: gpwRightsAddApplication: Right to add an application in the Private Store. gpwRightsNone: No add rights.
Email	Character string	User's email address.
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 uses the groupware by referencing its identifier.
LastName	Character string	User's last name.
Password	Character string	User password. This password is not retuned when gpwGetUserInfo is used to get the user information.
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.
TOTPKey	Character string	TOTP key linked to the user for the two-factor authentication.
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.
TwoFactorAuthentication	Integer	Two-factor authentication management mode: 0: Two-factor authentication turned off. Two-factor authentication is turned off for the user and is not required. 1: Two-factor authentication turned on. Two-factor authentication is turned on for the user. 2: The two-factor authentication must be turned on. Two-factor authentication is required but it is turned off.
Username	Character string	Username.

Functions that use the gpwUser type:


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