Skip to main content

Config glossary (Mason OS 2)

phone​

config_enableDataRoaming​

os.configuration.phone.config_enableDataRoaming

Flag indicating whether or not to enable data roaming. NOTE: This configuration is enabled by default. You should be aware of pricing and policies related to data roaming for your connectivity plan.

Types: boolean

Default: true

system​

config_fp_key_events​

os.configuration.system.config_fp_key_events

Controls whether the fingerprint sensor will send BACK and HOME events when tapped while the device is unlocked.

Types: integer, string (0[xX][0-9a-fA-F]8)0

config_usb_host_enabled​

os.configuration.system.config_usb_host_enabled

Sets the device to enable or disable the usb host. By default it is enabled, allowing for any device to be connected. Disabling prevents all devices from connecting over USB but still allows charging.

Types: integer, string (0[xX][0-9a-fA-F]8)

Default: 1

config_recovery_factory_reset_enabled​

os.configuration.system.config_recovery_factory_reset_enabled

Sets the device to enable or disable the Wipe Data/Factory reset option on the recovery menu. If disabled, the option will not be visible or executable. By default it is enabled, showing the option on the recovery menu and allowing it's execution.

Types: integer, string (0[xX][0-9a-fA-F]8)

Default: 1

android​

config_wifiOnly​

os.configuration.android.config_wifiOnly

Flag indicating whether the device should ignore cellular and use wifi only

Types: boolean

config_sms_capable​

os.configuration.android.config_sms_capable

Flag indicating whether the current device allows sms service. If true, this means that the device supports both sending and receiving sms via the telephony network. This can be overridden to false for "data only" devices which can't send and receive sms message. Note: Disable SMS also disable voicemail waiting sms, cell broadcasting sms, and MMS.

Types: boolean

Default: true

config_voice_capable​

os.configuration.android.config_voice_capable

Flag indicating whether the current device is "voice capable". If true, this means that the device supports circuit-switched (i.e. voice) phone calls over the telephony network, and is allowed to display the in-call UI while a cellular voice call is active. This can be overridden to false for "data only" devices which can't make voice calls and don't support any in-call UI. Note: this flag is subtly different from the PackageManager.FEATURE_TELEPHONY system feature, which is available on any device with a telephony radio, even if the device is data-only.

Types: boolean

Default: true

config_hotswapCapable​

os.configuration.android.config_hotswapCapable

Is the device capable of hot swapping an UICC Card

Types: boolean

Default: true

config_useFixedVolume​

os.configuration.android.config_useFixedVolume

Flag indicating that the media framework should not allow changes or mute on any stream or master volumes.

Types: boolean

config_disableKeyguard​

os.configuration.android.config_disableKeyguard

Whether to enable keyguard scrim or not. If set to false, the keyguard can be controlled through the settings app. If set to true, it will disable the keyguard scrim even if the screen lock option changes. If a secure start-up option is selected from the screen lock menu and a pattern, pin or password is required to start the device, the specific option will be requested when the device boots.

Types: boolean

config_dreamsSupported​

os.configuration.android.config_dreamsSupported

Specifies whether the dreams feature should be supported. When true, the system will allow the user to configure dreams (screensavers) to launch when a user activity timeout occurs or the system is told to nap. When false, the dreams feature will be disabled (this does not affect dozing). Consider setting this resource to false or disabling dreams by default when a doze component is specified below since dreaming will supercede dozing and will prevent the system from entering a low power state until the dream ends.

Types: boolean

Default: true

config_max_pan_devices​

os.configuration.android.config_max_pan_devices

Max number of Bluetooth tethering connections allowed. If this is updated config_tether_dhcp_range has to be updated appropriately.

Types: integer, string (0[xX][0-9a-fA-F]8)

Default: 5

config_usbHostBlacklist​

os.configuration.android.config_usbHostBlacklist

List of file paths for USB host busses to exclude from USB host support. For example, if the first USB bus on the device is used to communicate with the modem or some other restricted hardware, add "/dev/bus/usb/001/" to this list. If this is empty, no parts of the host USB bus will be excluded.

Types: array

default_sms_application​

os.configuration.android.default_sms_application

Default SMS Application. This will be the default SMS application when the phone first boots. The user can then change the default app to one of their choosing. This can be overridden for devices where a different default SMS application is desired. If this string is empty or the specified package does not exist, then the platform will search for an SMS app and use that (if there is one)

Types: string

Default: "com.android.mms"

config_allowAllRotations​

os.configuration.android.config_allowAllRotations

If true, and auto-rotation is enabled, the screen can be rotated via the accelerometer in all 4 rotations as the default behavior. If false, and auto-rotation is enabled, the screen can be rotated via the accelerometer in 3 directions except vertical rotation in the portrait mode. This config works effectively when auto-rotation is enabled. If auto-rotation is disabled, this config will no have effect.

Types: boolean

Default: true

config_globalActionsList​

os.configuration.android.config_globalActionsList

Defines the default set of global actions. Actions may still be disabled or hidden based on the current state of the device. Each item must be one of the following strings: "power" = Power off "settings" = An action to launch settings "airplane" = Airplane mode toggle "bugreport" = Take bug report, if available "silent" = silent mode "users" = list of users "restart" = restart device

Types: array

config_lockSoundVolumeDb​

os.configuration.android.config_lockSoundVolumeDb

The attenuation in dB applied to the lock/unlock sounds.

Types: integer, string (0[xX][0-9a-fA-F]8)

Default: -6

config_navBarOpacityMode​

os.configuration.android.config_navBarOpacityMode

Controls the opacity of the navigation bar depending on the visibility of the various workspace stacks. 0 - Nav bar is always opaque when either the freeform stack or docked stack is visible. 1 - Nav bar is always translucent when the freeform stack is visible, otherwise always opaque.

Types: integer, string (0[xX][0-9a-fA-F]8)0

config_showNavigationBar​

os.configuration.android.config_showNavigationBar

Whether a software navigation bar should be shown. NOTE: in the future this may be autodetected from the Configuration.

Types: boolean

Default: true

config_tether_usb_regexs​

os.configuration.android.config_tether_usb_regexs

List of regexpressions describing the interface (if any) that represent tetherable USB interfaces. If the device doesn't want to support tethering over USB this should be empty. An example would be "usb.*"

Types: array

config_useAttentionLight​

os.configuration.android.config_useAttentionLight

Set this true only if the device has separate attention and notification lights.

Types: boolean

config_built_in_sip_phone​

os.configuration.android.config_built_in_sip_phone

Enables built-in SIP phone capability

Types: boolean

Default: true

config_default_dns_server​

os.configuration.android.config_default_dns_server

IP address of the dns server to use if nobody else suggests one

Types: string

Default: "8.8.8.8"

config_usbChargingMessage​

os.configuration.android.config_usbChargingMessage

If this is true, the message that USB is only being used for charging will be shown.

Types: boolean

Default: true

config_useVolumeKeySounds​

os.configuration.android.config_useVolumeKeySounds

Flag indicating that the media framework should support playing of sounds on volume key usage. This adds noticeable additional overhead to volume key processing, so is disableable for products for which it is irrelevant.

Types: boolean

Default: true

config_camera_sound_forced​

os.configuration.android.config_camera_sound_forced

Whether camera shutter sound is forced or not (country specific).

Types: boolean

config_supportAutoRotation​

os.configuration.android.config_supportAutoRotation

If true, enables auto-rotation features using the accelerometer. Otherwise, auto-rotation is disabled. Applications may still request to use specific orientations but the sensor is ignored and sensor-based orientations are not available. Furthermore, all auto-rotation related settings are omitted from the system UI. In certain situations we may still use the accelerometer to determine the orientation, such as when docked if the dock is configured to enable the accelerometer.

Types: boolean

Default: true

config_unplugTurnsOnScreen​

os.configuration.android.config_unplugTurnsOnScreen

If this is true, the screen will come on when you unplug usb/power/whatever.

Types: boolean

Default: true

default_wallpaper_component​

os.configuration.android.default_wallpaper_component

Component name of the default wallpaper. This will be ImageWallpaper if not specified

Types: string

Default: "@null"

config_deskDockKeepsScreenOn​

os.configuration.android.config_deskDockKeepsScreenOn

Control whether being in the desk dock (and powered) always keeps the screen on. By default it stays on when plugged in to AC. 0 will not keep it on; or together 1 to stay on when plugged in to AC and 2 to stay on when plugged in to USB. (So 3 for both.)

Types: integer, string (0[xX][0-9a-fA-F]8)

Default: 1

config_enableScreenshotChord​

os.configuration.android.config_enableScreenshotChord

If this is true, key chords can be used to take a screenshot on the device.

Types: boolean

Default: true

config_maximumScreenDimRatio​

os.configuration.android.config_maximumScreenDimRatio

User activity timeout: Maximum screen dim duration as a percentage of screen off timeout. This resource is similar to config_maximumScreenDimDuration but the maximum screen dim duration is defined as a ratio of the overall screen off timeout instead of as an absolute value in milliseconds. This is useful for reducing the dim duration when the screen off timeout is very short. When computing the screen dim duration, the power manager uses the lesser of the effective durations expressed by config_maximumScreenDimDuration and config_maximumScreenDimRatio. This value must be between 0% and 100%. If the value is zero, the screen will not dim before the device goes to sleep.

Types: string

Default: "20%"

config_wifi_hotspot2_enabled​

os.configuration.android.config_wifi_hotspot2_enabled

Boolean indicating whether Hotspot 2.0/Passpoint and ANQP queries is enabled

Types: boolean

Default: true

config_lowBatteryWarningLevel​

os.configuration.android.config_lowBatteryWarningLevel

Display low battery warning when battery level dips to this value

Types: integer, string (0[xX][0-9a-fA-F]8)

Default: 15

config_reverseDefaultRotation​

os.configuration.android.config_reverseDefaultRotation

If true, the direction rotation is applied to get to an application's requested orientation is reversed. Normally, the model is that landscape is clockwise from portrait; thus on a portrait device an app requesting landscape will cause a clockwise rotation, and on a landscape device an app requesting portrait will cause a counter-clockwise rotation. Setting true here reverses that logic.

Types: boolean

config_sendAudioBecomingNoisy​

os.configuration.android.config_sendAudioBecomingNoisy

Flag indicating whether the AUDIO_BECOMING_NOISY notification should be sent during a change to the audio output device.

Types: boolean

Default: true

config_appsNotReportingCrashes​

os.configuration.android.config_appsNotReportingCrashes

List of comma separated package names for which we the system will not show crash, ANR, etc. dialogs.

Types: string

config_datause_threshold_bytes​

os.configuration.android.config_datause_threshold_bytes

The default data-use threshold in bytes. 0 disables

Types: integer, string (0[xX][0-9a-fA-F]8)0

config_doubleTapOnHomeBehavior​

os.configuration.android.config_doubleTapOnHomeBehavior

Control the behavior when the user double-taps the home button. 0 - Nothing 1 - Recent apps view in SystemUI This needs to match the constants in policy/src/com/android/internal/policy/impl/PhoneWindowManager.java

Types: integer, string (0[xX][0-9a-fA-F]8)0

config_forceDefaultOrientation​

os.configuration.android.config_forceDefaultOrientation

Flag indicating that this device does not rotate and will always remain in its default orientation. Activities that desire to run in a non-compatible orientation will be run from an emulated display within the physical display.

Types: boolean

config_longPressOnHomeBehavior​

os.configuration.android.config_longPressOnHomeBehavior

Control the behavior when the user long presses the home button. 0 - Nothing 1 - Recent apps view in SystemUI 2 - Launch assist intent This needs to match the constants in policy/src/com/android/internal/policy/impl/PhoneWindowManager.java

Types: integer, string (0[xX][0-9a-fA-F]8)0

config_minimumScreenOffTimeout​

os.configuration.android.config_minimumScreenOffTimeout

Set the minimum user activity timeout, in milliseconds. The specified value becomes a lower bound for the SCREEN_OFF_TIMEOUT system setting which determines how soon the device will go to sleep when there is no user activity. This value must be greater than 0.

Most importantly, the system uses the greater of config_minimumScreenOffTimeout and SCREEN_OFF_TIMEOUT setting in calculating the screen off timeout.

NOTES:

The default value of the SCREEN_OFF_TIMEOUT system setting is 60 seconds Despite the name of this config, when this timeout expires the device enters a low power state first. This implies that the screen may not turn off immediately, but rather be dimmed first, and then later turned off after an internal timeout expires. This cannot currently be controlled

Types: integer, string (0[xX][0-9a-fA-F]8)

Default: 10000

config_defaultNotificationLedOn​

os.configuration.android.config_defaultNotificationLedOn

Default LED on time for notification LED in milliseconds.

Types: integer, string (0[xX][0-9a-fA-F]8)

Default: 500

config_enableLockScreenRotation​

os.configuration.android.config_enableLockScreenRotation

Disable lockscreen rotation by default

Types: boolean

config_intrusiveNotificationLed​

os.configuration.android.config_intrusiveNotificationLed

Is the notification LED intrusive? Used to decide if there should be a disable option

Types: boolean

config_longPressOnPowerBehavior​

os.configuration.android.config_longPressOnPowerBehavior

Control the behavior when the user long presses the power button. 0 - Nothing 1 - Global actions menu 2 - Power off (with confirmation) 3 - Power off (without confirmation) 100 - Send a broadcast with action "com.bymason.platform.LONG_PRESS_POWER"

Types: integer, string (0[xX][0-9a-fA-F]8)

Default: 1

config_supportMicNearUltrasound​

os.configuration.android.config_supportMicNearUltrasound

Whether the default microphone audio source supports near-ultrasound frequencies (range of 18 - 21 kHz).

Types: boolean

Default: true

config_safe_media_volume_enabled​

os.configuration.android.config_safe_media_volume_enabled

Whether safe headphone volume is enabled or not (country specific).

Types: boolean

Default: true

config_shortPressOnPowerBehavior​

os.configuration.android.config_shortPressOnPowerBehavior

Controls the behavior when the user short presses the power button.

ValueBehavior when the power button is pressed
0Do nothing; presses are completely ignored. The device does not go to sleep or into doze mode.
1 (default)This is the system default. This will cause the device to go to sleep, but not before going through a doze mode phase.
2This will cause the device to skip Android's doze mode and go directly to sleep.
3This will cause the device to skip Android's doze more and go directly to sleep. This will also cause the launcher application to be brought to the foreground.
100Do nothing and send a broadcast with action "com.bymason.platform.SHORT_PRESS_POWER".

Types: integer, string (0[xX][0-9a-fA-F]8)

Default: 1

config_disableMenuKeyInLockScreen​

os.configuration.android.config_disableMenuKeyInLockScreen

Allow the menu hard key to be disabled in LockScreen on some devices

Types: boolean

config_enableKeypressOptimization​

os.configuration.android.config_enableKeypressOptimization

Keypress Optimization

Types: boolean

config_lidNavigationAccessibility​

os.configuration.android.config_lidNavigationAccessibility

Indicate whether the lid state impacts the accessibility of the navigation buttons. 0 means it doesn't, 1 means it is accessible when the lid is open, 2 means it is accessible when the lid is closed. The default is 0.

Types: integer, string (0[xX][0-9a-fA-F]8)0

config_allowTheaterModeWakeFromKey​

os.configuration.android.config_allowTheaterModeWakeFromKey

If this is true, allow wake from theater mode from regular key press. Setting this value to true implies config_allowTheaterModeWakeFromPowerKey is also true

Types: boolean

config_criticalBatteryWarningLevel​

os.configuration.android.config_criticalBatteryWarningLevel

Display low battery warning when battery level dips to this value. Also, the battery stats are flushed to disk when we hit this level.

Types: integer, string (0[xX][0-9a-fA-F]8)

Default: 5

config_disableUsbPermissionDialogs​

os.configuration.android.config_disableUsbPermissionDialogs

If true, then we do not ask user for permission for apps to connect to USB devices. Do not set this to true for production devices. Doing so will cause you to fail CTS.

Types: boolean

config_enableLockBeforeUnlockScreen​

os.configuration.android.config_enableLockBeforeUnlockScreen

Don't show lock screen before unlock screen (PIN/pattern/password)

Types: boolean

config_useDevInputEventForAudioJack​

os.configuration.android.config_useDevInputEventForAudioJack

When true use the linux /dev/input/event subsystem to detect the switch changes on the headphone/microphone jack. When false use the older uevent framework.

Types: boolean

Default: true

status_bar_notification_info_maxnum os.configuration.android.status_bar_notification_info_maxnum

Maximum numerical value that will be shown in a status bar notification icon or in the notification itself. Will be replaced with @string/status_bar_notification_info_overflow when shown in the UI.

Types: integer, string (0[xX][0-9a-fA-F]8)

Default: 999

config_MaxConcurrentDownloadsAllowed​

os.configuration.android.config_MaxConcurrentDownloadsAllowed

Max number of downloads allowed to proceed concurrently

Types: integer, string (0[xX][0-9a-fA-F]8)

Default: 5

config_allowAnimationsInLowPowerMode​

os.configuration.android.config_allowAnimationsInLowPowerMode

This config is ued to determine whether animations are allowed in low power mode.

Types: boolean

config_allowTheaterModeWakeFromMotion​

os.configuration.android.config_allowTheaterModeWakeFromMotion

If this is true, allow wake from theater mode from motion.

Types: boolean

config_bluetooth_operating_voltage_mv​

os.configuration.android.config_bluetooth_operating_voltage_mv

Operating volatage for bluetooth controller. 0 by default

Types: integer, string (0[xX][0-9a-fA-F]8)

Default: 4

config_screenBrightnessSettingDefault​

os.configuration.android.config_screenBrightnessSettingDefault

Default screen brightness setting. Must be in the range specified by minimum and maximum.

Types: integer, string (0[xX][0-9a-fA-F]8)

Default: 102

config_screenBrightnessSettingMaximum​

os.configuration.android.config_screenBrightnessSettingMaximum

Maximum screen brightness allowed by the power manager. The user is forbidden from setting the brightness above this level.

Types: integer, string (0[xX][0-9a-fA-F]8)

Default: 255

config_screenBrightnessSettingMinimum​

os.configuration.android.config_screenBrightnessSettingMinimum

Minimum screen brightness setting allowed by the power manager. The user is forbidden from setting the brightness below this level.

Types: integer, string (0[xX][0-9a-fA-F]8)

Default: 10

config_nonBlockableNotificationPackages​

os.configuration.android.config_nonBlockableNotificationPackages

An array of packages for which notifications cannot be blocked.

Types: array

config_cameraDoubleTapPowerGestureEnabled​

os.configuration.android.config_cameraDoubleTapPowerGestureEnabled

Allow the gesture to double tap the power button twice to start the camera while the device is non-interactive.

Types: boolean

Default: true

config_bluetooth_le_peripheral_mode_supported​

os.configuration.android.config_bluetooth_le_peripheral_mode_supported

Boolean indicating if current platform supports BLE peripheral mode

Types: boolean

Default: true

config_enable_emergency_call_while_sim_locked​

os.configuration.android.config_enable_emergency_call_while_sim_locked

Enable emergency call when sim is locked or puk locked. Some countries/carriers do not allow emergency calls to be placed without the IMSI, which is locked in the SIM. If so, this should be set to 'false' in an overlay.

Types: boolean

Default: true

config_dreamsBatteryLevelMinimumWhenNotPowered​

os.configuration.android.config_dreamsBatteryLevelMinimumWhenNotPowered

Minimum battery level to allow dreaming when not powered. Use -1 to disable this safety feature.

Types: integer, string (0[xX][0-9a-fA-F]8)

Default: 15

config_powerDecoupleInteractiveModeFromDisplay​

os.configuration.android.config_powerDecoupleInteractiveModeFromDisplay

Power Management: Specifies whether to decouple the interactive state of the device from the display on/off state. When false, setInteractive(..., true) will be called before the display is turned on and setInteractive(..., false) will be called after the display is turned off. This mode provides best compatibility for devices that expect the interactive state to be tied to the display state. When true, setInteractive(...) will be called independently of whether the display is being turned on or off. This mode enables the power manager to reduce clocks and disable the touch controller while the display is on. This resource should be set to "true" when a doze component has been specified to maximize power savings but not all devices support it. Refer to power.h for details.

Types: boolean

Default: true

config_supportLongPressPowerWhenNonInteractive​

os.configuration.android.config_supportLongPressPowerWhenNonInteractive

If this is true, long press on power button will be available from the non-interactive state

Types: boolean

config_allowTheaterModeWakeFromMotionWhenNotDreaming​

os.configuration.android.config_allowTheaterModeWakeFromMotionWhenNotDreaming

If this is true, allow wake from theater mode from motion.

Types: boolean

config_user_notification_of_restrictied_mobile_access​

os.configuration.android.config_user_notification_of_restrictied_mobile_access

Flag indicating if the user is notified when the mobile network access is restricted

Types: boolean

Default: true

keyguard​

config_showEmergencyButton​

os.configuration.keyguard.config_showEmergencyButton

whether to show emergency button in lock screen

Types: boolean

Default: true

settings​

config_default_tile_list​

os.configuration.settings.config_default_tile_list

A listing of all the default dashboard tiles, overlay this resource to remove the tiles. Allowed values in Nougat are: "wifi", "bluetooth", "sim", "datausage", "more", "notifications", "home", "display", "sounds", "apps", "storage", "battery", "memory", "users", "location", "security", "accounts", "language", "backup", "datetime", "accessibility", "printing", "timer", "developer", "about".

Types: array

quick_settings_tiles_default os.configuration.systemui.quick_settings_tiles_default

The default tiles to display in QuickSettings

Types: string

Default: "wifi,cell,battery,dnd,flashlight,rotation,bt,airplane"

systemui​

config_quickSettingsTilesEditable​

os.configuration.systemui.config_quickSettingsTilesEditable

No description

Types: boolean

Default: true

config_showDeviceMonitoredWarning​

os.configuration.systemui.config_showDeviceMonitoredWarning

Whether or not to show the device monitored warning in QuickSettings.

Types: boolean

Default: true

config_keyguardShowPhoneAffordance​

os.configuration.systemui.config_keyguardShowPhoneAffordance

Show phone affordance on Keyguard

Types: boolean

Default: true

config_lockScreenShowNotifications​

os.configuration.systemui.config_lockScreenShowNotifications

Whether to show notifications on the lock scren at all, overrides all other settings

Types: boolean

Default: true

config_keyguardShowCameraAffordance​

os.configuration.systemui.config_keyguardShowCameraAffordance

Show camera affordance on Keyguard

Types: boolean

Default: true

mason-core​

config_xray_notify​

os.configuration.mason-core.config_xray_notify

Whether to show a persistent notification while an X-Ray session is active

Types: boolean

Default: true

config_xray_enabled​

os.configuration.mason-core.config_xray_enabled

Whether to enable the Mason X-Ray remote access feature

Types: boolean

Default: true

config_location_polling​

os.configuration.mason-core.config_location_polling

Whether to allow the device(s) to report location to the Mason Dashboard.

Types: boolean

Default: true

config_locate_check_frequency​

os.configuration.mason-core.config_locate_check_frequency

If config_location_polling is allowed, the frequency (in hours) of how often to report location information

Types: integer, string (0[xX][0-9a-fA-F]8)

Default: 24

config_destructive_commands_package​

os.configuration.mason-core.config_destructive_commands_package

If specified, this package will be notified of destructive commands sent from the platform. Destructive commands include: REFURBISH, WIPE

Types: string

mason-fota​

config_update_install_time​

os.configuration.mason-fota.config_update_install_time

Target 24 hour install time for OS updates that have been downloaded. (needs to be between 0-23 for the hour and 0-60 for the minute, delimited with a colon or -1 for immediate install after update check)

Types: string

Default: "-1"

config_prompt_timeout_count​

os.configuration.mason-fota.config_prompt_timeout_count

The time (in seconds) a user has before the pending update runs automatically from the update prompt.

Types: integer, string (0[xX][0-9a-fA-F]8)

Default: 60

config_install_prompt_package​

os.configuration.mason-fota.config_install_prompt_package

Normally, OTA updates (for both project configurations as well as the operating system itself) are installed automatically by the system based upon the rules specified in the mason-fota section of the project configuration YML. When the OTA is about to be installed, the device displays a dialog box with a countdown indicating as such. There may be instances where such a prompt may be inappropriate or undesirable (for instance, a tablet used in a healthcare setting should not reboot and update itself while in use).

This configuration allows you to specify the package name of an application that will instead be responsible for being notified of and subsequently initiating OTA installations.

If the package name represents a valid application currently on the device, that application will receive an intent broadcast from the system when it is time for an OTA installation. The intent will contain a string extra named "target_uuid" which must be saved for later use. The intent filter shown here can be used to receive the broadcast (see right).

<intent-filter>
  <action android:name="com.bymason.platform.INSTALL_UPDATE" />
</intent-filter>

It is then up to the application specified to communicate when it is ready to do an install by calling masonamerica.platform.FotaManagerPrivileged#requestInstall(uuid) via the Mason Framework API, passing in the value of the "target_uuid" extra from earlier as a parameter.

NOTES:

The intent is sent just prior to when the system would have normally attempted an automatic installation. Hence, any install times or check frequencies specified in the YML will still be in effect If this package name does not resolve to a valid application, the system will default to the usual configured behavior There should only ever be a single system update, so whenever a uuid is provided, any previous one may be discarded. Once requestInstall() is called, the uuid should be discarded If empty or omitted, the system reverts to default OTA installation behavior

Types: string

config_update_check_frequency​

os.configuration.mason-fota.config_update_check_frequency

The frequency for which to check for updates from boot, default is 24 hours

Types: integer, string (0[xX][0-9a-fA-F]8)

Default: 24

config_update_check_when_idle​

os.configuration.mason-fota.config_update_check_when_idle

When true, only performs update checks when the device is idle. Note that this is incompatible with and will override config_update_check_backoff_period.

Types: boolean

config_update_check_network_type​

os.configuration.mason-fota.config_update_check_network_type

NETWORK_TYPE_ANY The default update check network type, allows checks over any network Constant Value: 1 (0x00000001) NETWORK_TYPE_UNMETERED The update check requires network connectivity that is unmetered. Constant Value: 2 (0x00000002) NETWORK_TYPE_NOT_ROAMING The update check requires network connectivity that is not roaming. Constant Value: 3 (0x00000003)

Types: integer, string (0[xX][0-9a-fA-F]8)

Default: 1

config_default_connection_timeout​

os.configuration.mason-fota.config_default_connection_timeout

The default connection timeout for the mason endpoint

Types: integer, string (0[xX][0-9a-fA-F]8)

Default: 60

config_update_check_when_charging​

os.configuration.mason-fota.config_update_check_when_charging

When true, only performs update checks when the device is charging

Types: boolean

config_allow_download_over_metered​

os.configuration.mason-fota.config_allow_download_over_metered

When true, performs application downloads over a metered network

Types: boolean

Default: true

config_update_check_backoff_period​

os.configuration.mason-fota.config_update_check_backoff_period

The exponential backoff period in hours for a failed update check. Defaults to 5 hours. This configuration has no effect when config_update_check_when_idle is set to true.

Types: integer, string (0[xX][0-9a-fA-F]8)

Default: 5

config_show_download_in_downloads_ui​

os.configuration.mason-fota.config_show_download_in_downloads_ui

When true, shows the applications downloads in the downloads ui of the OS

Types: boolean

config_update_prompt_prior_to_install​

os.configuration.mason-fota.config_update_prompt_prior_to_install

Whether to prompt prior to fota install, if enabled a user has N (see config_prompt_timeout_count) seconds to cancel a pending update before it runs automatically.

Types: boolean

Default: true

config_update_install_battery_threshold​

os.configuration.mason-fota.config_update_install_battery_threshold

Minimum battery level (as percentage) required for an update to be installed.

Types: integer, string (0[xX][0-9a-fA-F]8)

Default: 20

config_show_download_progress_as_notification​

os.configuration.mason-fota.config_show_download_progress_as_notification

When true, shows the application download progress as a persistent notification

Types: boolean

mason-management​

disable_camera​

os.configuration.mason-management.disable_camera

Flag indicating whether or not to disable camera functionality

Types: boolean

hidden_packages​

os.configuration.mason-management.hidden_packages

When a package is hidden it is unavailable for use, but the data and actual package file remain.

Types: array

disable_keyguard​

os.configuration.mason-management.disable_keyguard

If set to True, the default lockscreen (swipe to unlock) will be disabled. Upon first boot after deploying the config, the device will still display the swipe lock screen only once. However, the lock screen will be no longer displayed subsequently after it was dismissed. When used in conjunction with 'direct_boot_package' and 'disable_keyguard,' the specified application will open directly after a device reboot, eliminating the need for an intermediate screen (keyguard/lock screen). If set to 'False,' upon device boot or wake-up, the keyguard (default lock screen) will be displayed first, requiring the user to swipe up before accessing the Mason OS. Note: If the user set a pin or pattern or password and fingerprint, this config will not disable that type of keyguard.

Types: boolean

disable_status_bar​

os.configuration.mason-management.disable_status_bar

If True, the status will not be accessible system-wide. Pulling down from the top of the device will not render the status bar. If False, the status bar will be accessible by pulling down from the top of the device.

Types: boolean

lock_task_packages​

os.configuration.mason-management.lock_task_packages

A white-list of package names of applications that can be pinned to the screen via context.setLockTaskMode() or via lockTaskMode in the manifest. For use by customers.

Types: array

config_global_proxy​

os.configuration.mason-management.config_global_proxy

Value indicating the network-independent global HTTP proxy of the type specified config_global_proxy_type. See the documentation for config_global_proxy_type for more information.

Types: string

direct_boot_package​

os.configuration.mason-management.direct_boot_package

The package name of the application to directly launch upon boot. The package name must refer to a valid Android application that follows the standard Android mechanism to mark a single "launchable" activity in its manifest.

Types: string

cert_installer_package os.configuration.mason-management.cert_installer_package

The package name of the app to be set as a certificate installer.

Types: string

config_adb_public_keys​

os.configuration.mason-management.config_adb_public_keys

List of ADB public keys that should be added to the system. This can be used to pre-authorize keys for known users. Removing a value here does not remove it from Android automatically.

Types: array

disable_screen_capture os.configuration.mason-management.disable_screen_capture

Flag indicating whether or not to disable screen capture

Types: boolean

config_global_proxy_type​

os.configuration.mason-management.config_global_proxy_type

Sets a network-independent global HTTP proxy of a given type. This is useful for general internal/corporation-wide filtering scenarios. On a private network where the proxy is NOT accessible for any reason, this could break HTTP on a device. This value is ignored if config_global_proxy is not set. Allowed values are: 'direct' - Specifies a direct proxy via host and port. It requires specification of config_global_proxy and parses the latter as host[:port] 'pac' - This is used to specify proxy auto-config (PAC). It requires specification of config_global_proxy and parses the latter as a URL to a PAC file. 'none' - This is the same as not specifying this configuration at all. The value of config_global_proxy, if set, is ignored. This is the default. NOTE: Typical HTTP proxies are generally network dependent. This setting is not on a per-network basis, but rather has a global effect. NOTE 2: This proxy is only a recommendation and it is possible that some apps, especially native apps or those that use custom HTTP client implementations will ignore it. @see https://developer.android.com/reference/android/app/admin/DevicePolicyManager#setRecommendedGlobalProxy(android.content.ComponentName,%20android.net.ProxyInfo)&#10;@see https://developer.mozilla.org/en-US/docs/Web/HTTP/Proxy_servers_and_tunneling/Proxy_Auto-Configuration_(PAC)_file&#10;

Types: string

Default: "none"

default_keyboard_package os.configuration.mason-management.default_keyboard_package

The package name of the keyboard to set as the default keyboard.

NOTES:

The package name must refer to a valid Android application that follows the standard Android mechanism for declaring input methods. The package must be included in the app section as part of the config. See apps for how an Android application is included into the software build.

Types: string

enable_ime_with_hard_keyboard os.configuration.mason-management.enable_ime_with_hard_keyboard

Flag indicating whether the soft input keyboard must be shown when a text input field is in focus even when an external keyboard is connected (such as an external Bluetooth hardware keyboard or a Bluetooth barcode scanner that uses the input device profile.)

Types: boolean

autogrant_runtime_permissions_packages​

os.configuration.mason-management.autogrant_runtime_permissions_packages

Android does not always grant all permissions requested by an application in its Android manifest. For instance, runtime permissions (or permissions marked as "development") are never granted automatically. A common development-time workaround is to assign such permissions to applications via adb shell pm grant <pkg> <perm>. This configuration value specifies an array of package names of apps that wish to be granted such permissions automatically without requiring the use of adb. Note that each of the applications corresponding to the packages indicated below must specify each of these permissions also within their manifest (AndroidManifest.xml) for this to work correctly. Use with care as this allows for privilege escalation.

Types: array

default_runtime_permissions_grant_policy​

os.configuration.mason-management.default_runtime_permissions_grant_policy

Sets the default permission grant policy for future runtime permission requests by apps that are installed either via config deployments, app deployments or adb. Allowed values are: 'autogrant': Permission policy to always grant new permission requests for runtime permissions. Already granted or denied permissions are not affected. 'autodeny' : Permission policy to always deny new permission requests for runtime permissions. Already granted or denied permissions are not affected. 'prompt' : Permission policy to always prompt the user for new permission requests for runtime permissions. Already granted or denied permissions are not affected. NOTE: If this configuration key is omitted or has an invalid value, it defaults to 'prompt'. See also: autogrant_runtime_permissions_packages

Types: string

Default: "prompt"

config_allow_install_from_unknown_sources​

os.configuration.mason-management.config_allow_install_from_unknown_sources

Flag indicating whether or not to allow installation of apps from unknown sources

Types: boolean

mason-app-updater​

config_update_install_time​

os.configuration.mason-app-updater.config_update_install_time

Target 24 hour install time for application updates that have been downloaded. (needs to be between 0-23 for the hour and 0-60 for the minute, delimited with a colon or -1 for immediate install after update check)

Types: string

Default: "-1"

config_update_check_at_boot​

os.configuration.mason-app-updater.config_update_check_at_boot

When true, performs an update check for all the packages at boot up regardless of other policies.

Types: boolean

Default: true

config_update_check_polling​

os.configuration.mason-app-updater.config_update_check_polling

When true, performs polling update checks as defined by the config_update_check_frequency

Types: boolean

Default: true

config_update_check_frequency​

os.configuration.mason-app-updater.config_update_check_frequency

The frequency for which to check for updates from boot, default is 24 hours

Types: integer, string (0[xX][0-9a-fA-F]8)

Default: 24

config_update_check_when_idle​

os.configuration.mason-app-updater.config_update_check_when_idle

When true, only performs update checks when the device is idle. Note that this is incompatible with and will override config_update_check_backoff_period.

Types: boolean

config_update_check_network_type​

os.configuration.mason-app-updater.config_update_check_network_type

NETWORK_TYPE_ANY The default update check network type, allows checks over any network Constant Value: 1 (0x00000001) NETWORK_TYPE_UNMETERED The update check requires network connectivity that is unmetered. Constant Value: 2 (0x00000002) NETWORK_TYPE_NOT_ROAMING The update check requires network connectivity that is not roaming. Constant Value: 3 (0x00000003)

Types: integer, string (0[xX][0-9a-fA-F]8)

Default: 1

config_default_connection_timeout​

os.configuration.mason-app-updater.config_default_connection_timeout

The default connection timeout for the mason endpoint

Types: integer, string (0[xX][0-9a-fA-F]8)

Default: 60

config_update_check_when_charging​

os.configuration.mason-app-updater.config_update_check_when_charging

When true, only performs update checks when the device is charging

Types: boolean

config_allow_download_over_metered​

os.configuration.mason-app-updater.config_allow_download_over_metered

When true, performs application downloads over a metered network

Types: boolean

Default: true

config_update_check_backoff_period​

os.configuration.mason-app-updater.config_update_check_backoff_period

The exponential backoff period in hours for a failed update check. Defaults to 5 hours. This configuration has no effect when config_update_check_when_idle is set to true.

Types: integer, string (0[xX][0-9a-fA-F]8)

Default: 5

config_show_download_in_downloads_ui​

os.configuration.mason-app-updater.config_show_download_in_downloads_ui

When true, shows the applications downloads in the downloads ui of the OS

Types: boolean

config_update_install_battery_threshold​

os.configuration.mason-app-updater.config_update_install_battery_threshold

Minimum battery level (as percentage) required for an update to be installed when the device is not plugged to a power source.

Types: integer, string (0[xX][0-9a-fA-F]8)

Default: 20

config_show_download_progress_as_notification​

os.configuration.mason-app-updater.config_show_download_progress_as_notification

When true, shows the application download progress as a persistent notification

Types: boolean

cellbroadcastreceiver​

config_regional_disable_cb_message​

os.configuration.cellbroadcastreceiver.config_regional_disable_cb_message

This configuration allows control over the default behavior of cell broadcast messages. If set to true, these alerts (such as "presidential" or "storm warning" alerts) will be suppressed. The default is false.

This configuration is appropriate for devices that are not intended to be used as primary communication devices.

Types: boolean

Default: true