UserData


class UserData : Parcelable
kotlin.Any
   ↳ android.adservices.ondevicepersonalization.UserData

User data provided by the platform to an IsolatedService.

Summary

Inherited constants
Public methods
Int

Boolean
equals(other: Any?)

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

MutableMap<String!, AppInfo!>

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

Long

The available space on device in bytes.

Int

Battery percentage.

String

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

Int

Data network type.

NetworkCapabilities?

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

Int

The device orientation.

Duration

The device timezone +/- offset from UTC.

Int

Unit
writeToParcel(dest: Parcel, flags: Int)

Flatten this object in to a Parcel.

Properties
static Parcelable.Creator<UserData!>

Public methods

describeContents

fun describeContents(): Int
Return
Int a bitmask indicating the set of special object types marshaled by this Parcelable object instance. Value is either 0 or android.os.Parcelable#CONTENTS_FILE_DESCRIPTOR

equals

fun equals(other: Any?): Boolean

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
obj the reference object with which to compare.
o This value may be null.
Return
Boolean true if this object is the same as the obj argument; false otherwise.

getAppInfos

fun getAppInfos(): MutableMap<String!, AppInfo!>

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

Return
MutableMap<String!, AppInfo!> This value cannot be null.

getAvailableStorageBytes

fun getAvailableStorageBytes(): Long

The available space on device in bytes.

Return
Long Value is 0 or greater

getBatteryPercentage

fun getBatteryPercentage(): Int

Battery percentage.

Return
Int Value is between 0 and 100 inclusive

getCarrier

fun getCarrier(): String

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

Return
String This value cannot be null.

getNetworkCapabilities

fun getNetworkCapabilities(): NetworkCapabilities?

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 android.net.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.

Return
NetworkCapabilities? This value may be null.

getOrientation

fun getOrientation(): Int

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

Return
Int Value is android.content.res.Configuration#ORIENTATION_UNDEFINED, android.content.res.Configuration#ORIENTATION_PORTRAIT, or android.content.res.Configuration#ORIENTATION_LANDSCAPE

getTimezoneUtcOffset

fun getTimezoneUtcOffset(): Duration

The device timezone +/- offset from UTC.

Return
Duration This value cannot be null.

hashCode

fun hashCode(): Int
Return
Int a hash code value for this object.

writeToParcel

fun writeToParcel(
    dest: Parcel,
    flags: Int
): Unit

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_WRITE_RETURN_VALUE. Value is either 0 or a combination of android.os.Parcelable#PARCELABLE_WRITE_RETURN_VALUE, and android.os.Parcelable.PARCELABLE_ELIDE_DUPLICATES

Properties

CREATOR

static val CREATOR: Parcelable.Creator<UserData!>