JavaScript API

i·views 5.4

Class: Session

$k. Session

new $k.Session()

Session for visualizing/editing views

Methods

static$k.Session.actual() : $k.Session

Returns the actual session if set, undefined if not. The actual session may differ from initial session in render phase

Only supported in the following application environment(s): View configuration mapper

Since:
  • 5.3.2
Returns:
Type Description
$k.Session

static$k.Session.current() : $k.Session

Returns the current session if set, undefined if not. The current session does not change throughout action execution and result rendering

Only supported in the following application environment(s): View configuration mapper

Since:
  • 5.3.0
Deprecated
  • Deprecated because of confusing/misleading naming. Use initial() instead.
    Returns:
    Type Description
    $k.Session

    static$k.Session.forPanel(panelName) : $k.Session

    Returns the session corresponding to the given panel if available, undefined if not. Searches starting from the current session.

    Only supported in the following application environment(s): View configuration mapper

    Name Type Description
    panelName string

    The configuration name of the panel
    Version:
    • Experimental feature, might be removed at any time
    Returns:
    Type Description
    $k.Session

    static$k.Session.initial() : $k.Session

    Returns the top session on the session stack as found initially at the beginning of the execution of an action. The initial session does not change throughout action execution and result rendering.

    Only supported in the following application environment(s): View configuration mapper

    Since:
    • 5.3.2
    Returns:
    Type Description
    $k.Session

    static$k.Session.main() : $k.Session

    Returns the main session if set, undefined if not.

    Only supported in the following application environment(s): View configuration mapper

    Returns:
    Type Description
    $k.Session

    static$k.Session.upcoming() : $k.Session

    Returns the upcoming session. The upcoming session will be the session used as soon as the session stack grows - e.g. when opening a dialog.

    Only supported in the following application environment(s): View configuration mapper

    Since:
    • 5.4.0
    Returns:
    Type Description
    $k.Session

    abort()

    Abort the (long running) session transaction.

    Only supported in the following application environment(s): View configuration mapper

    element() : $k.SemanticElement

    get the domain model element of the session

    Only supported in the following application environment(s): View configuration mapper

    Returns:
    Type Description
    $k.SemanticElement

    getVariable(variable)

    get the value of the given variable

    Name Type Description
    variable string
    Returns:
    (arrays of) SemanticElements and timestamps are auto-converted to native form

    panelConfiguration() : $k.SemanticElement

    Returns the panel configuration topic.

    Only supported in the following application environment(s): View configuration mapper

    Since:
    • 5.3.2
    Returns:
    Type Description
    $k.SemanticElement

    parent() : $k.Session

    get the parent session of the session, undefined if it has no parent

    Only supported in the following application environment(s): View configuration mapper

    Returns:
    Type Description
    $k.Session

    setVariable(variable, value)

    set the value of the given variable

    Name Type Description
    variable string
    value

    supported variable types include all javascript base types as well as: timestamp, SemanticElement and arrays of the latter