Added in API level 34

OverlayInfo


class OverlayInfo : Parcelable

An immutable information about an overlay.

Applications calling OverlayManager#getOverlayInfosForTarget(String) get the information list of the registered overlays. Each element in the list presents the information of the particular overlay.

Summary

Inherited constants
Int CONTENTS_FILE_DESCRIPTOR

Descriptor bit used with describeContents(): indicates that the Parcelable object's flattened representation includes a file descriptor.

Int PARCELABLE_WRITE_RETURN_VALUE

Flag for use with writeToParcel: the object being written is a return value, that is the result of a function such as "Parcelable someFunction()", "void someFunction(out Parcelable)", or "void someFunction(inout Parcelable)". Some implementations may want to release resources at this point.

Public methods
Int

OverlayIdentifier

Get the unique identifier from the overlay information.

String?

Get the overlay name from the registered fabricated overlay.

String?

Return the target overlayable name.

String

Returns the name of the target overlaid package.

Unit
writeToParcel(dest: Parcel, flags: Int)

Flatten this object in to a Parcel.

Properties
static Parcelable.Creator<OverlayInfo!>

Public methods

describeContents

Added in API level 34
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

getOverlayIdentifier

Added in API level 34
fun getOverlayIdentifier(): OverlayIdentifier

Get the unique identifier from the overlay information.

The return value of this function can be used to unregister the related overlay.

Return
OverlayIdentifier an identifier representing the current overlay. This value cannot be null.

getOverlayName

Added in API level 34
fun getOverlayName(): String?

Get the overlay name from the registered fabricated overlay.

Return
String? the overlay name This value may be null.

getTargetOverlayableName

Added in API level 34
fun getTargetOverlayableName(): String?

Return the target overlayable name.

Return
String? the name of the target overlayable resources set This value may be null.

getTargetPackageName

Added in API level 34
fun getTargetPackageName(): String

Returns the name of the target overlaid package.

Return
String the target package name This value cannot be null.

writeToParcel

Added in API level 34
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

Added in API level 34
static val CREATOR: Parcelable.Creator<OverlayInfo!>

Discover the latest app development tools, platform updates, training, and documentation for developers across every Android device.

Updated Dec 11, 2024

Discover the latest app development tools, platform updates, training, and documentation for developers across every Android device.

Updated Apr 4, 2024

In this codelab, you will install Android 11 Generic System Image (GSI) to Android 9 (Pie) devices. After that, you can develop and validate your application with the new OS!

Updated Jan 3, 2024