com.salesforce.androidsdk.analytics

Class EventBuilderHelper

java.lang.Object

com.salesforce.androidsdk.analytics.EventBuilderHelper

public class EventBuilderHelper
extends java.lang.Object

A simple helper class to facilitate creation of common types of events.

Field Summary

Fields

Modifier and Type	Field and Description
static java.lang.String	END_TIME
static java.lang.String	START_TIME

Constructor Summary

Constructors

Constructor and Description
EventBuilderHelper()

Method Summary

Modifier and Type	Method and Description
static void	createAndStoreEvent(java.lang.String name, UserAccount userAccount, java.lang.String className, JSONObject attributes) Creates and stores an analytics event with the supplied parameters.
static void	createAndStoreEventSync(java.lang.String name, UserAccount userAccount, java.lang.String className, JSONObject attributes) Creates and stores an analytics event with the supplied parameters.
static void	enableDisable(boolean b) This method allows event creation/storage to be disabled across the board.

Methods inherited from class java.lang.Object

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

Field Detail

START_TIME

public static final java.lang.String START_TIME

See Also:

Constant Field Values

END_TIME

public static final java.lang.String END_TIME

See Also:

Constant Field Values

Constructor Detail

EventBuilderHelper

public EventBuilderHelper()

Method Detail

enableDisable

public static void enableDisable(boolean b)

This method allows event creation/storage to be disabled across the board. It is meant for tests. It allows tests to be run individually. When running individual tests in Android Studio the SalesforceSDKManager.init() is not called As a result, if the test cause createAndStoreEvent to run, it will fail because the call to UserAccountManager.getInstance() does a SalesforceSDKManager.getInstance().

createAndStoreEvent

public static void createAndStoreEvent(java.lang.String name,
                                       UserAccount userAccount,
                                       java.lang.String className,
                                       JSONObject attributes)

Creates and stores an analytics event with the supplied parameters. By default all createAndStoreEvent's are placed into a background thread pool for posting.

Parameters:

name - Event name.

userAccount - User account.

className - Class name or context where the event was generated.

attributes - Addiitonal attributes.

createAndStoreEventSync

public static void createAndStoreEventSync(java.lang.String name,
                                           UserAccount userAccount,
                                           java.lang.String className,
                                           JSONObject attributes)

Creates and stores an analytics event with the supplied parameters.

Parameters:

name - Event name.

userAccount - User account.

className - Class name or context where the event was generated.

attributes - Addiitonal attributes.