io.didomi.sdk

Class ContextHelper

java.lang.Object

io.didomi.sdk.ContextHelper

public class ContextHelper
extends java.lang.Object

Helper class used to get formatted context information such as application name, agent name, etc. All the properties held here should not change throughout the lifecycle of the app so they can be computed at the beginning early in the lifecycle and then be queried.

Constructor Summary

Constructors

Constructor and Description
ContextHelper()

Method Summary

Modifier and Type	Method and Description
java.lang.String	getAdvertisingId() Get the advertising ID from the device
java.lang.String	getAgentName() Method used to get the agent name.
java.lang.String	getAPIURL() Get the URL to the API
java.lang.String	getDidomiIABConfigurationURL(java.lang.String tcfVersion) Get the IAB configuration URL
java.lang.String	getDidomiRemoteConfigurationURL(java.lang.String apiKey, java.lang.String noticeId) Get the Didomi Remote Configuration URL
int	getImageResourceId(android.content.Context context, java.lang.String name) Method used to get the Resource ID of images from the res/drawable folder.
java.lang.String	getPackageName() Method used to get the package name.
java.lang.String	getPlatformSourceType() Get current platform type
java.lang.String	getSDKURL() Get the URL of the SDK
java.lang.String	getSDKVersionName() Get the name of the current SDK version
void	initialize(android.content.Context context, android.content.SharedPreferences sharedPreferences) Initialize the context helper
boolean	isAndroidTV() Boolean used to determine if app is running on an AndroidTV or not.
void	setUserAgent(java.lang.String name, java.lang.String version) Set custom user agent name and version

Methods inherited from class java.lang.Object

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

Constructor Detail

ContextHelper

public ContextHelper()

Method Detail

initialize

public void initialize(android.content.Context context,
                       android.content.SharedPreferences sharedPreferences)

Initialize the context helper

Parameters:

context -

sharedPreferences -

setUserAgent

public void setUserAgent(java.lang.String name,
                         java.lang.String version)

Set custom user agent name and version

Parameters:

name - Name of the user agent

version - Version of the user agent

getAgentName

public java.lang.String getAgentName()

Method used to get the agent name.

Returns:

getPackageName

public java.lang.String getPackageName()

Method used to get the package name.

Returns:

getAdvertisingId

public java.lang.String getAdvertisingId()

Get the advertising ID from the device

Returns:

getSDKVersionName

public java.lang.String getSDKVersionName()

Get the name of the current SDK version

Returns:

getAPIURL

public java.lang.String getAPIURL()

Get the URL to the API

Returns:

getSDKURL

public java.lang.String getSDKURL()

Get the URL of the SDK

Returns:

getPlatformSourceType

public java.lang.String getPlatformSourceType()

Get current platform type

Returns:

the platform as String

getDidomiRemoteConfigurationURL

public java.lang.String getDidomiRemoteConfigurationURL(java.lang.String apiKey,
                                                        java.lang.String noticeId)

Get the Didomi Remote Configuration URL

Returns:

getDidomiIABConfigurationURL

public java.lang.String getDidomiIABConfigurationURL(java.lang.String tcfVersion)

Get the IAB configuration URL

Parameters:

tcfVersion - "v1" or "v2"

Returns:

getImageResourceId

public int getImageResourceId(android.content.Context context,
                              java.lang.String name)

Method used to get the Resource ID of images from the res/drawable folder.

Parameters:

context - application context

name - image name to find in the image folder.

Returns:

resource ID corresponding to the image we want to load.

isAndroidTV

public boolean isAndroidTV()

Boolean used to determine if app is running on an AndroidTV or not.

Returns:

true if app is running on AndroidTV, false otherwise.