TESSA Web API
    Preparing search index...

    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

    Index

    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

    accessLevel: UserAccessLevel

    User access level.

    additionalInfo: null | IStorage

    Additional client session information.

    applicationId: string

    ID of the application that opened the session.

    calendarId: string

    Calendar ID from the employee role card.

    client64Bit: null | boolean

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

    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.

    created: string

    Date and time when the token was created.

    culture: string | number

    Regional settings for the user.

    deviceType: DeviceType

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

    expires: string

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

    hostIP: null | string

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

    hostName: null | string

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

    licenseType: SessionLicenseType

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

    loginType: UserLoginType

    The type of authentication performed for the user.

    osName: null | string

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

    platformVersion: null | string

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

    serverCode: string

    Server code.

    sessionId: string

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

    signature: string

    Token signature confirming its authenticity.

    timeZoneUtcOffset: number

    Offset of the time zone from the employee role card.

    uiCulture: string | number

    The language of the user interface.

    userAgent: null | string

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

    userId: string

    User ID.

    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.

    userName: string

    User name.

    utcOffset: number

    Offset for the user relative to UTC.

    Methods

    • Parameters

      • xml: string

      Returns ISessionToken

    Settings

    Member Visibility

    On This Page

    Properties
    Methods