com.salesforce.androidsdk.analytics.model

Class InstrumentationEventBuilder

java.lang.Object

com.salesforce.androidsdk.analytics.model.InstrumentationEventBuilder

public class InstrumentationEventBuilder
extends java.lang.Object

Builder class that helps create a new InstrumentationEvent object.

Author:

bhariharan

Nested Class Summary

Nested Classes

Modifier and Type	Class and Description
static class	InstrumentationEventBuilder.EventBuilderException Exception thrown if the event can not be built.

Method Summary

Modifier and Type	Method and Description
InstrumentationEventBuilder	attributes(JSONObject attributes) Sets attributes.
InstrumentationEvent	buildEvent() Validates and builds an InstrumentationEvent object.
InstrumentationEventBuilder	endTime(long endTime) Sets end time.
InstrumentationEventBuilder	errorType(InstrumentationEvent.ErrorType errorType) Sets error type.
InstrumentationEventBuilder	eventType(InstrumentationEvent.EventType eventType) Sets event type.
static InstrumentationEventBuilder	getInstance(AnalyticsManager analyticsManager, Context context) Returns an instance of this class.
InstrumentationEventBuilder	marks(JSONObject marks) Sets marks.
InstrumentationEventBuilder	name(java.lang.String name) Sets name.
InstrumentationEventBuilder	page(JSONObject page) Sets page.
InstrumentationEventBuilder	previousPage(JSONObject previousPage) Sets previous page.
InstrumentationEventBuilder	schemaType(InstrumentationEvent.SchemaType schemaType) Sets schema type.
InstrumentationEventBuilder	senderContext(JSONObject senderContext) Sets sender context.
InstrumentationEventBuilder	senderId(java.lang.String senderId) Sets sender ID.
InstrumentationEventBuilder	senderParentId(java.lang.String senderParentId) Sets sender parent ID.
InstrumentationEventBuilder	sessionId(java.lang.String sessionId) Sets session ID.
InstrumentationEventBuilder	sessionStartTime(long sessionStartTime) Sets session start time.
InstrumentationEventBuilder	startTime(long startTime) Sets start time.

Methods inherited from class java.lang.Object

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

Method Detail

getInstance

public static final InstrumentationEventBuilder getInstance(AnalyticsManager analyticsManager,
                                                            Context context)

Returns an instance of this class.

Parameters:

analyticsManager - Instance of AnalyticsManager.

context - Context.

Returns:

Instance of this class.

startTime

public InstrumentationEventBuilder startTime(long startTime)

Sets start time.

Parameters:

startTime - Start time.

Returns:

Instance of this class.

endTime

public InstrumentationEventBuilder endTime(long endTime)

Sets end time.

Parameters:

endTime - End time.

Returns:

Instance of this class.

name

public InstrumentationEventBuilder name(java.lang.String name)

Sets name.

Parameters:

name - Name.

Returns:

Instance of this class.

attributes

public InstrumentationEventBuilder attributes(JSONObject attributes)

Sets attributes.

Parameters:

attributes - Attributes.

Returns:

Instance of this class.

sessionId

public InstrumentationEventBuilder sessionId(java.lang.String sessionId)

Sets session ID.

Parameters:

sessionId - Session ID.

Returns:

Instance of this class.

senderId

public InstrumentationEventBuilder senderId(java.lang.String senderId)

Sets sender ID.

Parameters:

senderId - Sender ID.

Returns:

Instance of this class.

senderContext

public InstrumentationEventBuilder senderContext(JSONObject senderContext)

Sets sender context.

Parameters:

senderContext - Sender context.

Returns:

Instance of this class.

schemaType

public InstrumentationEventBuilder schemaType(InstrumentationEvent.SchemaType schemaType)

Sets schema type.

Parameters:

schemaType - Schema type.

Returns:

Instance of this class.

eventType

public InstrumentationEventBuilder eventType(InstrumentationEvent.EventType eventType)

Sets event type.

Parameters:

eventType - Event type.

Returns:

Instance of this class.

errorType

public InstrumentationEventBuilder errorType(InstrumentationEvent.ErrorType errorType)

Sets error type.

Parameters:

errorType - Error type.

Returns:

Instance of this class.

senderParentId

public InstrumentationEventBuilder senderParentId(java.lang.String senderParentId)

Sets sender parent ID.

Parameters:

senderParentId - Sender parent ID.

Returns:

Instance of this class.

sessionStartTime

public InstrumentationEventBuilder sessionStartTime(long sessionStartTime)

Sets session start time.

Parameters:

sessionStartTime - Session start time.

Returns:

Instance of this class.

page

public InstrumentationEventBuilder page(JSONObject page)

Sets page.

Parameters:

page - Page.

Returns:

Instance of this class.

previousPage

public InstrumentationEventBuilder previousPage(JSONObject previousPage)

Sets previous page.

Parameters:

previousPage - Previous page.

Returns:

Instance of this class.

marks

public InstrumentationEventBuilder marks(JSONObject marks)

Sets marks.

Parameters:

marks - Marks.

Returns:

Instance of this class.

buildEvent

public InstrumentationEvent buildEvent()
                                throws InstrumentationEventBuilder.EventBuilderException

Validates and builds an InstrumentationEvent object. Throws EventBuilderException if mandatory fields are not set.

Returns:

InstrumentationEvent object.

Throws:

InstrumentationEventBuilder.EventBuilderException