added in API level 7

WallpaperInfo

public final class WallpaperInfo
extends Object implements Parcelable

java.lang.Object
↳	android.app.WallpaperInfo

This class is used to specify meta information of a wallpaper service.

Summary

Inherited constants

From interface


    android.os.Parcelable

Fields
`public static final Creator<WallpaperInfo>`	`CREATOR` Used to make this class parcelable.

Public constructors
`WallpaperInfo(Context context, ResolveInfo service)` Constructor.

Public methods
`int`	`describeContents()` Describe the kinds of special objects contained in this Parcelable instance's marshaled representation.
`void`	`dump(Printer pw, String prefix)`
`ComponentName`	`getComponent()` Return the component of the service that implements this wallpaper.
`String`	`getPackageName()` Return the .apk package that implements this wallpaper.
`ServiceInfo`	`getServiceInfo()` Return the raw information about the Service implementing this wallpaper.
`String`	`getServiceName()` Return the class name of the service component that implements this wallpaper.
`String`	`getSettingsActivity()` Return the class name of an activity that provides a settings UI for the wallpaper.
`boolean`	`getShowMetadataInPreview()` Queries whether any metadata should be shown when previewing the wallpaper.
`CharSequence`	`loadAuthor(PackageManager pm)` Return a string indicating the author(s) of this wallpaper.
`CharSequence`	`loadContextDescription(PackageManager pm)` Retrieves a title of the URI that specifies a link for further context about this wallpaper.
`Uri`	`loadContextUri(PackageManager pm)` Returns an URI that specifies a link for further context about this wallpaper.
`CharSequence`	`loadDescription(PackageManager pm)` Return a brief summary of this wallpaper's behavior.
`Drawable`	`loadIcon(PackageManager pm)` Load the user-displayed icon for this wallpaper.
`CharSequence`	`loadLabel(PackageManager pm)` Load the user-displayed label for this wallpaper.
`Drawable`	`loadThumbnail(PackageManager pm)` Load the thumbnail image for this wallpaper.
`String`	`toString()` Returns a string representation of the object.
`void`	`writeToParcel(Parcel dest, int flags)` Used to package this object into a `Parcel`.

Inherited methods

From class


  
    java.lang.Object

`Object`	`clone()` Creates and returns a copy of this object.
`boolean`	`equals(Object obj)` Indicates whether some other object is "equal to" this one.
`void`	`finalize()` Called by the garbage collector on an object when garbage collection determines that there are no more references to the object.
`final Class<?>`	`getClass()` Returns the runtime class of this `Object`.
`int`	`hashCode()` Returns a hash code value for the object.
`final void`	`notify()` Wakes up a single thread that is waiting on this object's monitor.
`final void`	`notifyAll()` Wakes up all threads that are waiting on this object's monitor.
`String`	`toString()` Returns a string representation of the object.
`final void`	`wait(long millis, int nanos)` Causes the current thread to wait until another thread invokes the `notify()` method or the `notifyAll()` method for this object, or some other thread interrupts the current thread, or a certain amount of real time has elapsed.
`final void`	`wait(long millis)` Causes the current thread to wait until either another thread invokes the `notify()` method or the `notifyAll()` method for this object, or a specified amount of time has elapsed.
`final void`	`wait()` Causes the current thread to wait until another thread invokes the `notify()` method or the `notifyAll()` method for this object.

From interface


  
    android.os.Parcelable

Fields

CREATOR

added in API level 7

Creator<WallpaperInfo> CREATOR

Used to make this class parcelable.

Public constructors

WallpaperInfo

added in API level 7

WallpaperInfo (Context context, 
                ResolveInfo service)

Constructor.

Parameters
`context`	`Context`: The Context in which we are parsing the wallpaper.
`service`	`ResolveInfo`: The ResolveInfo returned from the package manager about this wallpaper's component.

Throws
`XmlPullParserException`
`IOException`

Public methods

describeContents

added in API level 7

int describeContents ()

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(Parcel, int), the return value of this method must include the CONTENTS_FILE_DESCRIPTOR bit.

Returns
`int`	a bitmask indicating the set of special object types marshaled by this Parcelable object instance.

dump

added in API level 7

void dump (Printer pw, 
                String prefix)

Parameters
`pw`	`Printer`
`prefix`	`String`

getComponent

added in API level 7

ComponentName getComponent ()

Return the component of the service that implements this wallpaper.

Returns
`ComponentName`

getPackageName

added in API level 7

String getPackageName ()

Return the .apk package that implements this wallpaper.

Returns
`String`

getServiceInfo

added in API level 7

ServiceInfo getServiceInfo ()

Return the raw information about the Service implementing this wallpaper. Do not modify the returned object.

Returns
`ServiceInfo`

getServiceName

added in API level 7

String getServiceName ()

Return the class name of the service component that implements this wallpaper.

Returns
`String`

getSettingsActivity

added in API level 7

String getSettingsActivity ()

Return the class name of an activity that provides a settings UI for the wallpaper. You can launch this activity be starting it with an Intent whose action is MAIN and with an explicit ComponentName composed of getPackageName() and the class name returned here.

A null will be returned if there is no settings activity associated with the wallpaper.

Returns
`String`

getShowMetadataInPreview

added in API level 25

boolean getShowMetadataInPreview ()

Queries whether any metadata should be shown when previewing the wallpaper. If this value is set to true, any component that shows a preview of this live wallpaper should also show accompanying information like loadLabel(PackageManager), loadDescription(PackageManager), loadAuthor(PackageManager) and loadContextDescription(PackageManager), so the user gets to know further information about this wallpaper.

Returns
`boolean`	Whether any metadata should be shown when previewing the wallpaper.

loadAuthor

added in API level 7

CharSequence loadAuthor (PackageManager pm)

Return a string indicating the author(s) of this wallpaper.

Parameters
`pm`	`PackageManager`

Returns
`CharSequence`

Throws
`Resources.NotFoundException`

loadContextDescription

added in API level 25

CharSequence loadContextDescription (PackageManager pm)

Retrieves a title of the URI that specifies a link for further context about this wallpaper.

Parameters
`pm`	`PackageManager`: An instance of `PackageManager` to retrieve the title.

Returns
`CharSequence`	The title.

Throws
`Resources.NotFoundException`

loadContextUri

added in API level 25

Uri loadContextUri (PackageManager pm)

Returns an URI that specifies a link for further context about this wallpaper.

Parameters
`pm`	`PackageManager`: An instance of `PackageManager` to retrieve the URI.

Returns
`Uri`	The URI.

Throws
`Resources.NotFoundException`

loadDescription

added in API level 7

CharSequence loadDescription (PackageManager pm)

Return a brief summary of this wallpaper's behavior.

Parameters
`pm`	`PackageManager`

Returns
`CharSequence`

Throws
`Resources.NotFoundException`

loadIcon

added in API level 7

Drawable loadIcon (PackageManager pm)

Load the user-displayed icon for this wallpaper.

Parameters
`pm`	`PackageManager`: Supply a PackageManager used to load the wallpaper's resources.

Returns
`Drawable`

loadLabel

added in API level 7

CharSequence loadLabel (PackageManager pm)

Load the user-displayed label for this wallpaper.

Parameters
`pm`	`PackageManager`: Supply a PackageManager used to load the wallpaper's resources.

Returns
`CharSequence`

loadThumbnail

added in API level 7

Drawable loadThumbnail (PackageManager pm)

Load the thumbnail image for this wallpaper.

Parameters
`pm`	`PackageManager`: Supply a PackageManager used to load the wallpaper's resources.

Returns
`Drawable`

toString

added in API level 7

String toString ()

Returns a string representation of the object. In general, the toString method returns a string that "textually represents" this object. The result should be a concise but informative representation that is easy for a person to read. It is recommended that all subclasses override this method.

The toString method for class Object returns a string consisting of the name of the class of which the object is an instance, the at-sign character `@', and the unsigned hexadecimal representation of the hash code of the object. In other words, this method returns a string equal to the value of:

 getClass().getName() + '@' + Integer.toHexString(hashCode())

Returns
`String`	a string representation of the object.

writeToParcel

added in API level 7

void writeToParcel (Parcel dest, 
                int flags)

Used to package this object into a Parcel.

Parameters
`dest`	`Parcel`: The `Parcel` to be written.
`flags`	`int`: The flags used for parceling.

Most visited

Recently visited

Results for

WallpaperInfo

Summary

Inherited constants

Fields

Public constructors

Public methods

Inherited methods

Fields

CREATOR

Public constructors

WallpaperInfo

Public methods

describeContents

dump

getComponent

getPackageName

getServiceInfo

getServiceName

getSettingsActivity

getShowMetadataInPreview

loadAuthor

loadContextDescription

loadContextUri

loadDescription

loadIcon

loadLabel

loadThumbnail

toString

writeToParcel

Interfaces

Classes

Exceptions