Added in API level 36

WallpaperDescription

---

Kotlin |Java

class WallpaperDescription : Parcelable

kotlin.Any
↳	android.app.wallpaper.WallpaperDescription

Describes a wallpaper, including associated metadata and optional content to be used by its android.service.wallpaper.WallpaperService.Engine, the ComponentName to be used by android.app.WallpaperManager, and an optional id to differentiate between different distinct wallpapers rendered by the same wallpaper service.

This class is used to communicate among a wallpaper rendering service, a wallpaper chooser UI, and android.app.WallpaperManager. This class describes a specific instance of a live wallpaper, unlike WallpaperInfo which is common to all instances of a wallpaper component. Each WallpaperDescription can have distinct metadata.

Summary

Nested classes
	Builder Builder for the immutable WallpaperDescription class

Inherited constants

From class Parcelable 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	describeContents()
Boolean	equals(other: Any?)
ComponentName?	getComponent()
PersistableBundle	getContent()
CharSequence?	getContextDescription()
Uri?	getContextUri()
MutableList<CharSequence!>	getDescription()
String?	getId()
Uri?	getThumbnail()
CharSequence?	getTitle()
Int	hashCode()
WallpaperDescription.Builder	toBuilder() Convert the current description to a Builder.
String	toString()
Unit	writeToParcel(dest: Parcel, flags: Int)

Properties
static Parcelable.Creator<WallpaperDescription!>	CREATOR

Public methods

describeContents

Added in API level 36

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

Added in API level 36

fun equals(other: Any?): Boolean

Parameters
obj	the reference object with which to compare.

Return
Boolean	true if this object is the same as the obj argument; false otherwise.

getComponent

Added in API level 36

fun getComponent(): ComponentName?

Return
ComponentName?	the component for this wallpaper, or null for a static wallpaper

getContent

Added in API level 36

fun getContent(): PersistableBundle

Return
PersistableBundle	any additional content required to render this wallpaper

getContextDescription

Added in API level 36

fun getContextDescription(): CharSequence?

Return
CharSequence?	the description for the action associated with the wallpaper, or null if not provided

getContextUri

Added in API level 36

fun getContextUri(): Uri?

Return
Uri?	the Uri for the action associated with the wallpaper, or null if not provided

getDescription

Added in API level 36

fun getDescription(): MutableList<CharSequence!>

Return
MutableList<CharSequence!>	the description for this wallpaper, with each list element intended to be shown on a separate line in the UI

getId

Added in API level 36

fun getId(): String?

Return
String?	the id for this wallpaper, or null if not provided

getThumbnail

Added in API level 36

fun getThumbnail(): Uri?

Return
Uri?	the thumbnail for this wallpaper, or null if not provided

getTitle

Added in API level 36

fun getTitle(): CharSequence?

Return
CharSequence?	the title for this wallpaper, or null if not provided

hashCode

Added in API level 36

fun hashCode(): Int

Return
Int	a hash code value for this object.

toBuilder

Added in API level 36

fun toBuilder(): WallpaperDescription.Builder

Convert the current description to a Builder.

Return
WallpaperDescription.Builder	the Builder representing this description

toString

Added in API level 36

fun toString(): String

Return
String	a string representation of the object.

writeToParcel

Added in API level 36

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

Parameters
dest	Parcel: The Parcel in which the object should be written. 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 36

static val CREATOR: Parcelable.Creator<WallpaperDescription!>