Interface Session

Session information required for value management.

interface Session {
    acceptInvalid?: boolean;
    command?: boolean;
    fabric?: FabricIndex;
    fabricFiltered?: boolean;
    interactionComplete?: AsyncObservable<[], void>;
    offline?: boolean;
    subject?: NodeId;
    timed?: boolean;
    trace?: Action;
    transaction: Transaction;
    authorizedFor(desiredAccessLevel: AccessLevel, location?: Location): boolean;
}

Hierarchy (view full)

Properties

acceptInvalid? command? fabric? fabricFiltered? interactionComplete? offline? subject? timed? trace? transaction

Methods

authorizedFor

Properties

OptionalacceptInvalid

acceptInvalid?: boolean

If this is true, data validation is disabled. This should only be used in contexts where data validation is deferred.

Optional Readonlycommand

command?: boolean

If this is true then data access levels are not enforced. Datatypes and command-related access controls are active.

Optional Readonlyfabric

fabric?: FabricIndex

The fabric of the authorized client.

Optional ReadonlyfabricFiltered

fabricFiltered?: boolean

If this is true, fabric-scoped lists are filtered to the accessing fabric.

OptionalinteractionComplete

interactionComplete?: AsyncObservable<[], void>

If present the session is associated with an online interaction. Emits when the interaction ends.

Optionaloffline

offline?: boolean

If this is true then access levels are not enforced and all values are read/write. Datatypes are still enforced.

Tracks "offline" rather than "online" because this makes the safer mode (full enforcement) the default.

Optional Readonlysubject

subject?: NodeId

The authenticated SubjectId for online sessions.

Optional Readonlytimed

timed?: boolean

If this is true a timed transaction is in effect.

Optionaltrace

trace?: Action

A target for instrumentation information. If present, various components will populate with diagnostic information during the action.

transaction

transaction: Transaction

The transaction used for isolating state changes associated with this session.

Methods

authorizedFor

  • authorizedFor(desiredAccessLevel, location?): boolean

  • Checks if the authorized client has a certain Access Privilege granted.

    Parameters

    Returns boolean

Settings

Member Visibility

On This Page

Properties
Methods