Session.Platform.Definition object
Creates a definition object for the platform session.
This method returns a definition of the platform 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.
Platform sessions are used to connect applications directly to the Refinitiv Data Platform or to a Refinitiv Real-Time Distribution System.
Syntax
Session.Platform.Definition(params: Session.PlatformSessionParams)
Parameters
An object literal that can include the below-listed properties:
Value | Description | Data type | Optional | Default value |
---|---|---|---|---|
appKey | RDP application key, necessary to authenticate the specific application for the session | string | No | - |
username | OAuth username | string | No | - |
password | OAuth password | string | No | - |
scope | Defines limits the scope of RDP data services for this sign on session | string | Yes | trapi |
takeSignOnControl | Defines whether the request for authorization takes control over any existing sign-on sessions for this user | boolean | Yes | false |
dacs | Streaming connection specification | object | Yes | - |
host | Local streaming service host | number | Yes | - |
dacs: Dacs
Value | Description | Data type | Optional | Default value |
---|---|---|---|---|
applicationId | The ID of the connecting application | string | Yes | 256 |
username | Username used for the streaming connection | string | Yes | machine login ID |
position | The IP address position of the logging application | string | Yes | local IP address or 127.0.0.1 |
Returned value
A new instance of Session.Definition
.
Usage
The following example demonstrates how to create a Definition object for platform session.
import { Session } from '@refinitiv-data/data';
const definition = Session.Platform.Definition({
appKey: 'appKey',
userName: 'user',
password: 'password',
takeSignOnControl: true
});
Related links
None.