Added in API level 36

WallpaperInstance

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:

Summary

Inherited constants
Public constructors

Create a WallpaperInstance for the wallpaper given by WallpaperDescription.
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.
WallpaperDescription

String

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

Int

Returns a hash code value for the object.
Unit
writeToParcel(dest: Parcel, flags: Int)

Flatten this object in to a Parcel.
Properties
static Parcelable.Creator<WallpaperInstance!>

Public constructors

WallpaperInstance

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

getDescription

Added in API level 36
fun getDescription(): WallpaperDescription
Return
WallpaperDescription the description for this wallpaper

getId

Added in API level 36
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 36
fun getInfo(): WallpaperInfo?
Return
WallpaperInfo? the live wallpaper info, or null if static

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.

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<WallpaperInstance!>