Wallpaper¶
Non-Visible component| Category | Requires | Version |
|---|---|---|
| Utilities | API 21, Android 5.0 Lollipop | 2 |
Overview¶
A non-visible component that provides access to the system''s wallpaper settings.
Permissions
Events¶
Got Wallpaper¶
Event to detect that the component got the current system wallpaper.
| Params | |
|---|---|
| picture | Text |
Wallpaper Changed¶
Event to detect that the user has changed the wallpaper. This event will be invoked by the "Set Wallpaper" function.
| Params | |
|---|---|
| success | Boolean |
Wallpaper Cleared¶
Event to detect that the user has cleared/deleted the wallpaper.
Methods¶
Clear¶
Remove any currently set system wallpaper, reverting to the system's built-in wallpaper.
Clear Wallpaper¶
Reset all wallpaper to the factory default. This block works only on devices with Android 9+.
Get Wallpaper¶
Retrieve the current system wallpaper; if no wallpaper is set, the system built-in static wallpaper is returned.
Set Lock Screen Wallpaper¶
Change the current lock screen wallpaper. This block works only on devices with Android 7+.
| Params | |
|---|---|
| image | Text |
Set Wallpaper¶
Change the current system wallpaper.
| Params | |
|---|---|
| image | Text |
Properties¶
Desired Minimum Height¶
Number 
Read - Blocks
Returns the desired minimum height for the wallpaper.
Desired Minimum Width¶
Number Read - Blocks
Returns the desired minimum width for the wallpaper.
Is Set Wallpaper Allowed¶
Boolean Read - Blocks
Returns whether the calling package is allowed to set the wallpaper for the calling user. This block works only on devices with Android 7+.
Is Wallpaper Supported¶
Boolean Read - Blocks
Returns whether wallpapers are supported for the calling user. This block works only on devices with Android 6+.
Save Wallpaper As¶
Text Default: wallpaperPicture.png Write - Designer Blocks
After the user clicked on "Get Wallpaper" this will be the name for the wallpaper picture.