com.github.segmentio.models

Class Options

java.lang.Object

com.github.segmentio.models.Options

public class Options
extends Object

Options object that allows the specification of a timestamp, an anonymousId, a context, or target integrations.

Constructor Summary

Constructors

Constructor and Description
Options()

Method Summary

Modifier and Type	Method and Description
String	getAnonymousId()
Context	getContext()
Props	getIntegrations()
org.joda.time.DateTime	getTimestamp()
Options	setAnonymousId(String anonymousId) Sets the cookie / anonymous Id of this visitor.
Options	setContext(Context context) Sets the context of this analytics call.
Options	setIntegration(String integration, boolean enabled) Sets whether this call will be sent to the target integration.
Options	setTimestamp(org.joda.time.DateTime timestamp) Sets the timestamp of when an analytics call occurred.

Methods inherited from class java.lang.Object

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

Constructor Detail

Options

public Options()

Method Detail

setAnonymousId

public Options setAnonymousId(String anonymousId)

Sets the cookie / anonymous Id of this visitor. Use the anonymous Id to associate the actions previously taken by the cookied but anonymous user.

Parameters:

anonymousId -

Returns:

This options object for chaining

setIntegration

public Options setIntegration(String integration,
                              boolean enabled)

Sets whether this call will be sent to the target integration. Use "all" to select all integrations, like so: .setIntegration("all", false) .setIntegration("Google Analytics", true)

Parameters:

integration - The integration name

enabled - True for enabled

Returns:

This options object for chaining

setContext

public Options setContext(Context context)

Sets the context of this analytics call. Context contains information about the environment such as the app name and version, the visitor's user agent, ip, etc ..

Parameters:

context - The context object

Returns:

This options object for chaining

setTimestamp

public Options setTimestamp(org.joda.time.DateTime timestamp)

Sets the timestamp of when an analytics call occurred. The timestamp is primarily used for historical imports or if this event happened in the past. The timestamp is not required, and if its not provided, our servers will timestamp the call as if it just happened.

Parameters:

timestamp - The time when this event happened

Returns:

This options object for chaining

getContext

public Context getContext()

getAnonymousId

public String getAnonymousId()

getIntegrations

public Props getIntegrations()

getTimestamp

public org.joda.time.DateTime getTimestamp()