clover-android-sdk/com.clover.sdk.util/Screensaver

Screensaver

public final class Screensaver

Enable, disable, and configure the screensaver.

Not all methods are supported on all devices. If a method is not supported, it will throw UnsupportedOperationException. For example:

val screensaver = Screensaver(context)
try {
  screensaver.gotoSleep()
  // Supported on this device
} catch (e: UnsupportedOperationException) {
  // Not supported on this device
}

Alternatively, you can check if the methods in this class are supported by inspecting supported.

All methods are blocking and should be invoked on a background thread.

Constructors

Screensaver

public Screensaver Screensaver(Context context)

Types

ScreensaverSetting

public enum ScreensaverSetting extends Enum<Screensaver.ScreensaverSetting>

Properties

dreamsEnabledOnBattery

private Boolean dreamsEnabledOnBattery

Get or set if dreams are enabled on battery power. If true, the device will allow the device to dream when on battery power.

supported

private final Boolean supported

Convenience method to check if the methods in this class are supported on this device.

unstableClient

private final UnstableContentResolverClient unstableClient

Functions

getDreamComponents

public final List<ComponentName> getDreamComponents()

Get the active dream components.

getDreamsEnabledOnBattery

public final Boolean getDreamsEnabledOnBattery()

getScreensaverSetting

public final Boolean getScreensaverSetting(Screensaver.ScreensaverSetting key)

Get secure settings related to the screensaver.

getSupported

public final Boolean getSupported()

getUnstableClient

public final UnstableContentResolverClient getUnstableClient()

gotoSleep

public final Unit gotoSleep()

Forces the device to go to sleep.

setDreamComponents

public final Unit setDreamComponents(List<ComponentName> dreamComponents)

Set the active dream component.

setDreamsEnabledOnBattery

public final Unit setDreamsEnabledOnBattery(Boolean dreamsEnabledOnBattery)

setScreensaverSetting

public final Unit setScreensaverSetting(Screensaver.ScreensaverSetting key, Boolean value)

Set secure settings related to the screensaver.

start

public final Unit start()

Start the active dream component now. This does not lock the screen.