WallpaperCapabilities class

Describes which wallpaper targets, if any, a platform supports.

Returned by WallpaperPlugin.getCapabilities. A capability is only reported as true when the underlying platform genuinely provides it.

Annotations

Constructors

WallpaperCapabilities({required bool supportsHome, required bool supportsLock, required bool supportsBoth, required bool supportsCapturedWidget, required bool supportsDirectImageSources})
const

Properties

hashCode → int
The hash code for this object.
no setteroverride
runtimeType → Type
A representation of the runtime type of the object.
no setterinherited
supportsBoth → bool
Whether the platform can set home and lock together.
final
supportsCapturedWidget → bool
Whether a widget captured from a RepaintBoundary can be used.
final
supportsDirectImageSources → bool
Whether file/URL/bytes image sources are supported.
final
supportsHome → bool
Whether the platform can set the home screen wallpaper.
final
supportsLock → bool
Whether the platform can set the lock screen wallpaper.
final
supportsWallpaperSetting → bool
Convenience helper: whether the platform can set wallpapers at all.
no setter

Methods

noSuchMethod(Invocation invocation) → dynamic
Invoked when a nonexistent method or property is accessed.
inherited
toString() → String
A string representation of this object.
override

Operators

operator ==(Object other) → bool
The equality operator.
override

Constants

none → const WallpaperCapabilities
A constant describing a platform with no wallpaper-setting support (for example iOS, which cannot set wallpapers programmatically).