io.branch.referral

Class PrefHelper

java.lang.Object

io.branch.referral.PrefHelper

public class PrefHelper
extends java.lang.Object

A class that uses the helper pattern to provide regularly referenced static values and logging capabilities used in various other parts of the SDK, and that are related to globally set preference values.

Field Summary

Fields

Modifier and Type	Field and Description
static java.lang.String	NO_STRING_VALUE A String value used where no string value is available.

Method Summary

Modifier and Type	Method and Description
void	clearBranchAnalyticsData()
void	clearIsReferrable() Sets the KEY_IS_REFERRABLE value in preferences to 0, or false if parsed as a Boolean.
void	clearSystemReadStatus() Resets the time that the system was last read.
void	clearUserValues() Resets the user-related values that have been stored in preferences.
static void	Debug(java.lang.String message) Creates a Debug message in the debugger.
int	getActionTotalCount(java.lang.String action) Gets the count of total number of times that the specified action has been carried out during the current session, as defined in preferences.
int	getActionUniqueCount(java.lang.String action) Gets the count of the unique number of times that the specified action has been carried out during the current session, as defined in preferences.
java.lang.String	getAPIBaseUrl() Returns the base URL to use for all calls to the Branch API as a String.
java.lang.String	getAppLink() Get the App link which statrted the application.
java.lang.String	getAppVersion() Returns the current value of KEY_APP_VERSION as stored in preferences.
boolean	getBool(java.lang.String key) A basic method that returns a Boolean value from a specified preferences Key.
org.json.JSONObject	getBranchAnalyticsData()
java.lang.String	getBranchKey()
int	getBranchViewUsageCount(java.lang.String branchViewId)
int	getCreditCount() Get the current cached credit count for the default bucket, as currently stored in preferences for the current app.
int	getCreditCount(java.lang.String bucket) Get the current cached credit count for the default bucket, as currently stored in preferences for the current app.
java.lang.String	getDeviceFingerPrintID() Gets the Build.FINGERPRINT value of the current OS build, on the current device, as a String from preferences.
java.lang.String	getExternalIntentExtra() Gets the KEY_EXTERNAL_INTENT_EXTRA String value that has been set via the Branch API.
java.lang.String	getExternalIntentUri() Gets the KEY_EXTERNAL_INTENT_URI String value that has been set via the Branch API.
float	getFloat(java.lang.String key) A basic method that returns a Float value from a specified preferences Key.
java.lang.String	getGooglePlayReferrer() Gets the google play install referrer string
java.lang.String	getGoogleSearchInstallIdentifier() Gets the google install referrer identifier
java.lang.String	getIdentity() Gets the KEY_IDENTITY String value that has been set via the Branch API.
java.lang.String	getIdentityID() Gets the KEY_IDENTITY_ID String value that has been set via the Branch API.
org.json.JSONObject	getInstallMetadata()
java.lang.String	getInstallParams() Gets the session parameters as originally set at time of app installation, in preferences.
java.lang.String	getInstallReferrerParams()
static PrefHelper	getInstance(android.content.Context context) Singleton method to return the pre-initialised, or newly initialise and return, a singleton object of the type PrefHelper.
int	getInteger(java.lang.String key) A basic method that returns an integer value from a specified preferences Key.
int	getInteger(java.lang.String key, int defaultValue) A basic method that returns an Integer value from a specified preferences Key, with a default value supplied in case the value is null.
boolean	getIsAppLinkTriggeredInit() Specifies the value to specify if the current init is triggered by an FB app link
int	getIsReferrable() Gets the Integer value of the preference setting KEY_IS_REFERRABLE, which indicates whether or not the current session should be considered referrable.
long	getLastStrongMatchTime() Get the last strong match check epoch time
java.lang.String	getLinkClickID() Gets the KEY_LINK_CLICK_ID String value that has been set via the Branch API.
java.lang.String	getLinkClickIdentifier() Gets the KEY_LINK_CLICK_IDENTIFIER String value that has been set via the Branch API.
long	getLong(java.lang.String key) A basic method that returns a Long value from a specified preferences Key.
java.lang.String	getPushIdentifier() Get the branch url in push payload which started the application.
org.json.JSONObject	getRequestMetadata()
int	getRetryCount() Gets the current count of the number of times that a Branch API call has been re-attempted.
int	getRetryInterval() Gets the amount of time in milliseconds to wait before re-attempting a timed-out request to the Branch API.
java.lang.String	getSessionID() Gets the ID of the KEY_SESSION_ID String value from preferences.
java.lang.String	getSessionParams() Gets the session parameters as currently set in preferences.
java.lang.String	getString(java.lang.String key) A basic method that returns a String value from a specified preferences Key.
int	getTimeout() Returns the currently set timeout value for calls to the Branch API.
java.lang.String	getUserURL() Sets the user URL from preferences.
boolean	isFullAppConversion() Get the value for the full app conversion state.
static void	LogAlways(java.lang.String message)
void	saveBranchAnalyticsData(org.json.JSONObject analyticsData)
void	saveLastStrongMatchTime(long strongMatchCheckTime) Saves the last strong match epoch time stamp
void	setActionTotalCount(java.lang.String action, int count) Sets the count of total number of times that the specified action has been carried out during the current session, as defined in preferences.
void	setActionUniqueCount(java.lang.String action, int count) Sets the count of the unique number of times that the specified action has been carried out during the current session, as defined in preferences.
void	setAppLink(java.lang.String appLinkUrl) Set the KEY_APP_LINK String values that has been started the application.
void	setAppVersion(java.lang.String version) Sets the value of KEY_APP_VERSION in preferences.
void	setBool(java.lang.String key, java.lang.Boolean value) Sets the value of the String key value supplied in preferences.
boolean	setBranchKey(java.lang.String key) Set the given Branch Key to preference.
void	setCreditCount(int count) Sets the credit count for the default bucket to the specified Integer, in preferences.
void	setCreditCount(java.lang.String bucket, int count) Sets the credit count for the default bucket to the specified Integer, in preferences.
void	setDeviceFingerPrintID(java.lang.String device_fingerprint_id) Sets the Build.FINGERPRINT value of the current OS build, on the current device, as a String in preferences.
void	setExternalIntentExtra(java.lang.String extras) Sets the KEY_EXTERNAL_INTENT_EXTRA with value with given intent extras in string format.
void	setExternalIntentUri(java.lang.String uri) Sets the KEY_EXTERNAL_INTENT_URI with value with given intent URI String.
void	setFloat(java.lang.String key, float value) Sets the value of the String key value supplied in preferences.
void	setGooglePlayReferrer(java.lang.String referrer) Sets the Google play install referrer string
void	setGoogleSearchInstallIdentifier(java.lang.String identifier) Sets the Google install referrer identifier to the pref
void	setIdentity(java.lang.String identity) Sets the KEY_IDENTITY String value that has been set via the Branch API.
void	setIdentityID(java.lang.String identity_id) Sets the KEY_IDENTITY_ID String value that has been set via the Branch API.
void	setInstallParams(java.lang.String params) Sets the session parameters as originally set at time of app installation, in preferences.
void	setInstallReferrerParams(java.lang.String params)
void	setInteger(java.lang.String key, int value) Sets the value of the String key value supplied in preferences.
void	setIsAppLinkTriggeredInit(java.lang.Boolean isAppLinkTriggered) Set the value to specify if the current init is triggered by an FB app link
void	setIsFullAppConversion(boolean isFullAppConversion) Set the value for the full app conversion state.
void	setIsReferrable() Sets the KEY_IS_REFERRABLE value in preferences to 1, or true if parsed as a Boolean.
void	setLinkClickID(java.lang.String link_click_id) Sets the KEY_LINK_CLICK_ID String value that has been set via the Branch API.
void	setLinkClickIdentifier(java.lang.String identifier) Sets the KEY_LINK_CLICK_IDENTIFIER String value that has been set via the Branch API.
void	setLong(java.lang.String key, long value) Sets the value of the String key value supplied in preferences.
void	setPushIdentifier(java.lang.String pushIdentifier) Set the KEY_PUSH_IDENTIFIER String values that has been started the application.
void	setRequestMetadata(java.lang.String key, java.lang.String value)
void	setRetryCount(int retry) Sets the value specifying the number of times that a Branch API call has been re-attempted.
void	setRetryInterval(int retryInt) Sets the amount of time in milliseconds to wait before re-attempting a timed-out request to the Branch API.
void	setSessionID(java.lang.String session_id) Sets the ID of the KEY_SESSION_ID String value in preferences.
void	setSessionParams(java.lang.String params) Sets the session parameters as currently set in preferences.
void	setString(java.lang.String key, java.lang.String value) Sets the value of the String key value supplied in preferences.
void	setTimeout(int timeout) Sets the duration in milliseconds to override the timeout value for calls to the Branch API.
void	setUserURL(java.lang.String user_url) Sets the user URL from preferences.
void	updateBranchViewUsageCount(java.lang.String branchViewId)

Methods inherited from class java.lang.Object

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

Field Detail

NO_STRING_VALUE

public static final java.lang.String NO_STRING_VALUE

A String value used where no string value is available.

See Also:

Constant Field Values

Method Detail

getInstance

public static PrefHelper getInstance(android.content.Context context)

Singleton method to return the pre-initialised, or newly initialise and return, a singleton object of the type PrefHelper.

Parameters:

context - The Context within which the object should be instantiated; this parameter is passed to the private PrefHelper(Context) constructor method.

Returns:

A PrefHelper object instance.

getAPIBaseUrl

public java.lang.String getAPIBaseUrl()

Returns the base URL to use for all calls to the Branch API as a String.

NOTE: Below API v20, TLS 1.2 does not work reliably, so we will fall back in that case.

Returns:

A String variable containing the hard-coded base URL that the Branch API uses.

setTimeout

public void setTimeout(int timeout)

Sets the duration in milliseconds to override the timeout value for calls to the Branch API.

Parameters:

timeout - The Integer value of the timeout setting in milliseconds.

getTimeout

public int getTimeout()

Returns the currently set timeout value for calls to the Branch API. This will be the default SDK setting unless it has been overridden manually between Branch object instantiation and this call.

Returns:

An Integer value containing the currently set timeout value in milliseconds.

setRetryCount

public void setRetryCount(int retry)

Sets the value specifying the number of times that a Branch API call has been re-attempted.

This overrides the default retry value.

Parameters:

retry - An Integer value specifying the value to be specified in preferences that determines the number of times that a Branch API call has been re- attempted.

getRetryCount

public int getRetryCount()

Gets the current count of the number of times that a Branch API call has been re-attempted.

Returns:

An Integer value containing the current count of the number of times that a Branch API call has been attempted.

setRetryInterval

public void setRetryInterval(int retryInt)

Sets the amount of time in milliseconds to wait before re-attempting a timed-out request to the Branch API.

Parameters:

retryInt - An Integer value specifying the number of milliseconds to wait before re-attempting a timed-out request.

getRetryInterval

public int getRetryInterval()

Gets the amount of time in milliseconds to wait before re-attempting a timed-out request to the Branch API.

Returns:

An Integer value containing the currently set retry interval in milliseconds.

setAppVersion

public void setAppVersion(java.lang.String version)

Sets the value of KEY_APP_VERSION in preferences.

Parameters:

version - A String value containing the current app version.

getAppVersion

public java.lang.String getAppVersion()

Returns the current value of KEY_APP_VERSION as stored in preferences.

Returns:

A String value containing the current app version.

setBranchKey

public boolean setBranchKey(java.lang.String key)

Set the given Branch Key to preference. Clears the preference data if the key is a new key.

Parameters:

key - A String representing Branch Key.

Returns:

A Boolean which is true if the key set is a new key. On Setting a new key need to clear all preference items.

getBranchKey

public java.lang.String getBranchKey()

setDeviceFingerPrintID

public void setDeviceFingerPrintID(java.lang.String device_fingerprint_id)

Sets the Build.FINGERPRINT value of the current OS build, on the current device, as a String in preferences.

Parameters:

device_fingerprint_id - A String that uniquely identifies this build.

getDeviceFingerPrintID

public java.lang.String getDeviceFingerPrintID()

Gets the Build.FINGERPRINT value of the current OS build, on the current device, as a String from preferences.

Returns:

A String that uniquely identifies this build.

setSessionID

public void setSessionID(java.lang.String session_id)

Sets the ID of the KEY_SESSION_ID String value in preferences.

Parameters:

session_id - A String value containing the session ID as returned by the Branch API upon successful initialisation.

getSessionID

public java.lang.String getSessionID()

Gets the ID of the KEY_SESSION_ID String value from preferences.

Returns:

A String value containing the session ID as returned by the Branch API upon successful initialisation.

setIdentityID

public void setIdentityID(java.lang.String identity_id)

Sets the KEY_IDENTITY_ID String value that has been set via the Branch API.

This is used to identify a specific user ID and link that to a current session. Useful both for analytics and debugging purposes.

Note: Not to be confused with setIdentity(String) - the name of the user

Parameters:

identity_id - A String value containing the currently configured identity within preferences.

getIdentityID

public java.lang.String getIdentityID()

Gets the KEY_IDENTITY_ID String value that has been set via the Branch API.

Returns:

A String value containing the currently configured user id within preferences.

setIdentity

public void setIdentity(java.lang.String identity)

Sets the KEY_IDENTITY String value that has been set via the Branch API.

This is used to identify a specific user identity and link that to a current session. Useful both for analytics and debugging purposes.

Note: Not to be confused with setIdentityID(String) - the UID reference of the user

Parameters:

identity - A String value containing the currently configured identity within preferences.

getIdentity

public java.lang.String getIdentity()

Gets the KEY_IDENTITY String value that has been set via the Branch API.

This is used to identify a specific user identity and link that to a current session. Useful both for analytics and debugging purposes.

Returns:

A String value containing the username assigned to the currentuser ID.

setLinkClickID

public void setLinkClickID(java.lang.String link_click_id)

Sets the KEY_LINK_CLICK_ID String value that has been set via the Branch API.

Parameters:

link_click_id - A String value containing the identifier of the associated link.

getLinkClickID

public java.lang.String getLinkClickID()

Gets the KEY_LINK_CLICK_ID String value that has been set via the Branch API.

Returns:

A String value containing the identifier of the associated link.

setIsAppLinkTriggeredInit

public void setIsAppLinkTriggeredInit(java.lang.Boolean isAppLinkTriggered)

Set the value to specify if the current init is triggered by an FB app link

Parameters:

isAppLinkTriggered - Boolean with value for triggered by an FB app link state

getIsAppLinkTriggeredInit

public boolean getIsAppLinkTriggeredInit()

Specifies the value to specify if the current init is triggered by an FB app link

Returns:

Boolean with value true if the init is triggered by an FB app link

setExternalIntentUri

public void setExternalIntentUri(java.lang.String uri)

Sets the KEY_EXTERNAL_INTENT_URI with value with given intent URI String.

Parameters:

uri - A String value containing intent URI to set

getExternalIntentUri

public java.lang.String getExternalIntentUri()

Gets the KEY_EXTERNAL_INTENT_URI String value that has been set via the Branch API.

Returns:

A String value containing external URI set.

setExternalIntentExtra

public void setExternalIntentExtra(java.lang.String extras)

Sets the KEY_EXTERNAL_INTENT_EXTRA with value with given intent extras in string format.

Parameters:

extras - A String value containing intent URI extra to set

getExternalIntentExtra

public java.lang.String getExternalIntentExtra()

Gets the KEY_EXTERNAL_INTENT_EXTRA String value that has been set via the Branch API.

Returns:

A String value containing external intent extra set.

setLinkClickIdentifier

public void setLinkClickIdentifier(java.lang.String identifier)

Sets the KEY_LINK_CLICK_IDENTIFIER String value that has been set via the Branch API.

Parameters:

identifier - A String value containing the identifier of the associated link.

getLinkClickIdentifier

public java.lang.String getLinkClickIdentifier()

Gets the KEY_LINK_CLICK_IDENTIFIER String value that has been set via the Branch API.

Returns:

A String value containing the identifier of the associated link.

setGoogleSearchInstallIdentifier

public void setGoogleSearchInstallIdentifier(java.lang.String identifier)

Sets the Google install referrer identifier to the pref

Parameters:

identifier - Google install referrer identifier

getGoogleSearchInstallIdentifier

public java.lang.String getGoogleSearchInstallIdentifier()

Gets the google install referrer identifier

Returns:

String google install referrer identifier

setGooglePlayReferrer

public void setGooglePlayReferrer(java.lang.String referrer)

Sets the Google play install referrer string

Parameters:

referrer - Google play install referrer string

getGooglePlayReferrer

public java.lang.String getGooglePlayReferrer()

Gets the google play install referrer string

Returns:

String Google play install referrer string

setAppLink

public void setAppLink(java.lang.String appLinkUrl)

Set the KEY_APP_LINK String values that has been started the application.

Parameters:

appLinkUrl - The App link which started this application

getAppLink

public java.lang.String getAppLink()

Get the App link which statrted the application.

Returns:

A String value of App link url

setIsFullAppConversion

public void setIsFullAppConversion(boolean isFullAppConversion)

Set the value for the full app conversion state. If set true indicate that this session is initiated by a full app conversion flow

Parameters:

isFullAppConversion - Boolean with value for full app conversion state

isFullAppConversion

public boolean isFullAppConversion()

Get the value for the full app conversion state.

Returns:

true if the session is initiated by a full app conversion flow

setPushIdentifier

public void setPushIdentifier(java.lang.String pushIdentifier)

Set the KEY_PUSH_IDENTIFIER String values that has been started the application.

Parameters:

pushIdentifier - The Branch url with the push notification which started the app.

getPushIdentifier

public java.lang.String getPushIdentifier()

Get the branch url in push payload which started the application.

Returns:

A String value of push identifier

getSessionParams

public java.lang.String getSessionParams()

Gets the session parameters as currently set in preferences.

Parameters are stored in JSON format, and must be parsed prior to access.

Returns:

A String value containing the JSON-encoded structure of parameters for the current session.

setSessionParams

public void setSessionParams(java.lang.String params)

Sets the session parameters as currently set in preferences.

Parameters:

params - A String value containing the JSON-encoded structure of parameters for the current session.

getInstallParams

public java.lang.String getInstallParams()

Gets the session parameters as originally set at time of app installation, in preferences.

Returns:

A String value containing the JSON-encoded structure of parameters as they were at the time of installation.

setInstallParams

public void setInstallParams(java.lang.String params)

Sets the session parameters as originally set at time of app installation, in preferences.

Parameters:

params - A String value containing the JSON-encoded structure of parameters as they should be at the time of installation.

setInstallReferrerParams

public void setInstallReferrerParams(java.lang.String params)

getInstallReferrerParams

public java.lang.String getInstallReferrerParams()

setUserURL

public void setUserURL(java.lang.String user_url)

Sets the user URL from preferences.

Parameters:

user_url - A String value containing the current user URL.

getUserURL

public java.lang.String getUserURL()

Sets the user URL from preferences.

Returns:

A String value containing the current user URL.

getIsReferrable

public int getIsReferrable()

Gets the Integer value of the preference setting KEY_IS_REFERRABLE, which indicates whether or not the current session should be considered referrable.

Returns:

A Integer value indicating whether or not the session should be considered referrable.

setIsReferrable

public void setIsReferrable()

Sets the KEY_IS_REFERRABLE value in preferences to 1, or true if parsed as a Boolean. This value is used by the Branch object.

• Sets KEY_IS_REFERRABLE to 1 - true - This session is referrable.

clearIsReferrable

public void clearIsReferrable()

Sets the KEY_IS_REFERRABLE value in preferences to 0, or false if parsed as a Boolean. This value is used by the Branch object.

• Sets KEY_IS_REFERRABLE to 0 - false - This session is not referrable.

clearSystemReadStatus

public void clearSystemReadStatus()

Resets the time that the system was last read. This is used to calculate how "stale" the values are that are in use in preferences.

clearUserValues

public void clearUserValues()

Resets the user-related values that have been stored in preferences. This will cause a sync to occur whenever a method reads any of the values and finds the value to be 0 or unset.

setCreditCount

public void setCreditCount(int count)

Sets the credit count for the default bucket to the specified Integer, in preferences.

Note: This does not set the actual value of the bucket itself on the Branch server, but only the cached value as stored in preferences for the current app. The age of that value should be checked before being considered accurate; read KEY_LAST_READ_SYSTEM to see when the last system sync occurred.

Parameters:

count - A Integer value that the default bucket credit count will be set to.

setCreditCount

public void setCreditCount(java.lang.String bucket,
                           int count)

Sets the credit count for the default bucket to the specified Integer, in preferences.

Note: This does not set the actual value of the bucket itself on the Branch server, but only the cached value as stored in preferences for the current app. The age of that value should be checked before being considered accurate; read KEY_LAST_READ_SYSTEM to see when the last system sync occurred.

Parameters:

bucket - A String value containing the value of the bucket being referenced.

count - A Integer value that the default bucket credit count will be set to.

getCreditCount

public int getCreditCount()

Get the current cached credit count for the default bucket, as currently stored in preferences for the current app.

Returns:

A Integer value specifying the current number of credits in the bucket, as currently stored in preferences.

getCreditCount

public int getCreditCount(java.lang.String bucket)

Get the current cached credit count for the default bucket, as currently stored in preferences for the current app.

Parameters:

bucket - A String value containing the value of the bucket being referenced.

Returns:

A Integer value specifying the current number of credits in the bucket, as currently stored in preferences.

setActionTotalCount

public void setActionTotalCount(java.lang.String action,
                                int count)

Sets the count of total number of times that the specified action has been carried out during the current session, as defined in preferences.

Parameters:

action - - A String value containing the name of the action to return the count for.

count - - An Integer value containing the total number of times that the specified action has been carried out during the current session.

setActionUniqueCount

public void setActionUniqueCount(java.lang.String action,
                                 int count)

Sets the count of the unique number of times that the specified action has been carried out during the current session, as defined in preferences.

Parameters:

action - A String value containing the name of the action to return the count for.

count - An Integer value containing the total number of times that the specified action has been carried out during the current session.

getActionTotalCount

public int getActionTotalCount(java.lang.String action)

Gets the count of total number of times that the specified action has been carried out during the current session, as defined in preferences.

Parameters:

action - A String value containing the name of the action to return the count for.

Returns:

An Integer value containing the total number of times that the specified action has been carried out during the current session.

getActionUniqueCount

public int getActionUniqueCount(java.lang.String action)

Gets the count of the unique number of times that the specified action has been carried out during the current session, as defined in preferences.

Parameters:

action - A String value containing the name of the action to return the count for.

Returns:

An Integer value containing the total number of times that the specified action has been carried out during the current session.

getInteger

public int getInteger(java.lang.String key)

A basic method that returns an integer value from a specified preferences Key.

Parameters:

key - A String value containing the key to reference.

Returns:

An Integer value of the specified key as stored in preferences.

getInteger

public int getInteger(java.lang.String key,
                      int defaultValue)

A basic method that returns an Integer value from a specified preferences Key, with a default value supplied in case the value is null.

Parameters:

key - A String value containing the key to reference.

defaultValue - An Integer specifying the value to use if the preferences value is null.

Returns:

An Integer value containing the value of the specified key, or the supplied default value if null.

getLong

public long getLong(java.lang.String key)

A basic method that returns a Long value from a specified preferences Key.

Parameters:

key - A String value containing the key to reference.

Returns:

A Long value of the specified key as stored in preferences.

getFloat

public float getFloat(java.lang.String key)

A basic method that returns a Float value from a specified preferences Key.

Parameters:

key - A String value containing the key to reference.

Returns:

A Float value of the specified key as stored in preferences.

getString

public java.lang.String getString(java.lang.String key)

A basic method that returns a String value from a specified preferences Key.

Parameters:

key - A String value containing the key to reference.

Returns:

A String value of the specified key as stored in preferences.

getBool

public boolean getBool(java.lang.String key)

A basic method that returns a Boolean value from a specified preferences Key.

Parameters:

key - A String value containing the key to reference.

Returns:

An Boolean value of the specified key as stored in preferences.

setInteger

public void setInteger(java.lang.String key,
                       int value)

Sets the value of the String key value supplied in preferences.

Parameters:

key - A String value containing the key to reference.

value - An Integer value to set the preference record to.

setLong

public void setLong(java.lang.String key,
                    long value)

Sets the value of the String key value supplied in preferences.

Parameters:

key - A String value containing the key to reference.

value - A Long value to set the preference record to.

setFloat

public void setFloat(java.lang.String key,
                     float value)

Sets the value of the String key value supplied in preferences.

Parameters:

key - A String value containing the key to reference.

value - A Float value to set the preference record to.

setString

public void setString(java.lang.String key,
                      java.lang.String value)

Sets the value of the String key value supplied in preferences.

Parameters:

key - A String value containing the key to reference.

value - A String value to set the preference record to.

setBool

public void setBool(java.lang.String key,
                    java.lang.Boolean value)

Sets the value of the String key value supplied in preferences.

Parameters:

key - A String value containing the key to reference.

value - A Boolean value to set the preference record to.

updateBranchViewUsageCount

public void updateBranchViewUsageCount(java.lang.String branchViewId)

getBranchViewUsageCount

public int getBranchViewUsageCount(java.lang.String branchViewId)

getBranchAnalyticsData

public org.json.JSONObject getBranchAnalyticsData()

clearBranchAnalyticsData

public void clearBranchAnalyticsData()

saveBranchAnalyticsData

public void saveBranchAnalyticsData(org.json.JSONObject analyticsData)

saveLastStrongMatchTime

public void saveLastStrongMatchTime(long strongMatchCheckTime)

Saves the last strong match epoch time stamp

Parameters:

strongMatchCheckTime - epoch time stamp for last strong match

getLastStrongMatchTime

public long getLastStrongMatchTime()

Get the last strong match check epoch time

Returns:

Long with last strong match epoch timestamp

setRequestMetadata

public void setRequestMetadata(java.lang.String key,
                               java.lang.String value)

getRequestMetadata

public org.json.JSONObject getRequestMetadata()

getInstallMetadata

public org.json.JSONObject getInstallMetadata()

Debug

public static void Debug(java.lang.String message)

Creates a Debug message in the debugger. If debugging is disabled, this will fail silently.

Parameters:

message - A String value containing the debug message to record.

LogAlways

public static void LogAlways(java.lang.String message)