User

This class contains functions that allow you to return information about the current logged-in user, or another registered user in the application.

Collapse all

getCurrentInfo

Show/Hide

Description

Get information about the logged-in user.

Return Function

The entity

Parameters

Example

Dim currentUser as UserVO = SDK.User.getCurrentInfo()

If currentUser isNot Nothing
Return New MsgInfo("The current user name is: " + currentUser.username)
End If

getInfo

Show/Hide

Description

Get information about an existing user in the database.

Return Function

The entity

Parameters

value	Description	Type
value	It is the value by which the search is performed.	Object
byType	It´s the type of the search this parameter is optional and the default value is "ByInfoTypes.UserCode"	ENUM PHCBusinessLayer.SDK.User.ByInfoTypes (None,UserCode,eMail,Number,Stamp)

Example

Dim infoUser as UserVO = SDK.User.getInfo("myEmail@PostOffice.Com",ByInfoTypes.eMail)

If infoUser isNot Nothing
Return New MsgInfo("The user name is: " + currentUser.username)
End If

IsUserLoggedIn

Show/Hide

Description

In Check if the user is logged in.

Return Function

A logical value indicating whether or not the user is logged in.

Parameters

Example

Dim isLoggedIn as Boolean = SDK.User.IsUserLoggedIn()