com.microsoft.applicationinsights.library

Class TelemetryContext

java.lang.Object

com.microsoft.applicationinsights.library.TelemetryContext

public class TelemetryContext
extends java.lang.Object

This class is holding all telemetryContext information.

Constructor Summary

Constructors

Modifier	Constructor and Description
protected	TelemetryContext(Context context, java.lang.String instrumentationKey, User user) Constructs a new INSTANCE of the Telemetry telemetryContext tag keys

Method Summary

Modifier and Type	Method and Description
protected void	configAppContext(Context appContext) Sets the application telemetryContext tags
protected void	configDeviceContext(Context appContext) Sets the device telemetryContext tags
protected void	configInternalContext(Context appContext) Sets the internal package context
protected void	configSessionContext() Sets the session context
protected void	configUserContext(java.lang.String userId) Sets the user Id.
protected void	configUserContext(User user) set the user for the user context associated with telemetry data.
java.lang.String	getAccountId()
java.lang.String	getAnonymousUserAcquisitionDate()
java.lang.String	getAppVersion()
java.lang.String	getAuthenticatedUserAcquisitionDate()
java.lang.String	getAuthenticatedUserId()
protected java.util.Map<java.lang.String,java.lang.String>	getContextTags()
java.lang.String	getDeviceId()
java.lang.String	getDeviceModel()
java.lang.String	getDeviceOemName()
java.lang.String	getDeviceType()
java.lang.String	getInstrumentationKey()
java.lang.String	getIsFirstSession()
java.lang.String	getIsNewSession()
java.lang.String	getNetworkType()
java.lang.String	getOsLocale()
java.lang.String	getOsName()
java.lang.String	getOsVersion()
protected java.lang.String	getPackageName() The package name
java.lang.String	getScreenResolution()
java.lang.String	getSdkVersion()
java.lang.String	getSessionId()
protected static TelemetryContext	getSharedInstance()
java.lang.String	getUserAcqusitionDate()
java.lang.String	getUserId()
protected static void	initialize(Context context, java.lang.String instrumentationKey, User user) Initialize the INSTANCE of the telemetryContext
protected void	loadUserInfo() Load user information to shared preferences.
static TelemetryContext	newInstance()
protected void	renewSessionId() Renews the session context The session ID is on demand.
protected void	renewSessionId(java.lang.String sessionId) Renews the session context with a custom session ID.
void	resetContext()
protected void	saveUserInfo() Write user information to shared preferences.
void	setAccountId(java.lang.String accountId)
void	setAnonymousUserAcquisitionDate(java.lang.String anonymousUserAcquisitionDate)
void	setAppVersion(java.lang.String appVersion)
void	setAuthenticatedUserAcquisitionDate(java.lang.String authenticatedUserAcquisitionDate)
void	setAuthenticatedUserId(java.lang.String authenticatedUserId)
void	setDeviceId(java.lang.String deviceId)
void	setDeviceModel(java.lang.String deviceModel)
void	setDeviceOemName(java.lang.String deviceOemName)
void	setDeviceType(java.lang.String deviceType)
void	setInstrumentationKey(java.lang.String instrumentationKey)
void	setIsFirstSession(java.lang.String isFirst)
void	setIsNewSession(java.lang.String isFirst)
void	setNetworkType(java.lang.String networkType)
void	setOsLocale(java.lang.String osLocale)
void	setOsName(java.lang.String osName)
void	setOsVersion(java.lang.String osVersion)
void	setScreenResolution(java.lang.String screenResolution)
void	setSdkVersion(java.lang.String sdkVersion)
void	setSessionId(java.lang.String sessionId)
void	setUserAcqusitionDate(java.lang.String userAcqusitionDate)
void	setUserId(java.lang.String userId)
protected void	updateScreenResolution(Context context)

Methods inherited from class java.lang.Object

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

Constructor Detail

TelemetryContext

protected TelemetryContext(Context context,
                           java.lang.String instrumentationKey,
                           User user)

Constructs a new INSTANCE of the Telemetry telemetryContext tag keys

Parameters:

context - the context for this telemetryContext

instrumentationKey - the instrumentationkey for this application

user - a custom user object that will be assiciated with the telemetry data

Method Detail

newInstance

public static TelemetryContext newInstance()

Returns:

the INSTANCE of persistence or null if not yet initialized

resetContext

public void resetContext()

initialize

protected static void initialize(Context context,
                                 java.lang.String instrumentationKey,
                                 User user)

Initialize the INSTANCE of the telemetryContext

Parameters:

context - the context for this telemetryContext

instrumentationKey - the instrumentationkey for this application

user - a custom user object that will be assiciated with the telemetry data

getSharedInstance

protected static TelemetryContext getSharedInstance()

Returns:

the INSTANCE of persistence or null if not yet initialized

renewSessionId

protected void renewSessionId()

Renews the session context The session ID is on demand. Additionally, the isFirst flag is set if no data was found in settings and the isNew flag is set each time a new UUID is generated.

renewSessionId

protected void renewSessionId(java.lang.String sessionId)

Renews the session context with a custom session ID.

Parameters:

sessionId - a custom session ID

configSessionContext

protected void configSessionContext()

Sets the session context

configAppContext

protected void configAppContext(Context appContext)

Sets the application telemetryContext tags

Parameters:

appContext - the android context

configUserContext

protected void configUserContext(java.lang.String userId)

Sets the user Id. This method has been made protected to make sure it's not accessed from outside the SDK

Parameters:

userId - custom user id

configUserContext

protected void configUserContext(User user)

set the user for the user context associated with telemetry data.

Parameters:

user - The user object In case the user object that is passed is null, a new user object will be generated. If the user is missing a property, they will be generated, too.

saveUserInfo

protected void saveUserInfo()

Write user information to shared preferences.

loadUserInfo

protected void loadUserInfo()

Load user information to shared preferences.

configDeviceContext

protected void configDeviceContext(Context appContext)

Sets the device telemetryContext tags

Parameters:

appContext - the android Context

updateScreenResolution

protected void updateScreenResolution(Context context)

configInternalContext

protected void configInternalContext(Context appContext)

Sets the internal package context

getPackageName

protected java.lang.String getPackageName()

The package name

See Also:

appIdForEnvelope

getContextTags

protected java.util.Map<java.lang.String,java.lang.String> getContextTags()

getInstrumentationKey

public java.lang.String getInstrumentationKey()

setInstrumentationKey

public void setInstrumentationKey(java.lang.String instrumentationKey)

getScreenResolution

public java.lang.String getScreenResolution()

setScreenResolution

public void setScreenResolution(java.lang.String screenResolution)

getAppVersion

public java.lang.String getAppVersion()

setAppVersion

public void setAppVersion(java.lang.String appVersion)

getUserId

public java.lang.String getUserId()

setUserId

public void setUserId(java.lang.String userId)

getUserAcqusitionDate

public java.lang.String getUserAcqusitionDate()

setUserAcqusitionDate

public void setUserAcqusitionDate(java.lang.String userAcqusitionDate)

getAccountId

public java.lang.String getAccountId()

setAccountId

public void setAccountId(java.lang.String accountId)

getAuthenticatedUserId

public java.lang.String getAuthenticatedUserId()

setAuthenticatedUserId

public void setAuthenticatedUserId(java.lang.String authenticatedUserId)

getAuthenticatedUserAcquisitionDate

public java.lang.String getAuthenticatedUserAcquisitionDate()

setAuthenticatedUserAcquisitionDate

public void setAuthenticatedUserAcquisitionDate(java.lang.String authenticatedUserAcquisitionDate)

getAnonymousUserAcquisitionDate

public java.lang.String getAnonymousUserAcquisitionDate()

setAnonymousUserAcquisitionDate

public void setAnonymousUserAcquisitionDate(java.lang.String anonymousUserAcquisitionDate)

getSdkVersion

public java.lang.String getSdkVersion()

setSdkVersion

public void setSdkVersion(java.lang.String sdkVersion)

getSessionId

public java.lang.String getSessionId()

setSessionId

public void setSessionId(java.lang.String sessionId)

getIsFirstSession

public java.lang.String getIsFirstSession()

setIsFirstSession

public void setIsFirstSession(java.lang.String isFirst)

getIsNewSession

public java.lang.String getIsNewSession()

setIsNewSession

public void setIsNewSession(java.lang.String isFirst)

getOsVersion

public java.lang.String getOsVersion()

setOsVersion

public void setOsVersion(java.lang.String osVersion)

getOsName

public java.lang.String getOsName()

setOsName

public void setOsName(java.lang.String osName)

getDeviceModel

public java.lang.String getDeviceModel()

setDeviceModel

public void setDeviceModel(java.lang.String deviceModel)

getDeviceOemName

public java.lang.String getDeviceOemName()

setDeviceOemName

public void setDeviceOemName(java.lang.String deviceOemName)

getOsLocale

public java.lang.String getOsLocale()

setOsLocale

public void setOsLocale(java.lang.String osLocale)

getDeviceId

public java.lang.String getDeviceId()

setDeviceId

public void setDeviceId(java.lang.String deviceId)

getDeviceType

public java.lang.String getDeviceType()

setDeviceType

public void setDeviceType(java.lang.String deviceType)

getNetworkType

public java.lang.String getNetworkType()

setNetworkType

public void setNetworkType(java.lang.String networkType)