Package velox.api.layer1.messages

Class Layer1ApiAlertSettingsMessage

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

Bookmap sends this message to the addon, if a user changed alert settings via GUI. Your addon should listen for these messages via Layer1ApiAdminListener.onUserMessage(Object) and change its inner state accordingly, so the following Layer1ApiSoundAlertMessage's sent by the addon have correct settings.

Internally Bookmap stores these settings, and checks the sound alert messages for conformity with the expected settings. If they diverge, that is - a sound alert message arrived with Layer1ApiSoundAlertMessage.sound = true, while there is a settings message registered with sound = false - an exception will be thrown, and the addon will be unloaded.

Your addon can also send this message to notify Bookmap about sound alert settings changes.

See Also:
Layer1ApiSoundAlertMessage, Layer1ApiSoundAlertDeclarationMessage

  • Nested Class Summary

    Nested Classes 
    Modifier and Type Class Description
    static class  Layer1ApiAlertSettingsMessage.Builder  

  • Field Summary

    Fields 
    Modifier and Type Field Description
    java.lang.String declarationId
    The Layer1ApiSoundAlertDeclarationMessage.id of a linked alert declaration
    Note that if you specify this field, in the Bookmap there should already exist a registered declaration with the given id.
    java.lang.String id
    Id can be used to reference this message
    boolean popup
    True if the sound alerts described with a linked alert declaration have a popup notification
    boolean sound
    True if the sound alerts described with a linked alert declaration have a sound notification
    java.lang.Class<?> source
    Class that created this message.

  • Method Summary

    Modifier and Type Method Description
    static Layer1ApiAlertSettingsMessage.Builder builder()
    Creates builder to build Layer1ApiSoundAlertMessage.
    static Layer1ApiAlertSettingsMessage defaultSettings​(java.lang.String declarationId, java.lang.Class<?> source)
    Create a default settings message with popup = false and sound = false
    java.lang.String toString()  

    Methods inherited from class java.lang.Object

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

  • Field Details

    • id

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

    • declarationId

      public final java.lang.String declarationId
      The Layer1ApiSoundAlertDeclarationMessage.id of a linked alert declaration
      Note that if you specify this field, in the Bookmap there should already exist a registered declaration with the given id.

    • popup

      public final boolean popup
      True if the sound alerts described with a linked alert declaration have a popup notification

    • sound

      public final boolean sound
      True if the sound alerts described with a linked alert declaration have a sound notification

    • source

      public final java.lang.Class<?> source
      Class that created this message. Must be annotated by Layer1StrategyName

  • Method Details