Added in version 33.2
Summary: Methods | Inherited Methods

TouchLockMode

public class TouchLockMode
extends Object

java.lang.Object
   ↳ com.google.wear.modes.TouchLockMode

Touch Lock Mode controls the device's ability to wake the screen via touch.

This class provides an object to interact with the configured and active values of touch lock mode.

An instance of this class can be obtained by ModeManager.getTouchLockMode() API.

Summary

Public methods

void addIsActiveListener(Executor executor, Consumer<Boolean> listener)

Adds a listener to listen for the changes in the active value of touch lock mode.

long getOverriddenReasons()

This method allows checking for the reason behind the state of touch lock mode being overridden.

boolean isActive()

Gets whether touch lock mode is active or not.

boolean isConfigured()

Gets the configured value of touch lock mode.

boolean isOverridden()

Determine if the state of touch lock mode is overridden or not.

void removeIsActiveListener(Consumer<Boolean> listener)

This removes the previously added listener.

void setConfigured(boolean value)

Sets the configured value of touch lock mode which can be fetched via isConfigured().

Inherited methods

Public methods

addIsActiveListener

Added in version 33.2 
public void addIsActiveListener (Executor executor, 
                Consumer<Boolean> listener)

Adds a listener to listen for the changes in the active value of touch lock mode. The listener will be triggered asynchronously with an initial value on registration and then again when the value changes.

Due to potential race conditions between calls, use of this method should not be mixed with isActive() method and the value the listener is triggered with should be treated as the latest active value.

Note: This should be balanced with removeIsActiveListener(Consumer) to prevent memory leaks.
Requires com.google.wear.services.Permissions.READ_TOUCH_LOCK

Parameters
executor Executor: The listener will be triggered on this Executor
listener Consumer: The listener to add

getOverriddenReasons

Added in version 33.2 
public long getOverriddenReasons ()

This method allows checking for the reason behind the state of touch lock mode being overridden. See isOverridden() for details.

This method returns a flag (defined in ModeManager) comprising reason(s) indicating the factors playing a role in overriding the state of touch lock mode. Each flag has a permission associated with it, and this method only returns the flags the caller already has the permission for. Please check the respective flag for its permission requirement.

Note: The returned value might also contain ModeManager.FLAG_OVERRIDDEN_BY_UNKNOWN_REASON indicating an unknown cause behind the state of touch lock mode being overridden.
Requires com.google.wear.services.Permissions.READ_TOUCH_LOCK

Returns
long the combination of flags defined in ModeManager specifying the cause behind the state of touch lock mode being overridden. Returned value of OL implies that the state of touch lock mode is not overridden.
Value is either 0 or a combination of the following:

isActive

Added in version 33.2 
public boolean isActive ()

Gets whether touch lock mode is active or not.

This is the active value of touch lock mode in effect as reflected on the device. It is determined by the current operating context of the system. Due to potential race conditions due to change between calls, use of this method should not be mixed with addIsActiveListener(Executor,Consumer).
Requires com.google.wear.services.Permissions.READ_TOUCH_LOCK

Returns
boolean true if touch lock mode is active, else false

isConfigured

Added in version 33.2 
public boolean isConfigured ()

Gets the configured value of touch lock mode.

This reflects the default configured value of touch lock mode and is set via setConfigured(boolean).

Note: If the state of touch lock mode is overridden (isOverridden()), this may differ from the active value. See isOverridden() for details.
Requires com.google.wear.services.Permissions.READ_TOUCH_LOCK

Returns
boolean the configured value of touch lock mode

isOverridden

Added in version 33.2 
public boolean isOverridden ()

Determine if the state of touch lock mode is overridden or not.

Touch lock has a configured value which is the default value for its state. The active value as reflected on the device, on the other hand, is determined by the current operating context of the system and depends on either of the following:

  • Either the configured value of touch lock mode
  • Or the configured values of all other modes

The state of touch lock mode can be defined as overridden if its configured value does not play a role in determining its active value. This does not necessarily mean that the configured value will be different from the active value but rather means that if the configured value is updated, the active value will not be updated till the override is lifted.
Requires com.google.wear.services.Permissions.READ_TOUCH_LOCK

Returns
boolean true if the state of touch lock mode is overridden, i.e. updating configured value does not update the active value

removeIsActiveListener

Added in version 33.2 
public void removeIsActiveListener (Consumer<Boolean> listener)

This removes the previously added listener.

Parameters
listener Consumer: The listener to remove

setConfigured

Added in version 33.2 
public void setConfigured (boolean value)

Sets the configured value of touch lock mode which can be fetched via isConfigured(). In case an override is not in place, this will also update its active value as reflected on the device which can be fetched via isActive(). However, in case the state of touch lock mode is overridden, its active value as on the device will be updated to reflect this configured value once the override is uplifted.
Requires com.google.wear.services.Permissions.WRITE_TOUCH_LOCK

Parameters
value boolean: True to enable touch lock mode