Articles in this section

Android SDK - Timer Class

Mark Heideman
  • Updated
Follow

Summary:

This document contains information regarding the Timer Class for the Android SDK. Contents include:

Timer Class Summary

com.bluetriangle.analytics

Class Timer

java.lang.Object

com.bluetriangle.analytics.Timer

All Implemented Interfaces:

  • android.os.Parcelable

Nested Class Summary

Nested classes/interfaces inherited from interface android.os.Parcelable

android.os.Parcelable.ClassLoaderCreator<T>, android.os.Parcelable.Creator<T>

Field Summary

Fields 
Modifier and Type Field and Description
static android.os.Parcelable.Creator<Timer> CREATOR 
private static java.util.Map<java.lang.String,java.lang.String> DEFAULT_VALUES
A map of fields and their associated default values
private long end
The time in milliseconds this timer was ended
static java.lang.String EXTRA_TIMER 
static java.lang.String FIELD_AB_TEST_ID 
static java.lang.String FIELD_BRAND_VALUE 
static java.lang.String FIELD_BROWSER 
static java.lang.String FIELD_BROWSER_VERSION 
static java.lang.String FIELD_BVZN 
static java.lang.String FIELD_CAMPAIGN 
static java.lang.String FIELD_CAMPAIGN_MEDIUM 
static java.lang.String FIELD_CAMPAIGN_NAME 
static java.lang.String FIELD_CAMPAIGN_SOURCE 
static java.lang.String FIELD_CART_VALUE 
static java.lang.String FIELD_CONTENT_GROUP_NAME 
static java.lang.String FIELD_CUSTOM_VALUE_4 
static java.lang.String FIELD_DATACENTER 
static java.lang.String FIELD_DEVICE 
static java.lang.String FIELD_DOM_INTERACTIVE 
static java.lang.String FIELD_EVENT_TYPE 
static java.lang.String FIELD_GLOBAL_USER_ID 
static java.lang.String FIELD_NATIVE_OS 
static java.lang.String FIELD_NAVIGATION_TYPE 
static java.lang.String FIELD_NST 
static java.lang.String FIELD_ORDER_NUMBER 
static java.lang.String FIELD_ORDER_TIME 
static java.lang.String FIELD_OS 
static java.lang.String FIELD_PAGE_NAME 
static java.lang.String FIELD_PAGE_TIME 
static java.lang.String FIELD_PAGE_VALUE 
static java.lang.String FIELD_REFERRER_URL 
static java.lang.String FIELD_RV 
static java.lang.String FIELD_SESSION_ID 
static java.lang.String FIELD_SITE_ID 
static java.lang.String FIELD_TIME_ON_PAGE 
static java.lang.String FIELD_TRAFFIC_SEGMENT_NAME 
static java.lang.String FIELD_UNLOAD_EVENT_START 
static java.lang.String FIELD_URL 
static java.lang.String FIELD_WCD 
private java.util.Map<java.lang.String,java.lang.String> fields
A map of all fields for this timer to be sent to the cloud server
private long interactive
The current time when the interactive call was made in milliseconds
private static java.lang.String LOG_TAG 
private long start
Start time in milliseconds

Fields inherited from interface android.os.Parcelable

CONTENTS_FILE_DESCRIPTOR, PARCELABLE_WRITE_RETURN_VALUE

Field Detail

LOG_TAG

private static final java.lang.String LOG_TAG

EXTRA_TIMER

public static final java.lang.String EXTRA_TIMER

FIELD_PAGE_NAME

public static final java.lang.String FIELD_PAGE_NAME

FIELD_NST

public static final java.lang.String FIELD_NST

FIELD_UNLOAD_EVENT_START

public static final java.lang.String FIELD_UNLOAD_EVENT_START

FIELD_CONTENT_GROUP_NAME

public static final java.lang.String FIELD_CONTENT_GROUP_NAME

FIELD_PAGE_VALUE

public static final java.lang.String FIELD_PAGE_VALUE

FIELD_PAGE_TIME

public static final java.lang.String FIELD_PAGE_TIME

FIELD_DOM_INTERACTIVE

public static final java.lang.String FIELD_DOM_INTERACTIVE

FIELD_NAVIGATION_TYPE

public static final java.lang.String FIELD_NAVIGATION_TYPE

FIELD_CART_VALUE

public static final java.lang.String FIELD_CART_VALUE

FIELD_ORDER_NUMBER

public static final java.lang.String FIELD_ORDER_NUMBER

FIELD_ORDER_TIME

public static final java.lang.String FIELD_ORDER_TIME

FIELD_EVENT_TYPE

public static final java.lang.String FIELD_EVENT_TYPE

FIELD_SITE_ID

public static final java.lang.String FIELD_SITE_ID

FIELD_TRAFFIC_SEGMENT_NAME

public static final java.lang.String FIELD_TRAFFIC_SEGMENT_NAME

FIELD_CAMPAIGN

public static final java.lang.String FIELD_CAMPAIGN

FIELD_TIME_ON_PAGE

public static final java.lang.String FIELD_TIME_ON_PAGE

FIELD_BRAND_VALUE

public static final java.lang.String FIELD_BRAND_VALUE

FIELD_URL

public static final java.lang.String FIELD_URL

FIELD_BVZN

public static final java.lang.String FIELD_BVZN

FIELD_OS

public static final java.lang.String FIELD_OS

FIELD_SESSION_ID

public static final java.lang.String FIELD_SESSION_ID

FIELD_GLOBAL_USER_ID

public static final java.lang.String FIELD_GLOBAL_USER_ID

FIELD_CUSTOM_VALUE_4

public static final java.lang.String FIELD_CUSTOM_VALUE_4

FIELD_RV

public static final java.lang.String FIELD_RV

FIELD_WCD

public static final java.lang.String FIELD_WCD

FIELD_AB_TEST_ID

public static final java.lang.String FIELD_AB_TEST_ID

FIELD_CAMPAIGN_SOURCE

public static final java.lang.String FIELD_CAMPAIGN_SOURCE

FIELD_CAMPAIGN_MEDIUM

public static final java.lang.String FIELD_CAMPAIGN_MEDIUM

FIELD_CAMPAIGN_NAME

public static final java.lang.String FIELD_CAMPAIGN_NAME

FIELD_DATACENTER

public static final java.lang.String FIELD_DATACENTER

FIELD_REFERRER_URL

public static final java.lang.String FIELD_REFERRER_URL

FIELD_BROWSER

public static final java.lang.String FIELD_BROWSER

FIELD_NATIVE_OS

public static final java.lang.String FIELD_NATIVE_OS

FIELD_DEVICE

public static final java.lang.String FIELD_DEVICE

FIELD_BROWSER_VERSION

public static final java.lang.String FIELD_BROWSER_VERSION

DEFAULT_VALUES

private static final java.util.Map<java.lang.String,java.lang.String> DEFAULT_VALUES
A map of fields and their associated default values

fields

private final java.util.Map<java.lang.String,java.lang.String> fields
A map of all fields for this timer to be sent to the cloud server

start

private long start
Start time in milliseconds

interactive

private long interactive
The current time when the interactive call was made in milliseconds

end

private long end
The time in milliseconds this timer was ended

CREATOR

public static final android.os.Parcelable.Creator<Timer> CREATOR

Constructor Detail

Timer

public Timer()
Create a timer instance with no page name or traffic segment name. These will need to be set later before submitting the timer.

Timer

public Timer(@Nullable java.lang.String pageName,
             @Nullable java.lang.String trafficSegmentName)
Create a timer instance with the given page name and traffic segment name
Parameters:
pageName - page name
trafficSegmentName - traffic segment name

Timer

public Timer(@Nullable java.lang.String pageName,
             @Nullable java.lang.String trafficSegmentName,
             @Nullable java.lang.String abTestIdentifier,
             @Nullable java.lang.String contentGroupName)
Create a timer instance with the given page name, traffic segment name, optional AB test id, and optional content group name.
Parameters:
pageName - page name
trafficSegmentName - traffic segment name
abTestIdentifier - AB Test ID/Name
contentGroupName - Content Group Name

Timer

private Timer(android.os.Parcel in)

Method Detail

start 
public Timer start()
Start this timer if not already started. If already started, will log an error.
Returns:
this timer

interactive

public Timer interactive()
Mark this timer interactive at current time if the timer has been started and not already marked interactive. If the timer has not been started yet, log an error. If the timer has already been marked interactive, log an error.
Returns:
this timer

end

public Timer end()
End this timer.
Returns:
this timer.

isRunning

public boolean isRunning()
Determines if this timer is currently running
Returns:
True if timer has started but not yet ended.

hasEnded

public boolean hasEnded()
Determines if this timer has been ended
Returns:
True if ended, else false

isInteractive

public boolean isInteractive()
Determines if this timer has been marked as interactive yet
Returns:
True if marked interactive, else false

submit

public void submit()
Convenience method to submit this timer to the global tracker

getFields

public java.util.Map<java.lang.String,java.lang.String> getFields()
Get all the fields currently associated with this timer.
Returns:
returns a new hash map with all the fields currently.

setPageName

public Timer setPageName(@NonNull java.lang.String pageName)
Set the timer's page name
Parameters:
pageName - name of the page for this timer
Returns:
this timer

setTrafficSegmentName

public Timer setTrafficSegmentName(@NonNull java.lang.String trafficSegmentName)
Set the timer's traffic segment name
Parameters:
trafficSegmentName - name of the traffic segment for this timer
Returns:
this timer

setAbTestIdentifier

public Timer setAbTestIdentifier(@NonNull java.lang.String abTestIdentifier)
Set this timer's AB test identifier
Parameters:
abTestIdentifier - the AB test id
Returns:
this timer

setContentGroupName

public Timer setContentGroupName(@NonNull java.lang.String contentGroupName)
Set the content group name or page type for this timer
Parameters:
contentGroupName - name of content group or page type
Returns:
this timer

setPageValue

public Timer setPageValue(double pageValue)
Set the value of this page/timer
Parameters:
pageValue - value of page
Returns:
this timer

setBrandValue

public Timer setBrandValue(double brandValue)
Set the brand value of this timer
Parameters:
brandValue - brand's value
Returns:
this timer

setCartValue

public Timer setCartValue(double cartValue)
Set the value of the cart for this timer
Parameters:
cartValue - value of cart
Returns:
this timer

setOrderNumber

public Timer setOrderNumber(@NonNull java.lang.String orderNumber)
Set the order number for this timer
Parameters:
orderNumber - order number
Returns:
this timer

setOrderTime

public Timer setOrderTime(long orderTime)
Set the time of the order
Parameters:
orderTime - epoch time of order in milliseconds
Returns:
this timer

setCampaignName

public Timer setCampaignName(@NonNull java.lang.String campaignName)
Set the name of the campaign
Parameters:
campaignName - name of campaign
Returns:
this timer

setCampaignSource

public Timer setCampaignSource(@NonNull java.lang.String campaignSource)
Set the source of the campaign
Parameters:
campaignSource - source of campaign
Returns:
this timer

setCampaignMedium

public Timer setCampaignMedium(@NonNull java.lang.String campaignMedium)
Set the medium of the campaign
Parameters:
campaignMedium - medium of campaign
Returns:
this timer

setCampaign

public Timer setCampaign(@NonNull java.lang.String campaignName,
                         @NonNull java.lang.String campaignSource,
                         @NonNull java.lang.String campaignMedium)
Set campaign details
Parameters:
campaignName - name of campaign
campaignSource - source of campaign
campaignMedium - medium of campaign
Returns:
this timer

setTimeOnPage

public Timer setTimeOnPage(long timeOnPage)
Set time on page for this timer
Parameters:
timeOnPage - time on page in milliseconds
Returns:
this timer

setUrl

public Timer setUrl(@NonNull java.lang.String url)
Set the URL for this timer
Parameters:
url - the url for this timer
Returns:
this timer

setReferrer

public Timer setReferrer(@NonNull java.lang.String referrer)
Set the referrer URL for this timer
Parameters:
referrer - the referrer URL
Returns:
this timer

setFields

public Timer setFields(@NonNull java.util.Map<java.lang.String,java.lang.String> fields)
Allows the setting of multiple fields via a Map
Parameters:
fields - A map of attribute names as keys and their associated string value to set
Returns:
this timer

setField

public Timer setField(@NonNull java.lang.String fieldName,
                      @NonNull java.lang.String value)
Sets a field name with the given value
Parameters:
fieldName - the name of the field to set
value - the value to set for the given field
Returns:
this timer

setField

public Timer setField(@NonNull java.lang.String fieldName, int value)
Sets a field name with the given value
Parameters:
fieldName - the name of the field to set
value - the value to set for the given field
Returns:
this timer

setField

public Timer setField(@NonNull java.lang.String fieldName, double value)
Sets a field name with the given value
Parameters:
fieldName - the name of the field to set
value - the value to set for the given field
Returns:
this timer

setField

public Timer setField(@NonNull java.lang.String fieldName, float value)
Sets a field name with the given value
Parameters:
fieldName - the name of the field to set
value - the value to set for the given field
Returns:
this timer

setField

public Timer setField(@NonNull java.lang.String fieldName, boolean value)
Sets a field name with the given value
Parameters:
fieldName - the name of the field to set
value - the value to set for the given field
Returns:
this timer

setField

public Timer setField(@NonNull java.lang.String fieldName, long value)
Sets a field name with the given value
Parameters:
fieldName - the name of the field to set
value - the value to set for the given field
Returns:
this timer

getField

public java.lang.String getField(@NonNull java.lang.String fieldName)
Get the current value for the given field
Parameters:
fieldName - the name of the field to get
Returns:
the current value for the given field or null if not set

clearField

public Timer clearField(@NonNull java.lang.String fieldName)
Resets a field to the default value if there is one else removes the field completely.
Parameters:
fieldName - name of field to remove
Returns:
this timer

describeContents

public int describeContents()
Specified by:
describeContents in interface android.os.Parcelable

writeToParcel

public void writeToParcel(android.os.Parcel dest, int flags)
Specified by:
writeToParcel in interface android.os.Parcelable

toString

public java.lang.String toString()
Overrides:
toString in class java.lang.Object

Related articles

Comments

0 comments

Please sign in to leave a comment.