Added in API level Baklava

WallpaperInstance

---

Kotlin |Java

class WallpaperInstance : Parcelable

kotlin.Any
↳	android.app.wallpaper.WallpaperInstance

Describes a wallpaper that has been set as a current wallpaper.

This class is used by android.app.WallpaperManager to store information about a wallpaper that is currently in use. Because it has been set as an active wallpaper it offers some guarantees that WallpaperDescription does not:

• It contains the WallpaperInfo corresponding to the android.content.ComponentName
specified in the description
• getId() is guaranteed to be non-null

Summary

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 constructors
WallpaperInstance(info: WallpaperInfo?, description: WallpaperDescription) Create a WallpaperInstance for the wallpaper given by WallpaperDescription.

Public methods
Int	describeContents()
Boolean	equals(other: Any?)
WallpaperDescription	getDescription()
String	getId() See WallpaperDescription.Builder.getId() for rules about id uniqueness.
WallpaperInfo?	getInfo()
Int	hashCode()
Unit	writeToParcel(dest: Parcel, flags: Int)

Properties
static Parcelable.Creator<WallpaperInstance!>	CREATOR

Public constructors

WallpaperInstance

Added in API level Baklava

WallpaperInstance(
    info: WallpaperInfo?, 
    description: WallpaperDescription)

Create a WallpaperInstance for the wallpaper given by WallpaperDescription.

Parameters
info	WallpaperInfo?: the live wallpaper info for this wallpaper, or null if static
description	WallpaperDescription: description of the wallpaper for this instance

Public methods

describeContents

Added in API level Baklava

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 Baklava

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.

getDescription

Added in API level Baklava

fun getDescription(): WallpaperDescription

Return
WallpaperDescription	the description for this wallpaper

getId

Added in API level Baklava

fun getId(): String

See WallpaperDescription.Builder.getId() for rules about id uniqueness.

Return
String	the ID of the wallpaper instance if given by the wallpaper description, otherwise a default value

getInfo

Added in API level Baklava

fun getInfo(): WallpaperInfo?

Return
WallpaperInfo?	the live wallpaper info, or null if static

hashCode

Added in API level Baklava

fun hashCode(): Int

Return
Int	a hash code value for this object.

writeToParcel

Added in API level Baklava

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 Baklava

static val CREATOR: Parcelable.Creator<WallpaperInstance!>