Show / Hide Table of Contents
  • BC HTML Api reference
    • html-api
      • AnnotationArrowOrientation
      • AnnotationTextAlignment
      • AnnotationTextFontFamily
      • BarcodeOrientation
      • BarcodeThresholdMode
      • BarcodeType
      • BatchEnums
        • Mode
        • Queue
      • CallContext
      • DbClient
      • DbServer
      • FileMimeType
      • FileType
      • IAnnotation
      • IAnnotationProperties
      • IApplication
      • IBarcodeData
      • IBaseControl
      • IBatch
      • IBatchClass
      • IButton
      • ICheckBox
      • IComboBox
      • ICustomThemeConfig
      • IDocument
      • IDocumentClass
      • IField
      • IFieldValidation
      • IFileInfo
      • IFolder
      • IFolderClass
      • IFormType
      • IGroup
      • IIndexClass
      • IITModule
      • IJob
      • ILabel
      • ILicenseGroup
      • IListItem
      • IListView
      • ImageColorMode
      • ImageOperationType
      • INode
      • INodeComment
      • INodeReviewComment
      • INuanceEngineConfig
      • IOCRConfiguration
      • IPage
        • Side
      • IRadioButton
      • IRecognitionProfile
      • IRectangle
      • IRegexValidation
      • IScanProfile
      • ITable
      • ITabView
      • ITextBox
      • IthConfig
      • ITitledPanel
      • IUser
      • LevelName
      • NodeReviewStatus
      • NuanceEngine
      • NuanceLanguage
      • NuanceMode
      • PageSideMode
      • RecognitionEngine
      • RpcService
      • ScanService
      • ScanSource
      • ScriptActionType
      • ScriptResultConsts
      • ScriptResultProp
      • UnloadReason

Interface IUser

Represents a User in the ImageTrust system.

Note: Write-access to properties depends on the context in which the model is used. When in a read-only context, set* methods will throw an UnmodifiableException.

Properties list

authenticator description email fullName licenseGroup username

Methods list

getAuthenticator() getDescription() getEmail() getFullName() getGroups() getLicenseGroup() getUsername()

Properties

authenticator

see IUser.getAuthenticator()

Declaration
readonly authenticator: string;
Property Value
Type Description
string

description

see IUser.getDescription()

Declaration
readonly description: string;
Property Value
Type Description
string

email

see IUser.getEmail()

Declaration
readonly email: string;
Property Value
Type Description
string

fullName

see IUser.getFullName()

Declaration
readonly fullName: string;
Property Value
Type Description
string

licenseGroup

see IUser.getLicenseGroup()

Declaration
readonly licenseGroup: ILicenseGroup;
Property Value
Type Description
ILicenseGroup

username

see IUser.getUsername()

Declaration
readonly username: string;
Property Value
Type Description
string

Methods

getAuthenticator()

Returns the authenticator that authenticates this user

Declaration
getAuthenticator(): string;
Returns
Type Description
string

getDescription()

Returns the description of this User

Declaration
getDescription(): string;
Returns
Type Description
string

getEmail()

Returns the email address of this User

Declaration
getEmail(): string;
Returns
Type Description
string

getFullName()

Returns the full name of this User

Declaration
getFullName(): string;
Returns
Type Description
string

getGroups()

Returns the IGroup that this User is a member of. Every User must be a member of at least one Group.

The returned Set cannot be modified.

Declaration
getGroups(): Set<IGroup>;
Returns
Type Description
Set<IGroup>

getLicenseGroup()

Returns the ILicenseGroup that is assigned to this User. The return value will be null if no ILicenseGroup is assigned to this User.

Declaration
getLicenseGroup(): ILicenseGroup;
Returns
Type Description
ILicenseGroup

getUsername()

Returns the username of this User

Declaration
getUsername(): string;
Returns
Type Description
string
Back to top Generated by DocFX