Interface Session

Authorization metadata that varies with session.

interface Session {
    command?: boolean;
    fabric?: FabricIndex;
    fabricFiltered?: boolean;
    offline?: boolean;
    subject?: NodeId;
    timed?: boolean;
    authorizedFor(desiredAccessLevel: AccessLevel, location?: Location): boolean;
}

Hierarchy (view full)

Properties

command? fabric? fabricFiltered? offline? subject? timed?

Methods

authorizedFor

Properties

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.

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.

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