UiModeManager
open class UiModeManager
kotlin.Any | |
↳ | android.app.UiModeManager |
This class provides access to the system uimode services. These services allow applications to control UI modes of the device. It provides functionality to disable the car mode and it gives access to the night mode settings.
These facilities are built on top of the underlying android.content.Intent#ACTION_DOCK_EVENT
broadcasts that are sent when the user physical places the device into and out of a dock. When that happens, the UiModeManager switches the system android.content.res.Configuration
to the appropriate UI mode, sends broadcasts about the mode switch, and starts the corresponding mode activity if appropriate. See the broadcasts ACTION_ENTER_CAR_MODE
and ACTION_ENTER_DESK_MODE
for more information.
In addition, the user may manually switch the system to car mode without physically being in a dock. While in car mode -- whether by manual action from the user or being physically placed in a dock -- a notification is displayed allowing the user to exit dock mode. Thus the dock mode represented here may be different than the current state of the underlying dock event broadcast.
Summary
Nested classes | |
---|---|
abstract |
Listener for the UI contrast. |
Constants | |
---|---|
static Int |
Flag for use with |
static Int |
Flag for use with |
static Int |
Flag for use with |
static Int |
Constant for |
static Int |
Constant for |
static Int |
Constant for |
static Int |
Constant for |
Public methods | |
---|---|
open Unit |
addContrastChangeListener(executor: Executor, listener: UiModeManager.ContrastChangeListener) Registers a |
open Unit |
disableCarMode(flags: Int) Turn off special mode if currently in car mode. |
open Unit |
enableCarMode(flags: Int) Force device into car mode, like it had been placed in the car dock. |
open Float |
Returns the color contrast for the user. |
open Int |
Return the current running mode type. |
open LocalTime |
Returns the time of the day Dark theme deactivates |
open LocalTime |
Returns the time of the day Dark theme activates |
open Int |
Returns the currently configured night mode. |
open Unit |
Unregisters a |
open Unit |
setApplicationNightMode(mode: Int) Sets and persist the night mode for this application. |
open Unit |
setCustomNightModeEnd(time: LocalTime) Sets the time of the day Dark theme deactivates |
open Unit |
setCustomNightModeStart(time: LocalTime) Sets the time of the day Dark theme activates |
open Unit |
setNightMode(mode: Int) Sets the system-wide night mode. |
Properties | |
---|---|
static String! |
Broadcast sent when the device's UI has switched to car mode, either by being placed in a car dock or explicit action of the user. |
static String! |
Broadcast sent when the device's UI has switched to desk mode, by being placed in a desk dock. |
static String! |
Broadcast sent when the device's UI has switch away from car mode back to normal mode. |
static String! |
Broadcast sent when the device's UI has switched away from desk mode back to normal mode. |
Constants
DISABLE_CAR_MODE_GO_HOME
static val DISABLE_CAR_MODE_GO_HOME: Int
Flag for use with disableCarMode(int)
: go to the normal home activity as part of the disable. Disabling this way ensures a clean transition between the current activity (in car mode) and the original home activity (which was typically last running without being in car mode).
Value: 1
ENABLE_CAR_MODE_ALLOW_SLEEP
static val ENABLE_CAR_MODE_ALLOW_SLEEP: Int
Flag for use with enableCarMode(int)
: allow sleep mode while in car mode. By default, when this flag is not set, the system may hold a full wake lock to keep the screen turned on and prevent the system from entering sleep mode while in car mode. Setting this flag disables such behavior and the system may enter sleep mode if there is no other user activity and no other wake lock held. Setting this flag can be relevant for a car dock application that does not require the screen kept on.
Value: 2
ENABLE_CAR_MODE_GO_CAR_HOME
static val ENABLE_CAR_MODE_GO_CAR_HOME: Int
Flag for use with enableCarMode(int)
: go to the car home activity as part of the enable. Enabling this way ensures a clean transition between the current activity (in non-car-mode) and the car home activity that will serve as home while in car mode. This will switch to the car home activity even if we are already in car mode.
Value: 1
MODE_NIGHT_AUTO
static val MODE_NIGHT_AUTO: Int
Constant for setNightMode(int)
and getNightMode()
: automatically switch night mode on and off based on the time.
Value: 0
MODE_NIGHT_CUSTOM
static val MODE_NIGHT_CUSTOM: Int
Constant for setNightMode(int)
and getNightMode()
: automatically switch night mode on and off based on the time.
Value: 3
MODE_NIGHT_NO
static val MODE_NIGHT_NO: Int
Constant for setNightMode(int)
and getNightMode()
: never run in night mode.
Value: 1
MODE_NIGHT_YES
static val MODE_NIGHT_YES: Int
Constant for setNightMode(int)
and getNightMode()
: always run in night mode.
Value: 2
Public methods
addContrastChangeListener
open fun addContrastChangeListener(
executor: Executor,
listener: UiModeManager.ContrastChangeListener
): Unit
Registers a ContrastChangeListener
for the current user.
Parameters | |
---|---|
executor |
Executor: The executor on which the listener should be called back. This value cannot be null . Callback and listener events are dispatched through this Executor , providing an easy way to control which thread is used. To dispatch events through the main thread of your application, you can use Context.getMainExecutor() . Otherwise, provide an Executor that dispatches to an appropriate thread. |
listener |
UiModeManager.ContrastChangeListener: The listener. This value cannot be null . |
disableCarMode
open fun disableCarMode(flags: Int): Unit
Turn off special mode if currently in car mode.
Parameters | |
---|---|
flags |
Int: One of the disable car mode flags. Value is android.app.UiModeManager#DISABLE_CAR_MODE_GO_HOME |
enableCarMode
open fun enableCarMode(flags: Int): Unit
Force device into car mode, like it had been placed in the car dock. This will cause the device to switch to the car home UI as part of the mode switch.
Parameters | |
---|---|
flags |
Int: Must be 0. |
getContrast
open fun getContrast(): Float
Returns the color contrast for the user.
Note: You need to query this only if your application is doing its own rendering and does not rely on the material rendering pipeline.
Return | |
---|---|
Float |
The color contrast, float in [-1, 1] where
|
getCurrentModeType
open fun getCurrentModeType(): Int
Return the current running mode type. May be one of Configuration.UI_MODE_TYPE_NORMAL
, Configuration.UI_MODE_TYPE_DESK
, Configuration.UI_MODE_TYPE_CAR
, Configuration.UI_MODE_TYPE_TELEVISION
, Configuration.UI_MODE_TYPE_APPLIANCE
, Configuration.UI_MODE_TYPE_WATCH
, or Configuration.UI_MODE_TYPE_VR_HEADSET
.
getCustomNightModeEnd
open fun getCustomNightModeEnd(): LocalTime
Returns the time of the day Dark theme deactivates
When night mode is MODE_NIGHT_CUSTOM
, the system uses this time set to deactivate it automatically.
Return | |
---|---|
LocalTime |
This value cannot be null . |
getCustomNightModeStart
open fun getCustomNightModeStart(): LocalTime
Returns the time of the day Dark theme activates
When night mode is MODE_NIGHT_CUSTOM
, the system uses this time set to activate it automatically.
Return | |
---|---|
LocalTime |
This value cannot be null . |
getNightMode
open fun getNightMode(): Int
Returns the currently configured night mode.
May be one of:
MODE_NIGHT_NO
MODE_NIGHT_YES
MODE_NIGHT_AUTO
MODE_NIGHT_CUSTOM
-1
on error
Return | |
---|---|
Int |
the current night mode, or -1 on error Value is android.app.UiModeManager#MODE_NIGHT_AUTO , android.app.UiModeManager#MODE_NIGHT_CUSTOM , android.app.UiModeManager#MODE_NIGHT_NO , or android.app.UiModeManager#MODE_NIGHT_YES |
See Also
removeContrastChangeListener
open fun removeContrastChangeListener(listener: UiModeManager.ContrastChangeListener): Unit
Unregisters a ContrastChangeListener
for the current user. If the listener was not registered, does nothing and returns.
Parameters | |
---|---|
listener |
UiModeManager.ContrastChangeListener: The listener to unregister. This value cannot be null . |
setApplicationNightMode
open fun setApplicationNightMode(mode: Int): Unit
Sets and persist the night mode for this application.
The mode can be one of:
MODE_NIGHT_NO
sets the device intonotnight
modeMODE_NIGHT_YES
sets the device intonight
modeMODE_NIGHT_CUSTOM
automatically switches betweennight
andnotnight
based on the custom time set (or default)MODE_NIGHT_AUTO
automatically switches betweennight
andnotnight
based on the device's current location and certain other sensors
Changes to night mode take effect locally and will result in a configuration change (and potentially an Activity lifecycle event) being applied to this application. The mode is persisted for this application until it is either modified by the application, the user clears the data for the application, or this application is uninstalled.
Developers interested in a non-persistent app-local implementation of night mode should consider using androidx.appcompat.app.AppCompatDelegate#setDefaultNightMode(int) to manage the -night qualifier locally.
Parameters | |
---|---|
mode |
Int: the night mode to set Value is android.app.UiModeManager#MODE_NIGHT_AUTO , android.app.UiModeManager#MODE_NIGHT_CUSTOM , android.app.UiModeManager#MODE_NIGHT_NO , or android.app.UiModeManager#MODE_NIGHT_YES |
See Also
setCustomNightModeEnd
open fun setCustomNightModeEnd(time: LocalTime): Unit
Sets the time of the day Dark theme deactivates
When night mode is MODE_NIGHT_CUSTOM
, the system uses this time set to deactivate it automatically.
Parameters | |
---|---|
time |
LocalTime: The time of the day Dark theme should deactivate This value cannot be null . |
setCustomNightModeStart
open fun setCustomNightModeStart(time: LocalTime): Unit
Sets the time of the day Dark theme activates
When night mode is MODE_NIGHT_CUSTOM
, the system uses this time set to activate it automatically
Parameters | |
---|---|
time |
LocalTime: The time of the day Dark theme should activate This value cannot be null . |
setNightMode
open fun setNightMode(mode: Int): Unit
Sets the system-wide night mode.
The mode can be one of:
MODE_NIGHT_NO
sets the device intonotnight
modeMODE_NIGHT_YES
sets the device intonight
modeMODE_NIGHT_CUSTOM
automatically switches betweennight
andnotnight
based on the custom time set (or default)MODE_NIGHT_AUTO
automatically switches betweennight
andnotnight
based on the device's current location and certain other sensors
Note: On API 22 and below, changes to the night mode are only effective when the car
or desk
mode is enabled on a device. On API 23 through API 28, changes to night mode are always effective.
Starting in API 29, when the device is in car mode and this method is called, night mode will change, but the new setting is not persisted and the previously persisted setting will be restored when the device exits car mode.
Changes to night mode take effect globally and will result in a configuration change (and potentially an Activity lifecycle event) being applied to all running apps. Developers interested in an app-local implementation of night mode should consider using setApplicationNightMode(int)
to set and persist the -night qualifier locally or androidx.appcompat.app.AppCompatDelegate#setDefaultNightMode(int) for the backward compatible implementation.
Parameters | |
---|---|
mode |
Int: the night mode to set Value is android.app.UiModeManager#MODE_NIGHT_AUTO , android.app.UiModeManager#MODE_NIGHT_CUSTOM , android.app.UiModeManager#MODE_NIGHT_NO , or android.app.UiModeManager#MODE_NIGHT_YES |
Properties
ACTION_ENTER_CAR_MODE
static var ACTION_ENTER_CAR_MODE: String!
Broadcast sent when the device's UI has switched to car mode, either by being placed in a car dock or explicit action of the user. After sending the broadcast, the system will start the intent android.content.Intent#ACTION_MAIN
with category android.content.Intent#CATEGORY_CAR_DOCK
to display the car UI, which typically what an application would implement to provide their own interface. However, applications can also monitor this Intent in order to be informed of mode changes or prevent the normal car UI from being displayed by setting the result of the broadcast to Activity#RESULT_CANCELED
.
This intent is broadcast when getCurrentModeType()
transitions to Configuration#UI_MODE_TYPE_CAR
from some other ui mode.
ACTION_ENTER_DESK_MODE
static var ACTION_ENTER_DESK_MODE: String!
Broadcast sent when the device's UI has switched to desk mode, by being placed in a desk dock. After sending the broadcast, the system will start the intent android.content.Intent#ACTION_MAIN
with category android.content.Intent#CATEGORY_DESK_DOCK
to display the desk UI, which typically what an application would implement to provide their own interface. However, applications can also monitor this Intent in order to be informed of mode changes or prevent the normal desk UI from being displayed by setting the result of the broadcast to Activity#RESULT_CANCELED
.
ACTION_EXIT_CAR_MODE
static var ACTION_EXIT_CAR_MODE: String!
Broadcast sent when the device's UI has switch away from car mode back to normal mode. Typically used by a car mode app, to dismiss itself when the user exits car mode.
This intent is broadcast when getCurrentModeType()
transitions from Configuration#UI_MODE_TYPE_CAR
to some other ui mode.
ACTION_EXIT_DESK_MODE
static var ACTION_EXIT_DESK_MODE: String!
Broadcast sent when the device's UI has switched away from desk mode back to normal mode. Typically used by a desk mode app, to dismiss itself when the user exits desk mode.