Skip to content
  • There are no suggestions because the search field is empty.

Kiosk Component

The Kiosk Policy Component allows you to lock devices into a controlled kiosk experience. It enables control over navigation, system UI visibility, hardware buttons, launcher behavior, and advanced kiosk layouts.

Use this component when you want to configure devices for single app mode, multi app kiosk mode, or fully customized enterprise kiosk experiences.


Kiosk Customization

Kiosk Customization

API reference: kioskCustomization

Controls system UI, hardware buttons, and settings accessibility in kiosk mode.

Power Button Actions

API reference: kioskCustomization.powerButtonActions

OptionAPI referenceDescription
DefaultPOWER_BUTTON_ACTIONS_UNSPECIFIEDUses device default behavior.
AvailablePOWER_BUTTON_AVAILABLEPower button works normally.
BlockedPOWER_BUTTON_BLOCKEDPower button interaction is restricted.

System Error Warnings

API reference: kioskCustomization.systemErrorWarnings

OptionAPI referenceDescription
DefaultSYSTEM_ERROR_WARNINGS_UNSPECIFIEDUses default device behavior.
EnabledERROR_AND_WARNINGS_ENABLEDShows system errors and warnings.
MutedERROR_AND_WARNINGS_MUTEDSuppresses system error dialogs.

System Navigation

API reference: kioskCustomization.systemNavigation

OptionAPI referenceDescription
DefaultSYSTEM_NAVIGATION_UNSPECIFIEDUses device default navigation.
EnabledNAVIGATION_ENABLEDAllows full navigation access.
DisabledNAVIGATION_DISABLEDBlocks navigation buttons and gestures.
Home button onlyHOME_BUTTON_ONLYOnly home navigation allowed.

Status Bar Controls

API reference: kioskCustomization.statusBar

OptionAPI referenceDescription
DefaultSTATUS_BAR_UNSPECIFIEDUses device default behavior.
EnabledNOTIFICATIONS_AND_SYSTEM_INFO_ENABLEDShows notifications and system info.
DisabledNOTIFICATIONS_AND_SYSTEM_INFO_DISABLEDHides status bar notifications and info.
System info onlySYSTEM_INFO_ONLYShows system info without notifications.

Device Settings Access

API reference: kioskCustomization.deviceSettings

OptionAPI referenceDescription
DefaultDEVICE_SETTINGS_UNSPECIFIEDUses device default behavior.
AllowedSETTINGS_ACCESS_ALLOWEDUser can open device settings.
BlockedSETTINGS_ACCESS_BLOCKEDSettings access is restricted.

Kiosk Custom Launcher

Kiosk Custom Launcher

API reference: kioskCustomLauncherEnabled

Controls whether custom kiosk launcher mode is enabled.

Enable Custom Launcher

OptionAPI referenceDescription
Enable custom launcherbooleanEnables kiosk launcher experience.

Kiosk Type

API reference: kioskType

Available only if Advanced Kiosk feature is enabled in the plan and reseller supports it.

OptionAPI referenceDescription
NativeNATIVEStandard Android kiosk mode.
AdvancedADVANCEDAdvanced customizable kiosk experience.

Advanced Kiosk Configuration

Advanced Kiosk Configuration

API reference: advancedKioskManagedConfig

Provides advanced UI layout customization, theme configuration, orientation behavior, and message display.

Kiosk Orientation

API reference: advancedKioskManagedConfig.kiosk_orientation

OptionAPI referenceDescription
AutoAUTODevice automatically adjusts orientation.
PortraitPORTRAITLocks device to portrait mode.
LandscapeLANDSCAPELocks device to landscape mode.

Background Configuration

API reference: advancedKioskManagedConfig.kiosk_theme_configuration

OptionAPI referenceDescription
ColorCOLORUses solid background color.
ImageIMAGEUses background image.

Kiosk Message Configuration

API reference: advancedKioskManagedConfig.kiosk_message_configuration

FieldAPI referenceDescription
Messagekiosk_messageText message displayed on kiosk screen.
Message locationkiosk_message_locationPosition of message.

Message Location Options

OptionAPI referenceDescription
TopTOPMessage shown at top of screen.
BottomBOTTOMMessage shown at bottom of screen.

Kiosk Layout Configuration

Kiosk Layout Configuration

API reference: advancedKioskManagedConfig.kiosk_layouts_configuration

Controls application placement and screen layout design.

Layout Setup Mode

API reference: mode

OptionAPI referenceDescription
ManualMANUALAdmin manually designs layout.
AutoAUTOSystem automatically arranges layout.

Manual Layout Configuration

Available when layout mode is MANUAL.

FieldAPI referenceDescription
RowsrowsNumber of app rows.
ColumnscolumnsNumber of app columns.
PagespagesNumber of layout pages.

App Mapping

Defines app placement per grid coordinate and page.

Format: column x row x page

Example: 2x3x1 → Column 2, Row 3, Page 1


Summary

Use the Kiosk Policy Component to:

  • ✔ Lock devices into kiosk mode
  • ✔ Control navigation, system UI, and hardware buttons
  • ✔ Enable standard or advanced kiosk launchers
  • ✔ Customize kiosk layouts and UI appearance
  • ✔ Configure kiosk branding and messaging
  • ✔ Control application placement and layout

This component is essential for retail devices, POS systems, digital signage, field workforce devices, and enterprise kiosk deployments.