PC SOFT

ONLINE HELP
 WINDEVWEBDEV AND WINDEV MOBILE

Home | Sign in | English EN
  • Properties specific to the description of gpwUser variables
  • Functions that use the gpwUser type:
WINDEV
WindowsLinuxUniversal Windows 10 AppJavaReports and QueriesUser code (UMC)
WEBDEV
WindowsLinuxPHPWEBDEV - Browser code
WINDEV Mobile
AndroidAndroid Widget iPhone/iPadIOS WidgetApple WatchMac CatalystUniversal Windows 10 App
Others
Stored procedures
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
WINDEVLinux This type of variable is now available for WINDEV applications in Linux.
WINDEVWindows This type of variable is now available for WINDEV applications in Windows.
New in version 22
WINDEVLinux This type of variable is now available for WINDEV applications in Linux.
WINDEVWindows This type of variable is now available for WINDEV applications in Windows.
WINDEVLinux This type of variable is now available for WINDEV applications in Linux.
WINDEVWindows This type of variable is now available for WINDEV applications in Windows.
Versions 25 and later
iPhone/iPad This type of variable is now available for iPhone/iPad applications.
Android This type of variable is now available for Android applications.
New in version 25
iPhone/iPad This type of variable is now available for iPhone/iPad applications.
Android This type of variable is now available for Android applications.
iPhone/iPad This type of variable is now available for iPhone/iPad applications.
Android This type of variable is now available for Android applications.
Example
WEBDEV - Server code
// 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:
NameType usedEffect
EmailCharacter stringEmail address of user.
EnabledBoolean
  • True if the user is enabled,
  • False otherwise.
FirstNameCharacter stringUser's first name.
IDExternalCharacter stringIdentifier 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.
LoginCharacter stringUsername.
NameCharacter stringUser's last name.
PasswordCharacter stringUser 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.
PhoneNumberCharacter stringUser's phone number.
SupervisorBoolean
  • True if the user is supervisor,
  • False otherwise.
Versions 26 and later
TOTPKey
New in version 26
TOTPKey
TOTPKey
Character stringTOTP key linked to the user for the two-factor authentication.
Versions 26 and later
TrustList
New in version 26
TrustList
TrustList
BufferIf 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
IntegerTwo-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).
Minimum version required
  • Version 19
This page is also available for…
Comments
Click [Add] to post a comment