InstrumentationEvent

java.lang.Object
- com.salesforce.androidsdk.analytics.model.InstrumentationEvent

```
public class InstrumentationEvent
extends java.lang.Object
```
Represents a typical instrumentation event. Transforms can be used to convert this event into a specific library's event format.

Author:

bhariharan

Nested Class Summary

Nested Classes
Modifier and Type	Class and Description
`static class`	`InstrumentationEvent.ErrorType` Represents the type of error being logged.
`static class`	`InstrumentationEvent.EventType` Represents the type of event being logged.
`static class`	`InstrumentationEvent.SchemaType` Represents the type of schema being logged.

Field Summary

Fields
Modifier and Type	Field and Description
`static java.lang.String`	`ATTRIBUTES_KEY`
`static java.lang.String`	`CONNECTION_TYPE_KEY`
`static java.lang.String`	`DEVICE_APP_ATTRIBUTES_KEY`
`static java.lang.String`	`END_TIME_KEY`
`static java.lang.String`	`ERROR_TYPE_KEY`
`static java.lang.String`	`EVENT_ID_KEY`
`static java.lang.String`	`EVENT_TYPE_KEY`
`static java.lang.String`	`MARKS_KEY`
`static java.lang.String`	`NAME_KEY`
`static java.lang.String`	`PAGE_KEY`
`static java.lang.String`	`PREVIOUS_PAGE_KEY`
`static java.lang.String`	`SCHEMA_TYPE_KEY`
`static java.lang.String`	`SENDER_CONTEXT_KEY`
`static java.lang.String`	`SENDER_ID_KEY`
`static java.lang.String`	`SENDER_PARENT_ID_KEY`
`static java.lang.String`	`SEQUENCE_ID_KEY`
`static java.lang.String`	`SESSION_ID_KEY`
`static java.lang.String`	`SESSION_START_TIME_KEY`
`static java.lang.String`	`START_TIME_KEY`

Constructor Summary

Constructors
Constructor and Description

InstrumentationEvent(JSONObject json)
Constructs an event from its JSON representation.

Constructors
Constructor and Description
`InstrumentationEvent(JSONObject json)` Constructs an event from its JSON representation.

Method Summary

All Methods Instance Methods Concrete Methods
Modifier and Type	Method and Description
`boolean`	`equals(java.lang.Object object)`
`JSONObject`	`getAttributes()` Returns attributes.
`java.lang.String`	`getConnectionType()` Returns connection type.
`DeviceAppAttributes`	`getDeviceAppAttributes()` Returns device app attributes.
`long`	`getEndTime()` Returns end time.
`InstrumentationEvent.ErrorType`	`getErrorType()` Returns error type.
`java.lang.String`	`getEventId()` Returns event ID.
`InstrumentationEvent.EventType`	`getEventType()` Returns event type.
`JSONObject`	`getMarks()` Returns marks.
`java.lang.String`	`getName()` Returns name.
`JSONObject`	`getPage()` Returns page.
`JSONObject`	`getPreviousPage()` Returns previous page.
`InstrumentationEvent.SchemaType`	`getSchemaType()` Returns schema type.
`JSONObject`	`getSenderContext()` Returns sender context.
`java.lang.String`	`getSenderId()` Returns sender ID.
`java.lang.String`	`getSenderParentId()` Returns sender parent ID.
`int`	`getSequenceId()` Returns sequence ID.
`java.lang.String`	`getSessionId()` Returns session ID.
`long`	`getSessionStartTime()` Returns session start time.
`long`	`getStartTime()` Returns start time.
`int`	`hashCode()`
`JSONObject`	`toJson()` Returns a JSON representation of this event.

Methods inherited from class java.lang.Object
clone, finalize, getClass, notify, notifyAll, toString, wait, wait, wait

- Field Detail
  - EVENT_ID_KEY
```
public static final java.lang.String EVENT_ID_KEY
```
    See Also:
    
    Constant Field Values
  - START_TIME_KEY
```
public static final java.lang.String START_TIME_KEY
```
    See Also:
    
    Constant Field Values
  - END_TIME_KEY
```
public static final java.lang.String END_TIME_KEY
```
    See Also:
    
    Constant Field Values
  - NAME_KEY
```
public static final java.lang.String NAME_KEY
```
    See Also:
    
    Constant Field Values
  - ATTRIBUTES_KEY
```
public static final java.lang.String ATTRIBUTES_KEY
```
    See Also:
    
    Constant Field Values
  - SESSION_ID_KEY
```
public static final java.lang.String SESSION_ID_KEY
```
    See Also:
    
    Constant Field Values
  - SEQUENCE_ID_KEY
```
public static final java.lang.String SEQUENCE_ID_KEY
```
    See Also:
    
    Constant Field Values
  - SENDER_ID_KEY
```
public static final java.lang.String SENDER_ID_KEY
```
    See Also:
    
    Constant Field Values
  - SENDER_CONTEXT_KEY
```
public static final java.lang.String SENDER_CONTEXT_KEY
```
    See Also:
    
    Constant Field Values
  - SCHEMA_TYPE_KEY
```
public static final java.lang.String SCHEMA_TYPE_KEY
```
    See Also:
    
    Constant Field Values
  - EVENT_TYPE_KEY
```
public static final java.lang.String EVENT_TYPE_KEY
```
    See Also:
    
    Constant Field Values
  - ERROR_TYPE_KEY
```
public static final java.lang.String ERROR_TYPE_KEY
```
    See Also:
    
    Constant Field Values
  - CONNECTION_TYPE_KEY
```
public static final java.lang.String CONNECTION_TYPE_KEY
```
    See Also:
    
    Constant Field Values
  - DEVICE_APP_ATTRIBUTES_KEY
```
public static final java.lang.String DEVICE_APP_ATTRIBUTES_KEY
```
    See Also:
    
    Constant Field Values
  - SENDER_PARENT_ID_KEY
```
public static final java.lang.String SENDER_PARENT_ID_KEY
```
    See Also:
    
    Constant Field Values
  - SESSION_START_TIME_KEY
```
public static final java.lang.String SESSION_START_TIME_KEY
```
    See Also:
    
    Constant Field Values
  - PAGE_KEY
```
public static final java.lang.String PAGE_KEY
```
    See Also:
    
    Constant Field Values
  - PREVIOUS_PAGE_KEY
```
public static final java.lang.String PREVIOUS_PAGE_KEY
```
    See Also:
    
    Constant Field Values
  - MARKS_KEY
```
public static final java.lang.String MARKS_KEY
```
    See Also:
    
    Constant Field Values
- Constructor Detail
  - InstrumentationEvent
```
public InstrumentationEvent(JSONObject json)
```
    Constructs an event from its JSON representation. This is meant for internal use. Apps should use InstrumentationEventBuilder to build InstrumentationEvent objects.
    
    Parameters:
    
    json - JSON object.
- Method Detail
  - getEventId
```
public java.lang.String getEventId()
```
    Returns event ID.
    
    Returns:
    
    Event ID.
  - getStartTime
```
public long getStartTime()
```
    Returns start time.
    
    Returns:
    
    Start time.
  - getEndTime
```
public long getEndTime()
```
    Returns end time.
    
    Returns:
    
    End time.
  - getName
```
public java.lang.String getName()
```
    Returns name.
    
    Returns:
    
    Name.
  - getAttributes
```
public JSONObject getAttributes()
```
    Returns attributes.
    
    Returns:
    
    Attributes.
  - getSessionId
```
public java.lang.String getSessionId()
```
    Returns session ID.
    
    Returns:
    
    Session ID.
  - getSequenceId
```
public int getSequenceId()
```
    Returns sequence ID.
    
    Returns:
    
    Sequence ID.
  - getSenderId
```
public java.lang.String getSenderId()
```
    Returns sender ID.
    
    Returns:
    
    Sender ID.
  - getSenderContext
```
public JSONObject getSenderContext()
```
    Returns sender context.
    
    Returns:
    
    Sender context.
  - getSchemaType
```
public InstrumentationEvent.SchemaType getSchemaType()
```
    Returns schema type.
    
    Returns:
    
    Schema type.
  - getEventType
```
public InstrumentationEvent.EventType getEventType()
```
    Returns event type.
    
    Returns:
    
    Event type.
  - getErrorType
```
public InstrumentationEvent.ErrorType getErrorType()
```
    Returns error type.
    
    Returns:
    
    Error type.
  - getDeviceAppAttributes
```
public DeviceAppAttributes getDeviceAppAttributes()
```
    Returns device app attributes.
    
    Returns:
    
    Device app attributes.
  - getConnectionType
```
public java.lang.String getConnectionType()
```
    Returns connection type.
    
    Returns:
    
    Connection type.
  - getSenderParentId
```
public java.lang.String getSenderParentId()
```
    Returns sender parent ID.
    
    Returns:
    
    Sender parent ID.
  - getSessionStartTime
```
public long getSessionStartTime()
```
    Returns session start time.
    
    Returns:
    
    Session start time.
  - getPage
```
public JSONObject getPage()
```
    Returns page.
    
    Returns:
    
    Page.
  - getPreviousPage
```
public JSONObject getPreviousPage()
```
    Returns previous page.
    
    Returns:
    
    Previous page.
  - getMarks
```
public JSONObject getMarks()
```
    Returns marks.
    
    Returns:
    
    Marks.
  - toJson
```
public JSONObject toJson()
```
    Returns a JSON representation of this event.
    
    Returns:
    
    JSON object.
  - equals
```
public boolean equals(java.lang.Object object)
```
    Overrides:
    
    equals in class java.lang.Object
  - hashCode
```
public int hashCode()
```
    Overrides:
    
    hashCode in class java.lang.Object

Class InstrumentationEvent

Nested Class Summary

Field Summary

Constructor Summary

Method Summary

Methods inherited from class java.lang.Object

Field Detail

EVENT_ID_KEY

START_TIME_KEY

END_TIME_KEY

NAME_KEY

ATTRIBUTES_KEY

SESSION_ID_KEY

SEQUENCE_ID_KEY

SENDER_ID_KEY

SENDER_CONTEXT_KEY

SCHEMA_TYPE_KEY

EVENT_TYPE_KEY

ERROR_TYPE_KEY

CONNECTION_TYPE_KEY

DEVICE_APP_ATTRIBUTES_KEY

SENDER_PARENT_ID_KEY

SESSION_START_TIME_KEY

PAGE_KEY

PREVIOUS_PAGE_KEY

MARKS_KEY

Constructor Detail

InstrumentationEvent

Method Detail

getEventId

getStartTime

getEndTime

getName

getAttributes

getSessionId

getSequenceId

getSenderId

getSenderContext

getSchemaType

getEventType

getErrorType

getDeviceAppAttributes

getConnectionType

getSenderParentId

getSessionStartTime

getPage

getPreviousPage

getMarks

toJson

equals

hashCode