Package velox.api.layer1.messages

Class Layer1ApiSoundAlertDeclarationMessage

java.lang.Object
velox.api.layer1.messages.Layer1ApiSoundAlertDeclarationMessage
All Implemented Interfaces:
Layer1ApiStrategiesEchoMessagesLayer.StrategyEchoMessageFromLayer
public class Layer1ApiSoundAlertDeclarationMessage
extends java.lang.Object
implements Layer1ApiStrategiesEchoMessagesLayer.StrategyEchoMessageFromLayer

Use this message to declare your addon intents of sending alerts to a user. The class specifies a "blueprint" of future alerts group. Send created message via Layer1ApiAdminProvider.sendUserMessage(Object), and link the declaration message to an alert via Layer1ApiSoundAlertMessage.alertDeclarationId

The Bookmap caches these messages internally, and if your Layer1ApiSoundAlertMessage with a linked Layer1ApiSoundAlertDeclarationMessage does not conform the fields specified in the declaration message - an exception will be thrown, and your addon will be unloaded.

When a user removes a declaration from GUI - your addon will receive this message with flag isAdd = false That is, your addon needs to listen for these messages using Layer1ApiAdminListener.onUserMessage(Object)

See Also:
Layer1ApiSoundAlertMessage

  • Field Details

    • ALIAS_MATCH_ALL

      public static final java.util.function.Predicate<java.lang.String> ALIAS_MATCH_ALL
      Use it as the aliasMatcher value, to indicate that the current declaration is linked to all available aliases

    • id

      public final java.lang.String id
      Id can be used to reference this declaration message

    • triggerDescription

      public final java.lang.String triggerDescription
      Short description of the trigger event for this declaration. Will be shown on the UI

    • source

      public final java.lang.Class<?> source
      Class that created this message. The class must have Layer1StrategyName annotation present

    • strategyName

      public final java.lang.String strategyName
      Name of the strategy that created this message, extracted from Layer1StrategyName.value(), displayed on the UI

    • aliasMatcher

      public final java.util.function.Predicate<java.lang.String> aliasMatcher
      The predicate obtains an instrument alias. If it returns true, the declaration is believed to be linked to the specified alias. Used internally for declarations filtration on the UI

    • isPopupAllowed

      public final boolean isPopupAllowed
      Define whether an alert can have a popup notification
      The actual state of the popup notification (on/off) is defined with Layer1ApiAlertSettingsMessage.popup

    • isSoundAllowed

      public final boolean isSoundAllowed
      Define whether an alert can have a sound notification
      The actual state of the sound notification (on/off) is defined with Layer1ApiAlertSettingsMessage.sound

    • isRepeated

      public final boolean isRepeated
      True if alerts described by this declaration are repeated - Layer1ApiSoundAlertMessage.repeatCount > 1

    • isAdd

      public final boolean isAdd
      True if this message adds a declaration. Otherwise, the declaration with the same id will be removed

  • Method Details