UserData


public final class UserData
extends Object implements Parcelable

java.lang.Object
   ↳ android.adservices.ondevicepersonalization.UserData


User data provided by the platform to an IsolatedService.

Summary

Inherited constants

Fields

public static final Creator<UserData> CREATOR

Public methods

int describeContents()

Describe the kinds of special objects contained in this Parcelable instance's marshaled representation.

boolean equals(Object o)

Indicates whether some other object is "equal to" this one.

Map<StringAppInfo> getAppInfos()

A map from package name to app information for installed and uninstalled apps.

long getAvailableStorageBytes()

The available space on device in bytes.

int getBatteryPercentage()

Battery percentage.

String getCarrier()

The Service Provider Name (SPN) returned by TelephonyManager.getSimOperatorName()

int getDataNetworkType()

Data network type.

NetworkCapabilities getNetworkCapabilities()

A filtered subset of the Network capabilities of the device that contains upstream and downstream speeds, and whether the network is metered.

int getOrientation()

The device orientation.

Duration getTimezoneUtcOffset()

The device timezone +/- offset from UTC.

int hashCode()

Returns a hash code value for the object.

void writeToParcel(Parcel dest, int flags)

Flatten this object in to a Parcel.

Inherited methods

Fields

CREATOR

Added in API level 35
public static final Creator<UserData> CREATOR

Public methods

describeContents

Added in API level 35
public int describeContents ()

Describe the kinds of special objects contained in this Parcelable instance's marshaled representation. For example, if the object will include a file descriptor in the output of writeToParcel(android.os.Parcel, int), the return value of this method must include the CONTENTS_FILE_DESCRIPTOR bit.

Returns
int a bitmask indicating the set of special object types marshaled by this Parcelable object instance. Value is either 0 or CONTENTS_FILE_DESCRIPTOR

equals

Added in API level 35
public boolean equals (Object o)

Indicates whether some other object is "equal to" this one.

The equals method implements an equivalence relation on non-null object references:

  • It is reflexive: for any non-null reference value x, x.equals(x) should return true.
  • It is symmetric: for any non-null reference values x and y, x.equals(y) should return true if and only if y.equals(x) returns true.
  • It is transitive: for any non-null reference values x, y, and z, if x.equals(y) returns true and y.equals(z) returns true, then x.equals(z) should return true.
  • It is consistent: for any non-null reference values x and y, multiple invocations of x.equals(y) consistently return true or consistently return false, provided no information used in equals comparisons on the objects is modified.
  • For any non-null reference value x, x.equals(null) should return false.

An equivalence relation partitions the elements it operates on into equivalence classes; all the members of an equivalence class are equal to each other. Members of an equivalence class are substitutable for each other, at least for some purposes.

Parameters
o Object: This value may be null.

Returns
boolean true if this object is the same as the obj argument; false otherwise.

getAppInfos

Added in API level 35
public Map<StringAppInfo> getAppInfos ()

A map from package name to app information for installed and uninstalled apps.

Returns
Map<StringAppInfo> This value cannot be null.

getAvailableStorageBytes

Added in API level 35
public long getAvailableStorageBytes ()

The available space on device in bytes.

Returns
long Value is 0 or greater

getBatteryPercentage

Added in API level 35
public int getBatteryPercentage ()

Battery percentage.

Returns
int Value is between 0 and 100 inclusive

getCarrier

Added in API level 35
public String getCarrier ()

The Service Provider Name (SPN) returned by TelephonyManager.getSimOperatorName()

Returns
String This value cannot be null.

getDataNetworkType

Added in API level 35
public int getDataNetworkType ()

Data network type. This is the value of TelephonyManager.getDataNetworkType().

Returns
int Value is TelephonyManager.NETWORK_TYPE_UNKNOWN, TelephonyManager.NETWORK_TYPE_GPRS, TelephonyManager.NETWORK_TYPE_EDGE, TelephonyManager.NETWORK_TYPE_UMTS, TelephonyManager.NETWORK_TYPE_CDMA, TelephonyManager.NETWORK_TYPE_EVDO_0, TelephonyManager.NETWORK_TYPE_EVDO_A, TelephonyManager.NETWORK_TYPE_1xRTT, TelephonyManager.NETWORK_TYPE_HSDPA, TelephonyManager.NETWORK_TYPE_HSUPA, TelephonyManager.NETWORK_TYPE_HSPA, TelephonyManager.NETWORK_TYPE_EVDO_B, TelephonyManager.NETWORK_TYPE_LTE, TelephonyManager.NETWORK_TYPE_EHRPD, TelephonyManager.NETWORK_TYPE_HSPAP, TelephonyManager.NETWORK_TYPE_GSM, TelephonyManager.NETWORK_TYPE_TD_SCDMA, TelephonyManager.NETWORK_TYPE_IWLAN, or TelephonyManager.NETWORK_TYPE_NR

getNetworkCapabilities

Added in API level 35
public NetworkCapabilities getNetworkCapabilities ()

A filtered subset of the Network capabilities of the device that contains upstream and downstream speeds, and whether the network is metered. This is an instance of NetworkCapabilities that contains the capability NetworkCapabilities.NET_CAPABILITY_NOT_METERED if the network is not metered, and NetworkCapabilities.getLinkDownstreamBandwidthKbps() and NetworkCapabilities.getLinkUpstreamBandwidthKbps() return the downstream and upstream connection speeds. All other methods of this NetworkCapabilities object return empty or default values.

Returns
NetworkCapabilities This value may be null.

getOrientation

Added in API level 35
public int getOrientation ()

The device orientation. The value can be one of the constants ORIENTATION_UNDEFINED, ORIENTATION_PORTRAIT or ORIENTATION_LANDSCAPE defined in Configuration.

Returns
int Value is Configuration.ORIENTATION_UNDEFINED, Configuration.ORIENTATION_PORTRAIT, or Configuration.ORIENTATION_LANDSCAPE

getTimezoneUtcOffset

Added in API level 35
public Duration getTimezoneUtcOffset ()

The device timezone +/- offset from UTC.

Returns
Duration This value cannot be null.

hashCode

Added in API level 35
public int hashCode ()

Returns a hash code value for the object. This method is supported for the benefit of hash tables such as those provided by HashMap.

The general contract of hashCode is:

  • Whenever it is invoked on the same object more than once during an execution of a Java application, the hashCode method must consistently return the same integer, provided no information used in equals comparisons on the object is modified. This integer need not remain consistent from one execution of an application to another execution of the same application.
  • If two objects are equal according to the equals method, then calling the hashCode method on each of the two objects must produce the same integer result.
  • It is not required that if two objects are unequal according to the equals method, then calling the hashCode method on each of the two objects must produce distinct integer results. However, the programmer should be aware that producing distinct integer results for unequal objects may improve the performance of hash tables.

Returns
int a hash code value for this object.

writeToParcel

Added in API level 35
public void writeToParcel (Parcel dest, 
                int flags)

Flatten this object in to a Parcel.

Parameters
dest Parcel: This value cannot be null.

flags int: Additional flags about how the object should be written. May be 0 or Parcelable.PARCELABLE_WRITE_RETURN_VALUE. Value is either 0 or a combination of Parcelable.PARCELABLE_WRITE_RETURN_VALUE, and android.os.Parcelable.PARCELABLE_ELIDE_DUPLICATES