NodeOPCUA API Documentation
    Preparing search index...

    Interface ISessionContext

    interface ISessionContext {
        clientApplicationUri: string | null;
        clientCertificate: DER | null;
        currentTime?: PreciseClock;
        object?: UAObjectType | UAObject<UAObjectEvents>;
        session?: ISessionBase;
        checkPermission(node: BaseNode, action: PermissionType): boolean;
        currentUserHasRole(role: NodeIdLike): boolean;
        getCurrentUserRoles(): NodeId[];
        getUserName(): string;
        isAccessRestricted(node: BaseNode): boolean;
        isBrowseAccessRestricted(node: BaseNode): boolean;
        toJSON(): Record<string, string | null>;
        toString(): string;
    }

    Implemented by

    Index

    Properties

    clientApplicationUri clientCertificate currentTime? object? session?

    Methods

    checkPermission currentUserHasRole getCurrentUserRoles getUserName isAccessRestricted isBrowseAccessRestricted toJSON toString

    Properties

    clientApplicationUri: string | null

    The application URI extracted from the client certificate's SubjectAltName, or null if unavailable.

    clientCertificate: DER | null

    The client's application-instance certificate, or null if no secure channel is available.

    currentTime?: PreciseClock

    Server timestamp at the time the request was received.

    object?: UAObjectType | UAObject<UAObjectEvents>

    The object on which the current operation is being performed.

    session?: ISessionBase

    The underlying OPC UA session, if available.

    Methods

    • Check whether the current user has the given permission on a node.

      Parameters

      Returns boolean

    • Returns true if the current user has the given role.

      Parameters

      Returns boolean

    • Returns the NodeIds of all roles assigned to the current user.

      Returns NodeId[]

    • Returns the user name of the current user.

      Returns string

    • Returns true if access to the node is restricted by security settings.

      Parameters

      Returns boolean

    • Returns true if browsing the given node is restricted for the current user.

      Parameters

      Returns boolean

    • Returns a JSON representation of the context

      Returns Record<string, string | null>

    • Returns a string representation of the context

      Returns string

    Settings

    Member Visibility

    On This Page

    Properties
    Methods