Interface ISessionToken

interface ISessionToken {
    accessLevel: UserAccessLevel;
    additionalInfo: null | IStorage;
    applicationId: string;
    calendarId: string;
    client64Bit: null | boolean;
    client64BitOS: null | boolean;
    created: string;
    culture: string | number;
    deviceType: DeviceType;
    expires: string;
    hostIP: null | string;
    hostName: null | string;
    licenseType: SessionLicenseType;
    loginType: UserLoginType;
    osName: null | string;
    platformVersion: null | string;
    serverCode: string;
    sessionId: string;
    signature: string;
    timeZoneUtcOffset: number;
    uiCulture: string | number;
    userAgent: null | string;
    userId: string;
    userLogin: null | string;
    userName: string;
    utcOffset: number;
    fromStorage(storage: IStorage): ISessionToken;
    fromXML(xml: string): ISessionToken;
    toStorage(mode?: SessionSerializationMode): IStorage;
    toXML(mode?: SessionSerializationMode): string;
}

Implemented by

Properties

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

Methods

fromStorage fromXML toStorage toXML

Properties

ReadonlyaccessLevel

accessLevel: UserAccessLevel

User access level.

additionalInfo

additionalInfo: null | IStorage

Additional client session information.

ReadonlyapplicationId

applicationId: string

ID of the application that opened the session.

ReadonlycalendarId

calendarId: string

Calendar ID from the employee role card.

Readonlyclient64Bit

client64Bit: null | boolean

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

Readonlyclient64BitOS

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.

Readonlycreated

created: string

Date and time when the token was created.

Readonlyculture

culture: string | number

Regional settings for the user.

ReadonlydeviceType

deviceType: DeviceType

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

Readonlyexpires

expires: string

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

ReadonlyhostIP

hostIP: null | string

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

ReadonlyhostName

hostName: null | string

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

ReadonlylicenseType

licenseType: SessionLicenseType

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

ReadonlyloginType

loginType: UserLoginType

The type of authentication performed for the user.

ReadonlyosName

osName: null | string

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

ReadonlyplatformVersion

platformVersion: null | string

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

ReadonlyserverCode

serverCode: string

Server code.

ReadonlysessionId

sessionId: string

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

Readonlysignature

signature: string

Token signature confirming its authenticity.

ReadonlytimeZoneUtcOffset

timeZoneUtcOffset: number

Offset of the time zone from the employee role card.

ReadonlyuiCulture

uiCulture: string | number

The language of the user interface.

ReadonlyuserAgent

userAgent: null | string

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

ReadonlyuserId

userId: string

User ID.

ReadonlyuserLogin

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.

ReadonlyuserName

userName: string

User name.

ReadonlyutcOffset

utcOffset: number

Offset for the user relative to UTC.

Methods

fromStorage

fromXML

  • fromXML(xml: string): ISessionToken

    Parameters

    • xml: string

    Returns ISessionToken

toStorage

toXML

Settings

Member Visibility

On This Page

Properties
Methods