Added in API level 36

WallpaperDescription


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 for the immutable WallpaperDescription class

Inherited constants
Public methods
Int

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

Boolean
equals(other: Any?)

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

ComponentName?

PersistableBundle

CharSequence?

Uri?

MutableList<CharSequence!>

String?

Uri?

CharSequence?

Int

Returns a hash code value for the object.

WallpaperDescription.Builder

Convert the current description to a Builder.

String

Returns a string representation of the object.

Unit
writeToParcel(dest: Parcel, flags: Int)

Flatten this object in to a Parcel.

Properties
static Parcelable.Creator<WallpaperDescription!>

Public methods

describeContents

Added in API level 36
fun describeContents(): Int

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.

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

equals

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

Returns a hash code value for the object. This method is supported for the benefit of hash tables such as those provided by java.util.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.
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

Returns a string representation of the object.

Return
String a string representation of the object.

writeToParcel

Added in API level 36
fun writeToParcel(
    dest: Parcel,
    flags: Int
): Unit

Flatten this object in to a Parcel.

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 the following:

Properties

CREATOR

Added in API level 36
static val CREATOR: Parcelable.Creator<WallpaperDescription!>