Class ScreenMessage

  • All Implemented Interfaces:
    Message

    public abstract class ScreenMessage
    extends java.lang.Object
    implements Message
    The screen call lets you record whenever a user sees a screen, along with any properties about the screen.

    Use builder(java.lang.String) to construct your own instances.

    See Also:
    Screen
    • Constructor Detail

      • ScreenMessage

        public ScreenMessage()
    • Method Detail

      • builder

        public static ScreenMessage.Builder builder​(java.lang.String name)
        Start building an ScreenMessage instance.
        Parameters:
        name - The name of the screen the user is on.
        Throws:
        java.lang.IllegalArgumentException - if the screen name is null or empty
        See Also:
        Name
      • name

        public abstract java.lang.String name()
      • properties

        @Nullable
        public abstract java.util.Map<java.lang.String,​?> properties()