Session.Container.Definition Object
Creates a definition object for a container session.
This method returns a definition of the container session. This definition holds all the parameters that define the session to be created. Once the session is defined, a call to the getSession() method creates and returns the session.
ContainerSessions are generally used by apps that run within the Workspace application or in the same browser as the Workspace for Web.
Syntax
Session.Container.Definition(params: string | Session.ContainerSessionParams)
Parameters
Either appKey: string that could be passed as a single parameter, or an object literal that can include the below-listed properties:
| Value | Description | Data type | Optional | Default value |
|---|---|---|---|---|
| appKey | Workspace application key, necessary to authenticate the specific application with the session | string | No | - |
| bus | Specific transport to be used to transmit all the data using ContainerSession | object | Yes | JET |
| scope | Defines limits the scope of Refinitiv data services for this sign on session | string | Yes | trapi |
Returned value
A new instance of Session.Definition.
Usage
The following example demonstrates how to create a Definition object for container session.
import { Session } from '@refinitiv-data/data';
const definition = Session.Container.Definition('appKey');
const session = definition.getSession();Related links
None.