Refinitiv Data Library for TypeScript

Session.Platform.Definition

Summary

This method returns a definition of the session. This definition holds all the parameters that define the session to be created. Once the session defined, a call to the getSession() method actually creates and returns the session. PlatformSessions are used to connect applications directly to the Refinitiv Data Platform or to a Refinitiv Real-Time Distribution System.

Methods

Definition(params: PlatformSessionParams)

PlatformSessionParams properties

Property Is Optional Default Value Type Description
appKey No - string RDP Application key necessary to authenticate the specific application for the session
username No - string OAuth username
password No - string OAuth password
scope Yes trapi string Defines limits the scope of RDP data services for this sign on session
takeSignOnControl Yes No boolean Defines whether the request for authorization will take control over any existing sign-on sessions for this user
dacs Yes - Dacs[] Streaming connection specification
host No - string Local streaming service host

dacs: Dacs

Property Is Optional Default Value Type Description
applicationId Yes 256 string The ID of application connecting in
username Yes machine login ID string Username used for the streaming connection
position Yes local IP address string The IP address position of the application logging in

Returned value: a new instance of SessionDefinition.

Example of usage

import { Session } from '@refinitiv-data/data';

const platformSession = Session.Platform.Definition({
    appKey: 'appKey',
    userName: 'user',
    password: 'password',
    host: '0.0.0.0:0000',
    takeSignOnControl: true
}).getSession();

await platformSession.open();