Default client class

Properties

appConfig: AppConfig
auth: Auth
model: Model
report: Report

Methods

  • Alpha

    The main entrypoint to the client

    Parameters

    • useCredentials: boolean = false

      Set to true to include the useCredentials header (used by browser clients)

    • OptionalwebAppProperties: WebAppProperties

      The TRIRIGA environment properties object

    Returns Promise<default>

    An instance of the Client object

    The client will be used to interact with TRIRIGA. It must be initialized prior to any system calls.

  • Initialize the client using an existing JSESSIONID.

    Parameters

    • sessionId: string

      The JSESSIONID value

    • OptionalwebAppProperties: WebAppProperties

      The TRIRIGA environment properties object

    Returns Promise<default>

    An instance of the Client object

    This method validates the session by calling getCurrentUser(). If the session is invalid or expired, it will throw an error. On success, the client is fully initialized with the user context, CSRF token, and web context ID.