ScreenMessage (Analytics for Java (Core) 3.5.1 API)

java.lang.Object
- com.segment.analytics.messages.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

Nested Class Summary

Nested Classes
Modifier and Type Class Description

static class ScreenMessage.Builder
Fluent API for creating ScreenMessage instances.
- Nested classes/interfaces inherited from interface com.segment.analytics.messages.Message
  Message.Type

Constructor Summary

Constructors
Constructor Description

ScreenMessage()

Method Summary

All Methods Static Methods Instance Methods Abstract Methods Concrete Methods
Modifier and Type	Method	Description
`static ScreenMessage.Builder`	`builder(java.lang.String name)`	Start building an `ScreenMessage` instance.
`abstract java.lang.String`	`name()`
`abstract java.util.Map<java.lang.String,?>`	`properties()`
`ScreenMessage.Builder`	`toBuilder()`

Methods inherited from class java.lang.Object
clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Methods inherited from interface com.segment.analytics.messages.Message
anonymousId, context, integrations, messageId, sentAt, timestamp, type, userId

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()

toBuilder

public ScreenMessage.Builder toBuilder()