Package velox.api.layer1.messages
package velox.api.layer1.messages
-
ClassDescriptionYou can control instruments shown in bookmap subscription dialog using this message.The rounding rule applied when converting cross-instrument trading order parameters (such as bracket and trailing stop offsets) from the host instrument to the target instrument.Received by add-ons and providers when cross-trading starts/stops through
Layer1ApiAdminListener.onUserMessage(Object)for add-ons and throughLayer1ApiAdminProvider.sendUserMessage(Object)for providers.NOTE: any event class can not be used by multiple generatorsIS USED ONLY IN THE EMBEDDED Is received by providers throughLayer1ApiAdminProvider.sendUserMessage(Object)when account info from embedded client needs to be converted intoAccountInfo.idthat the adapter sent before usingTradingAccountsInfoMessage.Provider should send the callback usingLayer1ApiAdminListener.onUserMessage(Object)if the account was not found by providedLayer1ApiAccountIdConvertMessage.additionalAccountInfoIs received by providers when sending additional login data throughLayer1ApiAdminProvider.sendUserMessage(Object).WORKS ONLY IN THE EMBEDDED The request that is sent by provider throughLayer1ApiAdminListener.onUserMessage(Object)if it needs some additioanl login data.Use this message to send GUI panels for configuration ofLayer1ApiSoundAlertMessage's, created by your addon (specified viaLayer1ApiAlertGuiMessage.source).Bookmap sends this message to the addon, if a user changed alert settings via GUI.The same asLayer1ApiAliasAwareUserMessage, but only for messages that are related to trading.Interface for any user messages (sent viaLayer1ApiAdminProvider.sendUserMessage(java.lang.Object)or viaLayer1ApiAdminListener.onUserMessage(java.lang.Object)) that are aware of instrument alias.Broadcast to add-ons when the Brackets settings in the Trading Control Panel change.Requests to cancel all working orders for the instrument, like pressing "Cancel All" in the Trading Control Panel.Requests to cancel all working sell (ask) orders for the instrument, like pressing "Cancel Asks" in the Trading Control Panel.Requests to cancel all working buy (bid) orders for the instrument, like pressing "Cancel Bids" in the Trading Control Panel.Request to change the selected account in the Trading Control Panel.
Send viaLayer1ApiAdminProvider.sendUserMessage(Object)Deprecated.The mode to be enabled or disabled in the Trade Control PanelBroadcast to add-ons when the cross-instrument trading rounding rule in the Trading Control Panel changes.Broadcast to add-ons when the cross-instrument trading target in the Trading Control Panel changes.Requests to flatten (close) the current position for the instrument, like pressing "Flatten" in the Trading Control Panel.Request for alias generation based on symbol, exchange, type.Request to obtain the current Brackets settings from the Trading Control Panel.
Send viaLayer1ApiAdminProvider.sendUserMessage(Object)Holds the current brackets state returned via the consumer callback.Request to obtain the current cross-instrument trading rounding rule from the Trading Control Panel.
Send viaLayer1ApiAdminProvider.sendUserMessage(Object)Holds the current cross-instrument trading rounding rule returned via the consumer callback.Request to obtain the current cross-instrument trading target from the Trading Control Panel.
Send viaLayer1ApiAdminProvider.sendUserMessage(Object)Holds the current cross-instrument trading target returned via the consumer callback.Request to obtain the current OCO (One-Cancels-Other) state from the Trading Control Panel.
Send viaLayer1ApiAdminProvider.sendUserMessage(Object)Holds the current OCO state returned via the consumer callback.Request to obtain the current Order Duration from the Trading Control Panel.
Send viaLayer1ApiAdminProvider.sendUserMessage(Object)Holds the current order duration returned via the consumer callback.Request to obtain the current Order Size from the Trading Control Panel.
Send viaLayer1ApiAdminProvider.sendUserMessage(Object)Holds the current order size returned via the consumer callback.Request to obtain the current "reset order size after each trade" checkbox state from the Trading Control Panel.
Send viaLayer1ApiAdminProvider.sendUserMessage(Object)Holds the current "reset order size after each trade" checkbox state returned via the consumer callback.Request to obtain the current Stop Order Duration from the Trading Control Panel.
Send viaLayer1ApiAdminProvider.sendUserMessage(Object)Holds the current stop order duration returned via the consumer callback.Request to obtain the current Stop Order (stop-limit) price offset from the Trading Control Panel.
Send viaLayer1ApiAdminProvider.sendUserMessage(Object)Holds the current stop order (stop-limit) price offset returned via the consumer callback.Request to obtain the current Stop Order type from the Trading Control Panel.
Send viaLayer1ApiAdminProvider.sendUserMessage(Object)Holds the current stop order type returned via the consumer callback.Addon sends this message to getLayer1ApiGetStrategyUiConfig.StrategyUiConfig.Request to obtain the current Trailing Stop settings from the Trading Control Panel.
Send viaLayer1ApiAdminProvider.sendUserMessage(Object)Holds the current trailing stop state returned via the consumer callback.Base type for the "get current value" messages that read a single control from the Trading Control Panel.
Send viaLayer1ApiAdminProvider.sendUserMessage(Object)Marker interface for the immutable state snapshots returned by theLayer1ApiGetUiValueMessagesubclasses.Historical data for this alias have been loaded
If any data (like sum of trades at time) was cached for this instrument, it may not be valid nowUsed to mark classes that are not required to be intercepted before reaching lower (provider) end of the chain.Is used for statistics onlyDownstream user message sent to provider to ask about trading support for the specific instrument.Sent toLayer1ApiAdminListener.onUserMessage(Object)for addons.Broadcast to add-ons when the OCO (One-Cancels-Other) state in the Trading Control Panel changes.Broadcast to add-ons when the Order Duration in the Trading Control Panel changes.Order data for this alias have been reloaded (can happen in SIM or REPLAY mode)
If any order data was cached, it may not be valid nowBroadcast to add-ons when the Order Size in the Trading Control Panel changes.Notify bookmap that previous order sent withSimpleOrderSendParameters.closingPositionHintwas processed successfullyProviders time will be sent using CurrentTimeUserMessage at least as often as specified by interval There is one exception: if system was in sleep mode or system time was changed while bookmap was working, some events might be skipped, and event withCurrentTimeUserMessage.isEventsSkipped= true flag will be sentBroadcast to add-ons when the "reset order size after each trade" checkbox in the Trading Control Panel changes.Requests to reverse the current position for the instrument, like pressing "Reverse" in the Trading Control Panel.Request to change the Brackets settings in the Trading Control Panel.
Send viaLayer1ApiAdminProvider.sendUserMessage(Object)Request to change the cross-instrument trading rounding rule in the Trading Control Panel.
Send viaLayer1ApiAdminProvider.sendUserMessage(Object)Request to change the cross-instrument trading target in the Trading Control Panel.
Send viaLayer1ApiAdminProvider.sendUserMessage(Object)Request to enable or disable OCO (One-Cancels-Other) in the Trading Control Panel.
Send viaLayer1ApiAdminProvider.sendUserMessage(Object)Request to change the Order Duration in the Trading Control Panel.
Send viaLayer1ApiAdminProvider.sendUserMessage(Object)Requests to change the order size in the Trading Control Panel.Request to change the Stop Order Duration in the Trading Control Panel.
Send viaLayer1ApiAdminProvider.sendUserMessage(Object)Request to change the Stop Order (stop-limit) price offset in the Trading Control Panel.
Send viaLayer1ApiAdminProvider.sendUserMessage(Object)Request to change the Stop Order type in the Trading Control Panel.
Send viaLayer1ApiAdminProvider.sendUserMessage(Object)Request to change the Trailing Stop settings in the Trading Control Panel.
Send viaLayer1ApiAdminProvider.sendUserMessage(Object)Show alert panel to user if it's currently not shownShow bottom panel to user if it's currently not shownShow shortcut panel to user if it's currently not shownCancels all messages that are currently pending, that match filter.Use this message to declare your addon intents of sending alerts to a user.This message triggers Bookmap to show a notification/play sound alert.Builder to buildLayer1ApiSoundAlertMessage.Broadcast to add-ons when the Stop Order Duration in the Trading Control Panel changes.Broadcast to add-ons when the Stop Order (stop-limit) price offset in the Trading Control Panel changes.Broadcast to add-ons when the Stop Order type in the Trading Control Panel changes.Request to freeze time temporarily.The response, which can be received viaLayer1ApiTradingMessageWithCallback.TradingMessageResponseListenerIs used to receive aLayer1ApiTradingMessageWithCallback.ResponseafterLayer1ApiTradingMessageWithCallbackwas processedBroadcast to add-ons when the Trailing Stop settings in the Trading Control Panel change.Base type for the notifications broadcast to add-ons whenever a control in the Trading Control Panel changes value.
Delivered to add-ons viaLayer1ApiAdminListener.onUserMessage(Object).Used to add/remove custom update generators
Important: usesendUserMessagewhen sending fromLayer1Attachable,Layer1SimpleAttachableorLayer1Injectablebut useonUserMessagefromLayer1UpstreamDataEditor
When generator is added with this message, custom events will be generated for past history - this can take some time.Adds new action to dropdown menu for every instrument in ControlGuiDeprecated.for a few reasons: it's not safe to use without user code wrapping and seems not used by any add-on developers, so it's not supported any moreDescribes single menu item that is created by this messageCan be used to print some text over chart with optional close icon
If message withLayer1ApiUserMessageNotification.idwas already present, displayed message will be updated
Messages need to be removed with this message (note that you need to do this in response for close icon pressed as well)This message is generated after a reading of catch up data is finished.For all opened dialogs with strategies settings, GUI elements will be reloadedThis message requests account selection.Message that is sent viaLayer1ApiAdminListener.onUserMessage(Object), when the user changes the selected trading account in the GUI on TCP (Trading Control Panel).Message containing an account info for one of the accounts of the instrument.Message should implement this interface if it wants to update an existing custom indicatorStrategy will receive this message with it's target class specified when it is added and can start sending messages
(message.getClass() == (strategy class).class) should return true if it is target of the message
Note that there can be many messages of this type that are not related to your classWhen rewind happens this message will be sentDeprecated.
It is deprecated because of new multi-account concept.