This is documentation for Caché & Ensemble. See the InterSystems IRIS version of this content.

For information on migrating to InterSystems IRIS, see How to Migrate to InterSystems IRIS, available on the WRC Distributions page (login required).


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


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


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