com.amazonaws.mobileconnectors.amazonmobileanalytics

Class AnalyticsConfig

java.lang.Object

com.amazonaws.mobileconnectors.amazonmobileanalytics.AnalyticsConfig

public class AnalyticsConfig
extends Object

The AnalyticsConfig class allows developers to configure out Amazon Mobile Analytics behaves. It includes enabling/disabling the sending of events, so developers can easily develop applications that allow end-users to opt-in/opt-out of analytics collections. By default it allows events to only be sent over WIFI, but can be set to allow events to be sent over the mobile network. Finally developers can set any networking behavior that a low-level AWS client can change through a ClientConfiguration object.

Constructor Summary

Constructors

Constructor and Description
AnalyticsConfig() Create an AnalyticsConfig object set to defaults.
AnalyticsConfig(ClientConfiguration clientConfiguration) Creates an AnalyticsConfig object with the specified client configuration configuration

Method Summary

Methods

Modifier and Type	Method and Description
boolean	getAllowEventCollection() Indicates whether or not event collection is enabled for the SDK.
boolean	getAllowWANDelivery() Indicates whether or not events will be sent to the Amazon Mobile Analytics website over WAN (mobile) networks.
ClientConfiguration	getClientConfiguration() Gets the client configuration this client will use when making requests.
AnalyticsConfig	withAllowsEventCollection(boolean allowEventCollection) Sets whether or not event collection is enabled for the SDK.
AnalyticsConfig	withAllowsWANDelivery(boolean allowWANDelivery) Sets whether or not events will be sent to the Amazon Mobile Analytics website over WAN (mobile) networks.
AnalyticsConfig	withClientConfiguration(ClientConfiguration clientConfig) Sets the client configuration this client will use when making request

Methods inherited from class java.lang.Object

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

Constructor Detail

AnalyticsConfig

public AnalyticsConfig()

Create an AnalyticsConfig object set to defaults. Which allows event collection and has WAN delivery set to true

AnalyticsConfig

public AnalyticsConfig(ClientConfiguration clientConfiguration)

Creates an AnalyticsConfig object with the specified client configuration configuration

Parameters:

clientConfiguration -

Method Detail

withClientConfiguration

public AnalyticsConfig withClientConfiguration(ClientConfiguration clientConfig)

Sets the client configuration this client will use when making request

Returns:

AnalyticsConfig the current instance

getClientConfiguration

public ClientConfiguration getClientConfiguration()

Gets the client configuration this client will use when making requests. If none was supplied to the constructor this will return the default client configuration.

Returns:

The ClientConfiguration used for making requests

withAllowsEventCollection

public AnalyticsConfig withAllowsEventCollection(boolean allowEventCollection)

Sets whether or not event collection is enabled for the SDK.

Parameters:

allowEventCollection -

Returns:

AnalyticsConfig the current instance

getAllowEventCollection

public boolean getAllowEventCollection()

Indicates whether or not event collection is enabled for the SDK.

Returns:

true/false indicating if event collection is enabled

withAllowsWANDelivery

public AnalyticsConfig withAllowsWANDelivery(boolean allowWANDelivery)

Sets whether or not events will be sent to the Amazon Mobile Analytics website over WAN (mobile) networks.

Parameters:

allowWANDelivery -

Returns:

AnalyticsConfig the current instance

getAllowWANDelivery

public boolean getAllowWANDelivery()

Indicates whether or not events will be sent to the Amazon Mobile Analytics website over WAN (mobile) networks.

Returns:

true indicates events will be delivered via WAN or WIFI networks. false indicates events will be delivered via WIFI network only.