Hierarchy

  • Application

Properties

apiVersion: ApiVersion

Returns the current plugin api version of the application.

buildInfo: string
buildTimeStamp: string
commonResources: CommonResources

Commonly used localized resources.

componentFactory: ComponentFactory

Factory for reusable components.

customData: GroupedMap

Can be used to store runtime user/custom data (e.g. to share data between plugins). This data is not persistent.

eaiwsSessionDefaults: Readonly<EaiwsSessionDefaults>

eaiws session default settings

isBusy: boolean

Returns true if the application is currently busy, see begin/endBusySection().

name: string
pluginManager: PluginManager
user: null | User

The currently logged in user.

userRestrictions: ReadonlySet<UserRestriction>

Set of restrictions for the current user.

utils: Utils
version: string

Methods

  • Begins a new busy section for the application. All user interactions will be blocked while the application is busy. A call of beginBusySection() always has to be followed by a call of endBusySection(). It is allowed nest several calls to begin/endBusySection().

    Returns void

  • Ends the current busy section.

    Returns void

  • Promise which resolves after the application finishes pending operations and is no longer busy. Calling this function will remove the focus from the current focused element in order to call the onBlur handlers. Operations which did not start a busy section will be ignored.

    Returns Promise<void>

  • Helper function which executes the given task inside a busy section. See beginBusySection().

    Type Parameters

    • T = void

    Parameters

    • pTask: (() => Promise<T>)
        • (): Promise<T>
        • Returns Promise<T>

    Returns Promise<T>

  • Helper function to show an error message.

    Parameters

    • pMessage: string
    • Optional pError: unknown

    Returns Promise<void>

  • Shows a message box and returns the index of the clicked button or -1 if the message box was closed by the user.

    Parameters

    Returns Promise<number>

  • Shows a common upload dialog. The promise will return after the upload is finished or the user closed the dialog.

    Parameters

    Returns Promise<void>

  • Promise which resolves if the application is not or no longer busy.

    Returns Promise<void>

Generated using TypeDoc