com.segment.analytics

Class Analytics.Builder

java.lang.Object

com.segment.analytics.Analytics.Builder

Enclosing class:

Analytics

public static class Analytics.Builder
extends java.lang.Object

Fluent API for creating Analytics instances.

Constructor Summary

Constructors

Constructor and Description
Builder(android.content.Context context, java.lang.String writeKey) Start building a new Analytics instance.

Method Summary

Modifier and Type	Method and Description
Analytics	build() Create a Analytics client.
Analytics.Builder	collectDeviceId(boolean collect) Enable or disable collection of Settings.Secure.ANDROID_ID, Build.SERIAL or the Telephony Identifier retreived via TelephonyManager as available.
Analytics.Builder	connectionFactory(ConnectionFactory connectionFactory) Specify the connection factory for customizing how connections are created.
Analytics.Builder	defaultOptions(Options defaultOptions) Set some default options for all calls.
Analytics.Builder	disableBundledIntegrations() Deprecated. As of 3.0.1, this method does nothing.
Analytics.Builder	flushInterval(long flushInterval, java.util.concurrent.TimeUnit timeUnit) Set the interval at which the client should flush events.
Analytics.Builder	flushQueueSize(int flushQueueSize) Set the queue size at which the client should flush events.
Analytics.Builder	logLevel(Analytics.LogLevel logLevel) Set a Analytics.LogLevel for this instance.
Analytics.Builder	networkExecutor(java.util.concurrent.ExecutorService networkExecutor) Specify the executor service for making network calls in the background.
Analytics.Builder	tag(java.lang.String tag) Set a tag for this instance.

Methods inherited from class java.lang.Object

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

Constructor Detail

Builder

public Builder(android.content.Context context,
               java.lang.String writeKey)

Start building a new Analytics instance.

Method Detail

flushQueueSize

public Analytics.Builder flushQueueSize(int flushQueueSize)

Set the queue size at which the client should flush events. The client will automatically flush events to Segment when the queue reaches flushQueueSize.

Throws:

java.lang.IllegalArgumentException - if the flushQueueSize is less than or equal to zero.

flushInterval

public Analytics.Builder flushInterval(long flushInterval,
                                       java.util.concurrent.TimeUnit timeUnit)

Set the interval at which the client should flush events. The client will automatically flush events to Segment every flushInterval duration, regardless of flushQueueSize.

Throws:

java.lang.IllegalArgumentException - if the flushInterval is less than or equal to zero.

collectDeviceId

public Analytics.Builder collectDeviceId(boolean collect)

Enable or disable collection of Settings.Secure.ANDROID_ID, Build.SERIAL or the Telephony Identifier retreived via TelephonyManager as available. Collection of the device identifier is enabled by default.

defaultOptions

public Analytics.Builder defaultOptions(Options defaultOptions)

Set some default options for all calls. This will only be used to figure out which integrations should be enabled or not for actions by default.

See Also:

Options}

tag

public Analytics.Builder tag(java.lang.String tag)

Set a tag for this instance. The tag is used to generate keys for caching.

By default the writeKey is used. You may want to specify an alternative one, if you want the instances with the same writeKey to share different caches (you probably do).

Throws:

java.lang.IllegalArgumentException - if the tag is null or empty.

logLevel

public Analytics.Builder logLevel(Analytics.LogLevel logLevel)

Set a Analytics.LogLevel for this instance.

disableBundledIntegrations

@Deprecated
public Analytics.Builder disableBundledIntegrations()

Deprecated. As of 3.0.1, this method does nothing.

networkExecutor

public Analytics.Builder networkExecutor(java.util.concurrent.ExecutorService networkExecutor)

Specify the executor service for making network calls in the background.

Note: Calling Analytics.shutdown() will not shutdown supplied executors.

Use it with care! http://bit.ly/1JVlA2e

connectionFactory

public Analytics.Builder connectionFactory(ConnectionFactory connectionFactory)

Specify the connection factory for customizing how connections are created.

This is a beta API, and might be changed in the future. Use it with care! http://bit.ly/1JVlA2e

build

public Analytics build()

Create a Analytics client.