Show / Hide Table of Contents

Class NSUserInfo

Syntax

Constructors

NSUserInfo()

Initializes a new instance of the NSUserInfo class.

Declaration
NSUserInfo

Methods

GetCanLogon()

Declaration
Bool GetCanLogon()
Returns
Type Description
Bool
Examples
NSUserInfo thing;
Bool canLogon = thing.GetCanLogon();

GetDeleted()

Declaration
Bool GetDeleted()
Returns
Type Description
Bool

If true, the user is retired and should have no rights, not appear in lists, etc.

Examples
NSUserInfo thing;
Bool deleted = thing.GetDeleted();

GetEjUserId()

Declaration
Integer GetEjUserId()
Returns
Type Description
Integer

ID of the ej user record corresponding to this associate; 0 for associates that are not ej users.

Examples
NSUserInfo thing;
Integer ejUserId = thing.GetEjUserId();

GetGrantedLicenses()

Declaration
String[] GetGrantedLicenses()
Returns
Type Description
String[]
Examples
NSUserInfo thing;
String[] grantedLicenses = thing.GetGrantedLicenses();

GetPersonId()

Declaration
Integer GetPersonId()
Returns
Type Description
Integer

Owning person record.

Examples
NSUserInfo thing;
Integer personId = thing.GetPersonId();

GetRank()

Declaration
Integer GetRank()
Returns
Type Description
Integer

Rank order.

Examples
NSUserInfo thing;
Integer rank = thing.GetRank();

GetRoleName()

Declaration
String GetRoleName()
Returns
Type Description
String
Examples
NSUserInfo thing;
String roleName = thing.GetRoleName();

GetRoleTooltip()

Declaration
String GetRoleTooltip()
Returns
Type Description
String
Examples
NSUserInfo thing;
String roleTooltip = thing.GetRoleTooltip();

GetTooltip()

Declaration
String GetTooltip()
Returns
Type Description
String

Tooltip or other description.

Examples
NSUserInfo thing;
String tooltip = thing.GetTooltip();

GetUserGroupId()

Declaration
Integer GetUserGroupId()
Returns
Type Description
Integer

Primary group membership, See the UserGroupLink database table reference for secondary memberships.

Examples
NSUserInfo thing;
Integer userGroupId = thing.GetUserGroupId();

GetUserGroupName()

Declaration
String GetUserGroupName()
Returns
Type Description
String
Examples
NSUserInfo thing;
String userGroupName = thing.GetUserGroupName();

GetUserGroupTooltip()

Declaration
String GetUserGroupTooltip()
Returns
Type Description
String
Examples
NSUserInfo thing;
String userGroupTooltip = thing.GetUserGroupTooltip();

GetUserInfoId()

Declaration
Integer GetUserInfoId()
Returns
Type Description
Integer

Primary key.

Examples
NSUserInfo thing;
Integer userInfoId = thing.GetUserInfoId();

GetUserName()

Declaration
String GetUserName()
Returns
Type Description
String

Initials, also login name, possibly database user name.

Examples
NSUserInfo thing;
String userName = thing.GetUserName();

GetUserType()

Declaration
Integer GetUserType()
Returns
Type Description
Integer
Examples
NSUserInfo thing;
Integer userType = thing.GetUserType();

SetCanLogon(Bool)

Declaration
Void SetCanLogon(Bool canLogon)
Parameters
Type Name Description
Bool canLogon
Returns
Type Description
Void
Examples
NSUserInfo thing;
Bool canLogon;
thing.SetCanLogon(canLogon);

SetDeleted(Bool)

Declaration
Void SetDeleted(Bool deleted)
Parameters
Type Name Description
Bool deleted

If true, the user is retired and should have no rights, not appear in lists, etc.

Returns
Type Description
Void
Examples
NSUserInfo thing;
Bool deleted;
thing.SetDeleted(deleted);

SetEjUserId(Integer)

Declaration
Void SetEjUserId(Integer ejUserId)
Parameters
Type Name Description
Integer ejUserId

ID of the ej user record corresponding to this associate; 0 for associates that are not ej users.

Returns
Type Description
Void
Examples
NSUserInfo thing;
Integer ejUserId;
thing.SetEjUserId(ejUserId);

SetGrantedLicenses(String[])

Declaration
Void SetGrantedLicenses(String[] grantedLicenses)
Parameters
Type Name Description
String[] grantedLicenses
Returns
Type Description
Void
Examples
NSUserInfo thing;
String[] grantedLicenses;
thing.SetGrantedLicenses(grantedLicenses);

SetPersonId(Integer)

Declaration
Void SetPersonId(Integer personId)
Parameters
Type Name Description
Integer personId

Owning person record.

Returns
Type Description
Void
Examples
NSUserInfo thing;
Integer personId;
thing.SetPersonId(personId);

SetRank(Integer)

Declaration
Void SetRank(Integer rank)
Parameters
Type Name Description
Integer rank

Rank order.

Returns
Type Description
Void
Examples
NSUserInfo thing;
Integer rank;
thing.SetRank(rank);

SetRoleName(String)

Declaration
Void SetRoleName(String roleName)
Parameters
Type Name Description
String roleName
Returns
Type Description
Void
Examples
NSUserInfo thing;
String roleName;
thing.SetRoleName(roleName);

SetRoleTooltip(String)

Declaration
Void SetRoleTooltip(String roleTooltip)
Parameters
Type Name Description
String roleTooltip
Returns
Type Description
Void
Examples
NSUserInfo thing;
String roleTooltip;
thing.SetRoleTooltip(roleTooltip);

SetTooltip(String)

Declaration
Void SetTooltip(String tooltip)
Parameters
Type Name Description
String tooltip

Tooltip or other description.

Returns
Type Description
Void
Examples
NSUserInfo thing;
String tooltip;
thing.SetTooltip(tooltip);

SetUserGroupId(Integer)

Declaration
Void SetUserGroupId(Integer userGroupId)
Parameters
Type Name Description
Integer userGroupId

Primary group membership, See the UserGroupLink database table reference for secondary memberships.

Returns
Type Description
Void
Examples
NSUserInfo thing;
Integer userGroupId;
thing.SetUserGroupId(userGroupId);

SetUserGroupName(String)

Declaration
Void SetUserGroupName(String userGroupName)
Parameters
Type Name Description
String userGroupName
Returns
Type Description
Void
Examples
NSUserInfo thing;
String userGroupName;
thing.SetUserGroupName(userGroupName);

SetUserGroupTooltip(String)

Declaration
Void SetUserGroupTooltip(String userGroupTooltip)
Parameters
Type Name Description
String userGroupTooltip
Returns
Type Description
Void
Examples
NSUserInfo thing;
String userGroupTooltip;
thing.SetUserGroupTooltip(userGroupTooltip);

SetUserInfoId(Integer)

Declaration
Void SetUserInfoId(Integer userInfoId)
Parameters
Type Name Description
Integer userInfoId

Primary key.

Returns
Type Description
Void
Examples
NSUserInfo thing;
Integer userInfoId;
thing.SetUserInfoId(userInfoId);

SetUserName(String)

Declaration
Void SetUserName(String userName)
Parameters
Type Name Description
String userName

Initials, also login name, possibly database user name.

Returns
Type Description
Void
Examples
NSUserInfo thing;
String userName;
thing.SetUserName(userName);

SetUserType(Integer)

Declaration
Void SetUserType(Integer userType)
Parameters
Type Name Description
Integer userType

See AssociateType.

Returns
Type Description
Void
Examples
NSUserInfo thing;
Integer userType;
thing.SetUserType(userType);
In This Article
© SuperOffice. All rights reserved.
SuperOffice |  Community |  Release Notes |  Privacy |  Site feedback |  Search Docs |  About Docs |  Contribute |  Back to top