Caplin Trader 4.8.0

Interface: module:caplin/trading/trademodel/TradeChannelMapper

module:caplin/trading/trademodel/TradeChannelMapper

Provides the trading channel name that Liberator uses to send messages on.

An implementation can use emitr to trigger the `channel-added` event passing in the newly added channel as an argument. This is for when an implementation might have trade channels registered to it after the `TradeMessageService` that uses the `TradeChannelMapper` has been constructed.

Super constructor for the base TradeChannelMapper implementations
Implementations:

Methods

getChannel(oTrade) → {String}

Parameters:
Name Type Description
oTrade module:caplin/trading/trademodel/Trade
Implementations:
  • module:caplin/trading/trademodel/SingleChannelTradeChannelMapper~SingleChannelTradeChannelMapper#getChannel
Returns:
the name of the channel that the specified Trade should have its messages sent on.
Type
String

getObjectList() → {String}

Implementations:
  • module:caplin/trading/trademodel/SingleChannelTradeChannelMapper~SingleChannelTradeChannelMapper#getObjectList
Returns:
a space separated list of subjects that Streamlink should subscribe to, in order to allow the channels to work.
Type
String