com.segment.analytics

Class Options

java.lang.Object

com.segment.analytics.Options

public class Options
extends java.lang.Object

Options let you control behaviour for a specific analytics action, including setting a custom timestamp and disabling integrations on demand.

Field Summary

Fields

Modifier and Type	Field and Description
static java.lang.String	ALL_INTEGRATIONS_KEY A special key, whose value which is respected for all integrations, a "default" value, unless explicitly overridden.

Constructor Summary

Constructors

Constructor and Description
Options()

Method Summary

Modifier and Type	Method and Description
java.util.Map<java.lang.String,java.lang.Object>	context() Returns a copy of the context.
java.util.Map<java.lang.String,java.lang.Object>	integrations() Returns a copy of settings for integrations.
Options	putContext(java.lang.String key, java.lang.Object value) Attach some additional context information.
Options	setIntegration(Analytics.BundledIntegration bundledIntegration, boolean enabled) Sets whether an action will be sent to the target integration.
Options	setIntegration(java.lang.String integrationKey, boolean enabled) Sets whether an action will be sent to the target integration.
Options	setIntegrationOptions(Analytics.BundledIntegration bundledIntegration, java.util.Map<java.lang.String,java.lang.Object> options) Attach some integration specific options for this call.
Options	setIntegrationOptions(java.lang.String integrationKey, java.util.Map<java.lang.String,java.lang.Object> options) Attach some integration specific options for this call.

Methods inherited from class java.lang.Object

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

Field Detail

ALL_INTEGRATIONS_KEY

public static final java.lang.String ALL_INTEGRATIONS_KEY

A special key, whose value which is respected for all integrations, a "default" value, unless explicitly overridden. See the documentation for setIntegration(String, boolean) on how to use this key.

See Also:

Constant Field Values

Constructor Detail

Options

public Options()

Method Detail

setIntegration

public Options setIntegration(java.lang.String integrationKey,
                              boolean enabled)

Sets whether an action will be sent to the target integration.

By default, all integrations are sent a payload, and the value for the ALL_INTEGRATIONS_KEY is true. You can disable specific payloads.

Example: options.setIntegration("Google Analytics", false).setIntegration("Countly", false) will send the event to ALL integrations, except Google Analytic and Countly.

If you want to enable only specific integrations, first override the defaults and then enable specific integrations.

Example: options.setIntegration(Options.ALL_INTEGRATIONS_KEY, false).setIntegration("Countly", true).setIntegration("Google Analytics", true) will only send events to ONLY Countly and Google Analytics.

Parameters:

integrationKey - The integration key

enabled - true for enabled, false for disabled

Returns:

This options object for chaining

setIntegration

public Options setIntegration(Analytics.BundledIntegration bundledIntegration,
                              boolean enabled)

Sets whether an action will be sent to the target integration. Same as setIntegration(String, boolean) but type safe for bundled integrations.

Parameters:

bundledIntegration - The target integration

enabled - true for enabled, false for disabled

Returns:

This options object for chaining

See Also:

setIntegration(String, boolean)

setIntegrationOptions

public Options setIntegrationOptions(java.lang.String integrationKey,
                                     java.util.Map<java.lang.String,java.lang.Object> options)

Attach some integration specific options for this call.

Parameters:

integrationKey - The target integration key

options - A map of data that will be used by the integration

Returns:

This options object for chaining

setIntegrationOptions

public Options setIntegrationOptions(Analytics.BundledIntegration bundledIntegration,
                                     java.util.Map<java.lang.String,java.lang.Object> options)

Attach some integration specific options for this call. Same as setIntegrationOptions(String, Map) but type safe for bundled integrations.

Parameters:

bundledIntegration - The target integration

options - A map of data that will be used by the integration

Returns:

This options object for chaining

putContext

public Options putContext(java.lang.String key,
                          java.lang.Object value)

Attach some additional context information. Unlike with Analytics.getAnalyticsContext(), this only has effect for this call.

Parameters:

key - The key of the extra context data

value - The value of the extra context data

Returns:

This options object for chaining

integrations

public java.util.Map<java.lang.String,java.lang.Object> integrations()

Returns a copy of settings for integrations.

context

public java.util.Map<java.lang.String,java.lang.Object> context()

Returns a copy of the context.