Class Reference
IRIS for UNIX 2019.4
InterSystems: The power behind what matters   
Documentation  Search
  [%SYS] >  [%DeepSee] >  [Session]
Private  Storage   

class %DeepSee.Session extends %RegisteredObject

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

Inventory

Parameters Properties Methods Queries Indices ForeignKeys Triggers
1 8


Summary

Properties
sessionId

Methods
%%OIDGet %AddToSaveSet %BindExport %BuildObjectGraph
%ClassIsLatestVersion %ClassName %Close %ConstructClone
%CreateSession %DispatchClassMethod %DispatchGetModified %DispatchGetProperty
%DispatchMethod %DispatchSetModified %DispatchSetMultidimProperty %DispatchSetProperty
%EndSession %Extends %GetParameter %GetSessionId
%GetTrackingKeys %IncrementCount %IsA %IsModified
%New %NormalizeObject %ObjectModified %OriginalNamespace
%PackageName %RemoveFromSaveSet %ResumeSession %SerializeObject
%SetModified %SuspendSession %ValidateObject


Properties

• property sessionId as %String;
Id for this session.

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 %GetTrackingKeys() as %Status
If this process does not already have a collection of shared memory keys stored in %dsTrackingKeys, create them.
• private method %OnClose() as %Status
This callback method is invoked by the %Close method to provide notification that the current object is being closed.

The return value of this method is ignored.

• private method %OnNew() as %Status
This callback method is invoked by the %New method to provide notification that a new instance of an object is being created.

If this method returns an error then the object will not be created.

It is passed the arguments provided in the %New call. When customizing this method, override the arguments with whatever variables and types you expect to receive from %New(). For example, if you're going to call %New, passing 2 arguments, %OnNew's signature could be:

Method %OnNew(dob as %Date = "", name as %Name = "") as %Status If instead of returning a %Status code this returns an oref and this oref is a subclass of the current class then this oref will be the one returned to the caller of %New method.

• 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.


Copyright (c) 2019 by InterSystems Corporation. Cambridge, Massachusetts, U.S.A. All rights reserved. Confidential property of InterSystems Corporation.