Enumeration DataSessionInterfaceSignal

The DataSessionInterfaceSignal lists all the signals that may be sent by the DataSessionInterface.

These signals are emitted by the DataSessionInterface when

• the data session has finished loading (DMULoadingFailed and DMULoadingSuccess).
• A message from the server has been received (MessageReceived).
• The data session is actually closed (after a call to closeDataSession) (DataSessionClosed)
• The idle system has changed its state (DataSessionReactivated,IdleWarningDataSession, IdleDataSession).

The data session is opened following the given sequence :

The idle system is in charge to close the database after a while when no user interactions have been detected. It is composed of three pseudo-states : * Normal : the user is interacting regularly with the system. * Warning : the user has not interacted with the system from some time (2/3 of the idle duration as configured in the architecture). * Idle : the server resources have been cleaned up, the session is closed with no possibility to resume or recover. This state happens after the "warning" state.

The idle system.

/** 
 * Sample to illustrate the use of the open data session procedure with the DataSessionInterface.
 */
import { DataSessionInterface, DataSessionInterfaceSignal, DirectorySessionInterface, InfiniteCacheInterface, tListenerCallback } from 'generated/documentation/appinfiniteapi';

// callbacks called when IdleDataSession, DataSessionClosed, DMULoadingSuccess and DMULoadingFailed events are triggered
let onInactivityDetection : tListenerCallback;
let onCloseDBSuccess : tListenerCallback;
let onDMULoaded : tListenerCallback;
let onOpenDBFailed : tListenerCallback;

// the id of the build to open (retrieved previously)
let sBuildId : string;
// the optional cache (may be created previously)
let lCache : InfiniteCacheInterface | undefined;
// the directory session should have been created previously
let lDirectorySession : DirectorySessionInterface;

const lDataSession : DataSessionInterface | undefined = lDirectorySession.createDataSession(sBuildId, lCache);
// open the database
if (lDataSession)
{
    // do something with your GUI
    // ...
    // when the data session is closed due to inactivity
    lDataSession.addEventListener(DataSessionInterfaceSignal.IdleDataSession, onInactivityDetection);
    // when the data session is closed
    lDataSession.addEventListener(DataSessionInterfaceSignal.DataSessionClosed, onCloseDBSuccess);
    // when the data session has retrieved all required data
    lDataSession.addEventListener(DataSessionInterfaceSignal.DMULoadingSuccess, onDMULoaded);
    // if unfortunately something went wrong with the loading 		
    lDataSession.addEventListener(DataSessionInterfaceSignal.DMULoadingFailed, onOpenDBFailed);
    // and trigger the data session loading
    lDataSession.openDataSession();
}

Please refer to the [DataSessionInterface](../interfaces/DataSessionInterface.html) for more information.

See

• DataSessionInterface
• MessageInterface