PageMessage (Analytics for Java (Core) 3.2.0 API)

java.lang.Object

com.segment.analytics.messages.PageMessage

All Implemented Interfaces:: Message

public abstract class PageMessage
extends Object
implements Message

The page call lets you record whenever a user sees a page of your website, along with any properties about the page.

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

See Also:: Page

Nested Class Summary

Nested Classes

Modifier and Type Class Description

static class PageMessage.Builder
Fluent API for creating PageMessage instances.

Nested classes/interfaces inherited from interface com.segment.analytics.messages.Message
Message.Type
Constructor Summary

Constructors

Constructor Description

PageMessage()

Method Summary

Modifier and Type	Method	Description
`static PageMessage.Builder`	`builder(String name)`	Start building an `PageMessage` instance.
`abstract String`	`category()`
`abstract String`	`name()`
`abstract Map<String,?>`	`properties()`
`PageMessage.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, timestamp, type, userId

Constructor Details
- PageMessage
  
  public PageMessage()
Method Details
- builder
  
  public static PageMessage.Builder builder(String name)
  
  Start building an PageMessage instance.
  
  Parameters:
  
  name - The name of the page the user is on.
  
  Throws:
  
  IllegalArgumentException - if the page name is null or empty
  
  See Also:
  
  Page
- name
  
  public abstract String name()
- properties
  
  @Nullable public abstract Map<String,?> properties()
- category
  
  @Nullable public abstract String category()
- toBuilder
  
  public PageMessage.Builder toBuilder()