Package velox.api.layer1.messages

Class Layer1ApiSoundAlertMessage

java.lang.Object

velox.api.layer1.messages.Layer1ApiSoundAlertMessage

All Implemented Interfaces:

Layer1ApiStrategiesEchoMessagesLayer.StrategyEchoMessageFromLayer

public class Layer1ApiSoundAlertMessage
extends java.lang.Object
implements Layer1ApiStrategiesEchoMessagesLayer.StrategyEchoMessageFromLayer

Nested Class Summary

Nested Classes

Modifier and Type	Class	Description
static class	Layer1ApiSoundAlertMessage.Builder	Builder to build Layer1ApiSoundAlertMessage.
static class	Layer1ApiSoundAlertMessage.SoundAlertStatus
static interface	Layer1ApiSoundAlertMessage.SoundAlertStatusListener

Field Summary

Fields

Modifier and Type	Field	Description
java.lang.String	additionalInfo	If not null, this text will be shown on the alert popup below the main message, specified in textInfo.
java.lang.String	alertDeclarationId	The Layer1ApiSoundAlertDeclarationMessage.id of a linked alert declaration Note that if you specify this field, there should already exist a registered declaration with the given id.
java.lang.String	alertId	This ID can be used to reference alert later (stop it)
java.lang.String	alias	If not null the alert is considered linked to specific instrument
java.lang.Object	metadata	This field will not be used anywhere outside of strategy code, but strategy can later use this field, for example, to determine if this message should be cancelled in Layer1ApiSoundAlertCancelMessage.Layer1ApiSoundMessagesFilter.shouldCancelMessage(Layer1ApiSoundAlertMessage)
int	priority	The priority value helps to order sound messages in a sound play queue.
static long	REPEAT_COUNT_INFINITE
long	repeatCount	Number of times sound will be repeated or REPEAT_COUNT_INFINITE for infinite replay (until cancelled by user).
java.time.Duration	repeatDelay	Delay between sound repetitions.
java.awt.Image	severityIcon	If not null, the icon is shown on the alert popup.
boolean	showPopup	If true, popup will be shown containing textInfo (which must not be null)
byte[]	sound	Binary data for the sound to be played.
java.lang.Class<?>	source	Class that created this message
Layer1ApiSoundAlertMessage.SoundAlertStatusListener	statusListener
java.lang.String	textInfo	Text description of a message, will be displyed in alerts dialog

Constructor Summary

Constructors

Constructor	Description
Layer1ApiSoundAlertMessage(byte[] sound, java.lang.String textInfo, long repeatCount, java.time.Duration repeatDelay, Layer1ApiSoundAlertMessage.SoundAlertStatusListener statusListener, java.lang.Class<?> source, java.lang.Object metadata)	Deprecated.
Layer1ApiSoundAlertMessage(java.lang.String alertId)	Deprecated.

Method Summary

Modifier and Type	Method	Description
static Layer1ApiSoundAlertMessage.Builder	builder()	Creates builder to build Layer1ApiSoundAlertMessage.
boolean	isCancelMessage()	True if the message was created via Layer1ApiSoundAlertMessage(java.lang.String) constructor
java.lang.String	toString()

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, wait, wait, wait

Field Details

REPEAT_COUNT_INFINITE

public static final long REPEAT_COUNT_INFINITE

See Also:

Constant Field Values

sound

public final byte[] sound

Binary data for the sound to be played. Please do not modify array after you pass it to the message. Multiple messages can share same sound data.

textInfo

public final java.lang.String textInfo

Text description of a message, will be displyed in alerts dialog

showPopup

public final boolean showPopup

If true, popup will be shown containing textInfo (which must not be null)

repeatCount

public final long repeatCount

Number of times sound will be repeated or REPEAT_COUNT_INFINITE for infinite replay (until cancelled by user).

repeatDelay

public final java.time.Duration repeatDelay

Delay between sound repetitions.

alertId

public final java.lang.String alertId

This ID can be used to reference alert later (stop it)

statusListener

public final Layer1ApiSoundAlertMessage.SoundAlertStatusListener statusListener

source

public final java.lang.Class<?> source

Class that created this message

metadata

public final java.lang.Object metadata

This field will not be used anywhere outside of strategy code, but strategy can later use this field, for example, to determine if this message should be cancelled in Layer1ApiSoundAlertCancelMessage.Layer1ApiSoundMessagesFilter.shouldCancelMessage(Layer1ApiSoundAlertMessage)

alias

public final java.lang.String alias

If not null the alert is considered linked to specific instrument

alertDeclarationId

public final java.lang.String alertDeclarationId

The Layer1ApiSoundAlertDeclarationMessage.id of a linked alert declaration
Note that if you specify this field, there should already exist a registered declaration with the given id. Also, the fields of the declaration and its linked alerts are checked for conformity, e. g. for a declaration with Layer1ApiSoundAlertDeclarationMessage.popup = true
you cannot link an alert message with showPopup = false

priority

public final int priority

The priority value helps to order sound messages in a sound play queue. If there are 2 or more messages waiting in a queue, the message with higher priority will be handled first. Order of handling messages with equal priority is not guaranteed. Default is 0

additionalInfo

public final java.lang.String additionalInfo

If not null, this text will be shown on the alert popup below the main message, specified in textInfo. This field is optional

severityIcon

public final java.awt.Image severityIcon

If not null, the icon is shown on the alert popup. You can add your own image or use the defaults from the Layer1DefaultAlertIcons
Default value is null

Constructor Details

Layer1ApiSoundAlertMessage

@Deprecated public Layer1ApiSoundAlertMessage(byte[] sound, java.lang.String textInfo, long repeatCount, java.time.Duration repeatDelay, Layer1ApiSoundAlertMessage.SoundAlertStatusListener statusListener, java.lang.Class<?> source, java.lang.Object metadata)

Deprecated.

Creates a message that will launch an alert. Use Layer1ApiSoundAlertMessage.Builder instead.

Layer1ApiSoundAlertMessage

@Deprecated public Layer1ApiSoundAlertMessage(java.lang.String alertId)

Deprecated.

Creates a message that will stop an alert with specified alertId

Method Details

isCancelMessage

public boolean isCancelMessage()

True if the message was created via Layer1ApiSoundAlertMessage(java.lang.String) constructor

Returns:

flag if the message is actually a cancel message

toString

public java.lang.String toString()

Overrides:

toString in class java.lang.Object

builder

public static Layer1ApiSoundAlertMessage.Builder builder()

Creates builder to build Layer1ApiSoundAlertMessage.

Returns:

created builder