Stay organized with collections
Save and categorize content based on your preferences.
WallpaperDescription
class WallpaperDescription : Parcelable
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
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
describeContents
fun describeContents(): Int
equals
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
fun getComponent(): ComponentName?
Return |
ComponentName? |
the component for this wallpaper, or null for a static wallpaper |
getContextDescription
fun getContextDescription(): CharSequence?
Return |
CharSequence? |
the description for the action associated with the wallpaper, or null if not provided |
getContextUri
fun getContextUri(): Uri?
Return |
Uri? |
the Uri for the action associated with the wallpaper, or null if not provided |
getId
fun getId(): String?
Return |
String? |
the id for this wallpaper, or null if not provided |
getThumbnail
fun getThumbnail(): Uri?
Return |
Uri? |
the thumbnail for this wallpaper, or null if not provided |
hashCode
fun hashCode(): Int
Return |
Int |
a hash code value for this object. |
Properties
Content and code samples on this page are subject to the licenses described in the Content License. Java and OpenJDK are trademarks or registered trademarks of Oracle and/or its affiliates.
Last updated 2025-02-13 UTC.
[[["Easy to understand","easyToUnderstand","thumb-up"],["Solved my problem","solvedMyProblem","thumb-up"],["Other","otherUp","thumb-up"]],[["Missing the information I need","missingTheInformationINeed","thumb-down"],["Too complicated / too many steps","tooComplicatedTooManySteps","thumb-down"],["Out of date","outOfDate","thumb-down"],["Samples / code issue","samplesCodeIssue","thumb-down"],["Other","otherDown","thumb-down"]],["Last updated 2025-02-13 UTC."],[],[]]