Table of Contents

Class BudaUser

Namespace
PolarStudio
Assembly
PolarStudio.dll

This class contains information about a user that is logged on to Polar Studio.

public class BudaUser : PolarWeakEventListener
Inheritance
BudaUser
Implements
Inherited Members
Extension Methods

Properties

AuthenticationResult

Returns the authentication result object that contains all info collected when loggin on.

public AuthenticationResult AuthenticationResult { get; }

Property Value

AuthenticationResult

BpAuthenticated

This boolean returns True if authenticated using Blue Polar / the authentication server.

public bool BpAuthenticated { get; }

Property Value

bool

DateFormat

This property gets/sets the date format for the session.

public DateFormat DateFormat { get; set; }

Property Value

DateFormat

DateFormatString

Returns the string that can be used to format the date correctly using VBA_Format() according to the chosen DateFormat.

public string DateFormatString { get; }

Property Value

string

DateSeparator

This property gets/sets the date separator for the session.

public DateSeparator DateSeparator { get; set; }

Property Value

DateSeparator

DecimalCharacter

This property gets/sets the decimal character for the session.

public DecimalCharacter DecimalCharacter { get; set; }

Property Value

DecimalCharacter

DecimalCharacterString

Returns the character (as string) to use for the decimals character.

public string DecimalCharacterString { get; }

Property Value

string

DefaultLanguageID

This property gets/sets the DefaultLanguage for this user (a number 0-9).

public int DefaultLanguageID { get; set; }

Property Value

int

Engine

Returns the Engine (data layer) for this user/session.

public BudaEngine Engine { get; }

Property Value

BudaEngine

HasAcceptedPassword

Returns true if a password is known for this session.

public bool HasAcceptedPassword { get; }

Property Value

bool

IsAdmin

This property has no formal use but can be set during the log in procedure.

public bool IsAdmin { get; set; }

Property Value

bool

LockScreenWrongPasswordCount

This property counts the number of consecutive invalid passwords entered in the lock screen.

public int LockScreenWrongPasswordCount { get; }

Property Value

int

Name

Returns the full name for the user that is found for the given user id when loggin in.

public string Name { get; set; }

Property Value

string

Password

Returns the password entered by the user. It is only available during the execution of the ValidateUser script. Afterwards, it is cleared.

public string Password { get; }

Property Value

string

Session

Returns the Session this user is logged on to (data layer).

public BudaSession Session { get; }

Property Value

BudaSession

ThousandsCharacter

This property gets/sets the thousands character for the session.

public ThousandsCharacter ThousandsCharacter { get; set; }

Property Value

ThousandsCharacter

ThousandsCharacterString

Returns the character (as string) to use for the thousands character.

public string ThousandsCharacterString { get; }

Property Value

string

TimeFormat

This property gets/sets the time format for the session.

public TimeFormat TimeFormat { get; set; }

Property Value

TimeFormat

TimeFormatString

Returns the string that can be used to format the time correctly using VBA_Format() according to the chosen TimeFormat.

public string TimeFormatString { get; }

Property Value

string

TokenUsed

Returns True if the user used a token to log in.

public bool TokenUsed { get; }

Property Value

bool

UserID

Returns the UserID (like the email address or so) for this user.

public string UserID { get; }

Property Value

string

WelcomeMessage

This property gets/sets the welcome message to show directly after the user logged in.

public string WelcomeMessage { get; set; }

Property Value

string

Methods

ApplicationAccessGUID(BudaApplication)

Returns an ApplicationAccessGUID for the given application. This GUID can be created by the authentication server to store user/application specific setting on the server. If no ApplicationAccessGUID was found, a new random 16 char hex key is returned.

public string ApplicationAccessGUID(BudaApplication pApplication)

Parameters

pApplication BudaApplication

The Application to get the ApplicationAccessGUID for.

Returns

string

The known ApplicationAccessGUID or a new random 16 char hex key. If the authentication server did not return an ApplicationAccessGUID, a random key is returned that starts with 'xx'

ApplicationAllowed(string)

Returns a boolean indicating the user has access to the given application

public bool ApplicationAllowed(string pApplicationPID)

Parameters

pApplicationPID string

The PID for the application.

Returns

bool

True if the user has access to the application with the given Application PID. False if no access or the PID is not found.

ApplicationGroupID(string)

Returns the Group ID (an int matching the SysGroupID in the repository) the user is part of for the given Application PID.

public int ApplicationGroupID(string pApplicationPID)

Parameters

pApplicationPID string

The PID for the application.

Returns

int

The SysGroupID for the group the user has access for the application with the given Application PID. 0 if no access or the Application PID is not found.

ChangePassWord(object, string, string)

This method can be used to change the password for this user.

public bool ChangePassWord(object pOldPassword, string pNewPassWord1, string pNewPassWord2)

Parameters

pOldPassword object

The old password for the user. Use null/Nothing to ignore.

pNewPassWord1 string

The new password for the user.

pNewPassWord2 string

The confirmed new password for the user.

Returns

bool

A boolean if successful

Exceptions

PolarException

When an error occurs, an exception is thrown.

ChangePassWord(object, string, string, ref string)

This method can be used to change the password for this user.

public bool ChangePassWord(object pOldPassword, string pNewPassWord1, string pNewPassWord2, ref string pFailureReason)

Parameters

pOldPassword object

The old password for the user. Use null/Nothing to ignore.

pNewPassWord1 string

The new password for the user.

pNewPassWord2 string

The confirmed new password for the user.

pFailureReason string

This by ref string is set to a failure reason if applicable.

Returns

bool

A boolean if successful

CheckPasswordForLockScreen(string, BudaSession)

This method checks the given password as if it were entered in the lock screen.

public bool CheckPasswordForLockScreen(string pPassword, BudaSession pSession)

Parameters

pPassword string

The password to validate. This can be a normal password or a one time password, depending on the settings for this session.

pSession BudaSession

The current session.

Returns

bool

True if ok.

PrivateRecordID(BudaApplication)

Returns the private record ID for this user in the table that is set as private table for it's group.

public long? PrivateRecordID(BudaApplication pApplication)

Parameters

pApplication BudaApplication

The Application to get the private record ID for.

Returns

long?

A long with the private record ID or Nothing/NULL if none.