- Introduction
- Concepts and Design
-
SESSION LAYER
- About the Session Layer
-
Session
- Session object
-
Session object methods
-
Session.Platform.Definition
- Session.Platform.Definition object
-
Session.Platform.Definition methods
-
Session.Desktop.Definition
- Session.Desktop.Definition object
-
Session.Desktop.Definition methods
-
Session.Container.Definition
- Session.Container.Definition object
-
Session.Container.Definition methods
-
Functions
- Session events
- Session event codes
- Session states
-
CONTENT LAYER
- About the Content Layer
-
Fundamental and Reference
- About Fundamental and Reference
-
FundamentalAndReference.Definition
- FundamentalAndReference.Definition object
-
FundamentalAndReference.Definition methods
- FundamentalAndReference.RowHeaders
-
Historical Pricing
- About Historical Pricing
-
Historical Pricing Events
- About Historical Pricing Events
-
HistoricalPricing.Events.Definition
- HistoricalPricing.Events.Definition object
-
HistoricalPricing.Events.Definition methods
-
Historical Pricing Summaries
- About Historical Pricing Summaries
-
HistoricalPricing.Events.Definition
- HistoricalPricing.Summaries.Definition object
-
HistoricalPricing.Summaries.Definition methods
- Event Types
- Adjustments
- Market Sessions
-
News
- About News
-
News Headlines
- About News Headlines
-
News.Headlines.Definition
- News.Headlines.Definition object
-
News.Headlines.Definition methods
-
News Story
- About News Story
-
News.Story.Definition
- News.Story.Definition object
-
News.Story.Definition methods
-
Pricing
- About Pricing
-
Pricing.Definition
- Pricing.Definition object
-
Pricing.Definition methods
-
Pricing.Stream
- Pricing.Stream object
-
Pricing.Stream methods
- Pricing.StreamEvents
-
Pricing.Chain
- About Pricing.Chain
-
Pricing.Chain.Definition
- Pricing.Chain.Definition object
-
Pricing.Chain.Definition methods
-
Pricing.Chain.Stream
- Pricing.Chain.Stream object
-
Pricing.Chain.Stream methods
- Pricing.Chain.Events
-
Search
- About Search
-
Search.Definition
- Search.Definition object
-
Search.Definition methods
- Search View
-
SymbolConversion
- About SymbolConversion
-
SymbolConversion.Definition
- SymbolConversion.Definition object
-
SymbolConversion.Definition methods
- Asset Class
- Asset State
- Country Code
-
DELIVERY LAYER
onRefresh
Attaches an event handler function to the stream, which will be called when the stream is refreshed by the server.
Syntax
stream.onRefresh(callback: Pricing.StreamRefreshCallback)
Parameters
Value | Description | Data type | Optional | Default value |
---|---|---|---|---|
callback | Pricing.StreamRefreshCallback function (see Pricing.StreamEvent ) |
function | No | - |
Returned value
Pricing.Stream
object
Usage
The following example demonstrates how to display messages received when the stream is refreshed by the platform or it was opened successfully
const stream = Pricing.Definition(['EUR=']).getStream();
await stream
.onRefresh((refresh, instrument) => console.log(instrument, refresh))
.open();
Related links
None.