WallpaperManager.GetWallpaperInfo(WallpaperManagerFlags) Method

Reference

Definition

Namespace:: Android.App

Assembly:: Mono.Android.dll

Important

Some information relates to prerelease product that may be substantially modified before it’s released. Microsoft makes no warranties, express or implied, with respect to the information provided here.

Returns the information about the home screen wallpaper if its current wallpaper is a live wallpaper component.

[Android.Runtime.Register("getWallpaperInfo", "(I)Landroid/app/WallpaperInfo;", "GetGetWallpaperInfo_IHandler", ApiSince=34)]
public virtual Android.App.WallpaperInfo? GetWallpaperInfo (Android.App.WallpaperManagerFlags which);

[<Android.Runtime.Register("getWallpaperInfo", "(I)Landroid/app/WallpaperInfo;", "GetGetWallpaperInfo_IHandler", ApiSince=34)>]
abstract member GetWallpaperInfo : Android.App.WallpaperManagerFlags -> Android.App.WallpaperInfo
override this.GetWallpaperInfo : Android.App.WallpaperManagerFlags -> Android.App.WallpaperInfo

Parameters

which: WallpaperManagerFlags

Specifies wallpaper to request (home or lock).

Returns

WallpaperInfo

Attributes: RegisterAttribute

Remarks

Returns the information about the home screen wallpaper if its current wallpaper is a live wallpaper component. Otherwise, if the wallpaper is a static image or is not set, this returns null.

In order to use this, apps should declare a <queries> tag with the action "android.service.wallpaper.WallpaperService". Otherwise, this method will return null if the caller doesn't otherwise have visibility of the wallpaper package.

Java documentation for android.app.WallpaperManager.getWallpaperInfo(int).

Portions of this page are modifications based on work created and shared by the Android Open Source Project and used according to terms described in the Creative Commons 2.5 Attribution License.

Applies to