com.ooyala.android.analytics.IqConfiguration Class Reference

This class configures all the IQ Analytics related information that needs to be configured with default values or customer given values. More...

Classes

class  Builder
 Builds the object of IQ Analytics configurations. More...
 

Public Member Functions

 IqConfiguration (String playerID, String analyticsJSURL, String domain, String backendEndpointURL, DeviceInfo deviceInfo, boolean useWifiOnly)
 Initialize an IqConfiguration object with all configurations. More...
 
String getPlayerID ()
 Used to retrieve the player ID. More...
 
String getAnalyticsJSURL ()
 Used to retrieve Analytics JS URL. More...
 
String getDomain ()
 Used to retrieve the domain. More...
 
String getBackendEndpointURL ()
 Used to retrieve Backend Endpoint URL. More...
 
DeviceInfo getDeviceInfo ()
 Used to retrieve Device Info. More...
 
boolean isUsingWifiOnly ()
 Used to retrieve useWifiOnly that determines network use. More...
 
void enableSsl ()
 Enables ssl(https://) for IQ. More...
 
void logOptionsData ()
 Log all of the parameters that are part of the Options class. More...
 

Static Public Member Functions

static IqConfiguration getDefaultIqConfiguration ()
 Provides the default IqConfiguration. More...
 

Detailed Description

This class configures all the IQ Analytics related information that needs to be configured with default values or customer given values.

Use IqConfiguration.Builder() to configure your IQ Analytics as needed.

Constructor & Destructor Documentation

com.ooyala.android.analytics.IqConfiguration.IqConfiguration ( String  playerID,
String  analyticsJSURL,
String  domain,
String  backendEndpointURL,
DeviceInfo  deviceInfo,
boolean  useWifiOnly 
)

Initialize an IqConfiguration object with all configurations.

You should not be creating one of these directly, but use the Builder() class

Parameters
playerID
analyticsJSURL
domain
backendEndpointURL
deviceInfo

Member Function Documentation

void com.ooyala.android.analytics.IqConfiguration.enableSsl ( )

Enables ssl(https://) for IQ.

String com.ooyala.android.analytics.IqConfiguration.getAnalyticsJSURL ( )

Used to retrieve Analytics JS URL.

Returns
analyticsJSURL
String com.ooyala.android.analytics.IqConfiguration.getBackendEndpointURL ( )

Used to retrieve Backend Endpoint URL.

Returns
backendEndpointURL
static IqConfiguration com.ooyala.android.analytics.IqConfiguration.getDefaultIqConfiguration ( )
static

Provides the default IqConfiguration.

Returns
the default configuration
DeviceInfo com.ooyala.android.analytics.IqConfiguration.getDeviceInfo ( )

Used to retrieve Device Info.

Returns
deviceInfo
String com.ooyala.android.analytics.IqConfiguration.getDomain ( )

Used to retrieve the domain.

Returns
domain
String com.ooyala.android.analytics.IqConfiguration.getPlayerID ( )

Used to retrieve the player ID.

Returns
playerID
boolean com.ooyala.android.analytics.IqConfiguration.isUsingWifiOnly ( )

Used to retrieve useWifiOnly that determines network use.

Returns
useWifiOnly
void com.ooyala.android.analytics.IqConfiguration.logOptionsData ( )

Log all of the parameters that are part of the Options class.