Interface ISessionToken

Hierarchy

  • ISessionToken

Implemented by

Properties

accessLevel additionalInfo applicationId calendarId client64Bit client64BitOS created culture deviceType expires hostIP hostName instanceName licenseType loginType osName platformVersion serverCode sessionId signature timeZoneUtcOffset uiCulture userAgent userId userLogin userName utcOffset

Methods

fromStorage fromXML toStorage toXML

Properties

Readonly accessLevel

accessLevel: UserAccessLevel

User access level.

additionalInfo

additionalInfo: null | IStorage<unknown>

Additional client session information.

Readonly applicationId

applicationId: string

ID of the application that opened the session.

Readonly calendarId

calendarId: string

Calendar ID from the employee role card.

Readonly client64Bit

client64Bit: null | boolean

Indicates that the client application is 64-bit. true - 64-bit application, false' - 32-bit application, null' - unknown bit depth.

Readonly client64BitOS

client64BitOS: null | boolean

Indicates that the client's operating system is 64-bit. true - 64-bit OS, false' - 32-bit OS, null' - the bit depth is unknown.

Readonly created

created: string

Date and time when the token was created.

Readonly culture

culture: string | number

Regional settings for the user.

Readonly deviceType

deviceType: DeviceType

The type of device that the user uses to connect to the server.

Readonly expires

expires: string

Date and time when the token expires and it must be re-generated.

Readonly hostIP

hostIP: null | string

IP address of the client requesting login, or null if the IP address is unknown.

Readonly hostName

hostName: null | string

Hostname for the client requesting login, or `null' if the hostname is unknown.

Readonly instanceName

instanceName: string

Name of the server instance.

Readonly licenseType

licenseType: SessionLicenseType

The type of license according to which the session is opened.

Readonly loginType

loginType: UserLoginType

The type of authentication performed for the user.

Readonly osName

osName: null | string

Name of the operating system used on the user's device, or `null' if the OS is unknown.

Readonly platformVersion

platformVersion: null | string

Platform version or null if the platform has not provided version information.

Readonly serverCode

serverCode: string

Server code.

Readonly sessionId

sessionId: string

ID of the session that was created during the authentication process.

Readonly signature

signature: string

Token signature confirming its authenticity.

Readonly timeZoneUtcOffset

timeZoneUtcOffset: number

Offset of the time zone from the employee role card.

Readonly uiCulture

uiCulture: string | number

The language of the user interface.

Readonly userAgent

userAgent: null | string

The UserAgent string of the browser that connects to the server, or `null' if the connection is not using a browser.

Readonly userId

userId: string

User ID.

Readonly userLogin

userLogin: null | string

User login, including Windows account or Tessa user login, or null if the session is not associated with a valid employee of the system.

Readonly userName

userName: string

User name.

Readonly utcOffset

utcOffset: number

Offset for the user relative to UTC.

Methods

fromStorage

fromXML

  • Parameters

    • xml: string

    Returns ISessionToken

toStorage

toXML

Generated using TypeDoc