This is documentation for Caché & Ensemble.

For information on converting to InterSystems IRIS, see the InterSystems IRIS Adoption Guide and the InterSystems IRIS In-Place Conversion Guide, both available on the WRC Distributions page (login required).

Home > Class Reference > %SYS namespace > %DeepSee.Session

%DeepSee.Session

class %DeepSee.Session extends %Library.RegisteredObject

This class provides the API for DeepSee sessions. An instance of this class represents the current session.

Property Inventory

Method Inventory

Properties

property sessionId as %String;
Id for this session.
Property methods: sessionIdDisplayToLogical(), sessionIdGet(), sessionIdIsValid(), sessionIdLogicalToDisplay(), sessionIdLogicalToOdbc(), sessionIdNormalize(), sessionIdSet()

Methods

classmethod %CreateSession(pSessionId As %String = "", Output pSC As %Status) as Session
Create a new DeepSee session. If pSessionId is provided, then it used, otherwise $J is used.
method %EndSession() as %Status
Terminate this DeepSee session and remove all definitions associated with it.
method %GetSessionId() as %Status
Get the session ID for this session.
classmethod %ResumeSession(pSessionId As %String = "", Output pSC As %Status) as Session
Resume a previously running session.
method %SuspendSession() as %Status
Suspend the currently running session.

Inherited Members

Inherited Methods

Feedback