com.mopub.common

Class ClientMetadata

java.lang.Object

com.mopub.common.ClientMetadata

public class ClientMetadata
extends java.lang.Object

Singleton that caches Client objects so they will be available to background threads.

Nested Class Summary

Nested Classes

Modifier and Type	Class and Description
static class	ClientMetadata.MoPubNetworkType

Constructor Summary

Constructors

Constructor and Description
ClientMetadata(android.content.Context context)

Method Summary

Methods

Modifier and Type	Method and Description
static void	clearForTesting()
ClientMetadata.MoPubNetworkType	getActiveNetworkType()
java.lang.String	getAppName()
java.lang.String	getAppPackageName()
java.lang.String	getAppVersion()
float	getDensity() Get the logical density of the display as in DisplayMetrics.density
android.graphics.Point	getDeviceDimensions() This tries to get the physical number of pixels on the device.
java.lang.String	getDeviceId()
java.util.Locale	getDeviceLocale()
java.lang.String	getDeviceManufacturer()
java.lang.String	getDeviceModel()
java.lang.String	getDeviceOsVersion()
java.lang.String	getDeviceProduct()
int	getDeviceScreenHeightDip()
int	getDeviceScreenWidthDip()
static ClientMetadata	getInstance() Can be used by background threads and other objects without a context to attempt to get ClientMetadata.
static ClientMetadata	getInstance(android.content.Context context) Returns the singleton ClientMetadata object, using the context to obtain data if necessary.
java.lang.String	getIsoCountryCode()
java.lang.String	getNetworkOperator()
java.lang.String	getNetworkOperatorForUrl()
java.lang.String	getNetworkOperatorName()
java.lang.String	getOrientationString()
java.lang.String	getSdkVersion()
java.lang.String	getSimIsoCountryCode()
java.lang.String	getSimOperator()
java.lang.String	getSimOperatorName()
boolean	isAdvertisingInfoSet()
boolean	isDoNotTrackSet()
void	setAdvertisingInfo(java.lang.String advertisingId, boolean doNotTrack)
static void	setInstance(ClientMetadata clientMetadata) Deprecated.

Methods inherited from class java.lang.Object

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

Constructor Detail

ClientMetadata

public ClientMetadata(android.content.Context context)

Method Detail

getInstance

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

Returns the singleton ClientMetadata object, using the context to obtain data if necessary.

getInstance

public static ClientMetadata getInstance()

Can be used by background threads and other objects without a context to attempt to get ClientMetadata. If the object has never been referenced from a thread with a context, this will return null.

getOrientationString

public java.lang.String getOrientationString()

Returns:

the display orientation. Useful when generating ad requests.

getActiveNetworkType

public ClientMetadata.MoPubNetworkType getActiveNetworkType()

getDensity

public float getDensity()

Get the logical density of the display as in DisplayMetrics.density

getNetworkOperatorForUrl

public java.lang.String getNetworkOperatorForUrl()

Returns:

the network operator for URL generators.

getNetworkOperator

public java.lang.String getNetworkOperator()

Returns:

the network operator.

getDeviceLocale

public java.util.Locale getDeviceLocale()

getSimOperator

public java.lang.String getSimOperator()

Returns:

the sim operator.

getIsoCountryCode

public java.lang.String getIsoCountryCode()

Returns:

the country code of the device.

getSimIsoCountryCode

public java.lang.String getSimIsoCountryCode()

Returns:

the sim provider's country code.

getNetworkOperatorName

public java.lang.String getNetworkOperatorName()

Returns:

the network operator name.

getSimOperatorName

public java.lang.String getSimOperatorName()

Returns:

the sim operator name.

getDeviceId

public java.lang.String getDeviceId()

Returns:

the stored device ID.

isDoNotTrackSet

public boolean isDoNotTrackSet()

Returns:

the user's do not track preference. Should be set whenever a getAdInfo() call is completed.

setAdvertisingInfo

public void setAdvertisingInfo(java.lang.String advertisingId,
                      boolean doNotTrack)

isAdvertisingInfoSet

public boolean isAdvertisingInfoSet()

getDeviceManufacturer

public java.lang.String getDeviceManufacturer()

Returns:

the device manufacturer.

getDeviceModel

public java.lang.String getDeviceModel()

Returns:

the device model identifier.

getDeviceProduct

public java.lang.String getDeviceProduct()

Returns:

the device product identifier.

getDeviceOsVersion

public java.lang.String getDeviceOsVersion()

Returns:

the device os version.

getDeviceScreenWidthDip

public int getDeviceScreenWidthDip()

Returns:

the device screen width in dips according to current orientation.

getDeviceScreenHeightDip

public int getDeviceScreenHeightDip()

Returns:

the device screen height in dips according to current orientation.

getDeviceDimensions

public android.graphics.Point getDeviceDimensions()

This tries to get the physical number of pixels on the device. This attempts to include the pixels in the notification bar and soft buttons. This method only works after mContext is initialized.

Returns:

Width and height of the device. This is 0 by 0 if there is no context.

getSdkVersion

public java.lang.String getSdkVersion()

Returns:

the MoPub SDK Version.

getAppVersion

public java.lang.String getAppVersion()

Returns:

the version of the application the SDK is included in.

getAppPackageName

public java.lang.String getAppPackageName()

Returns:

the package of the application the SDK is included in.

getAppName

public java.lang.String getAppName()

Returns:

the name of the application the SDK is included in.

setInstance

@Deprecated
public static void setInstance(ClientMetadata clientMetadata)

Deprecated.

clearForTesting

public static void clearForTesting()