ISystemDevice (CloudPOSSDK)

All Superinterfaces:

IAdvanceDevice
```
public interface ISystemDevice
extends IAdvanceDevice
```
The system setting device including battery management, administrator management object, update application management, Bluetooth management, location information management, network management, etc.

Method Summary

All Methods Instance Methods Abstract Methods
Modifier and Type	Method and Description
`boolean`	`addToLockTaskAllowlist(String packageName)` Adds a single package to the LockTask (Kiosk) allowlist.
`boolean`	`cleanLockTaskAllowedPackages()` Removes the specified packages from the LockTask (Kiosk) allowlist.
`void`	`disableNavigationBarButton(int btnId, boolean disable)` disable navigation bar button
`IAdminDevice`	`getAdminManager()` Get the Admin manager
`IBatteryDevice`	`getBatteryManager()` Get the Battery manager
`IBluetoothDevice`	`getBluetoothManager()` Get the Bluetooth manager
`byte[]`	`getEth0Mac()` Get the device's ethernet mac address
`IHomeDevice`	`getHomeManager()` Get the home manager
`ILocationDevice`	`getLocationManager()` Get the location manager object to retrieve latitude and longitude information and to set the location level and location SDK.
`int`	`getLockScreenShowNotification()` Retrieves the current lock screen notification visibility policy.
`ILoginDevice`	`getLoginManager()` Get the login manager.
`boolean`	`getMtpStatus()` Get MTP Status
`INetworkDevice`	`getNetworkManager()` Get the manager for network devices (including Ethernet management, WiFi management, and APN management).
`String`	`getRebootTimeByEveryDay()` return"HH:MM:SS" or "Default"。
`byte[]`	`getScreenshotInPNG()` Captures the current screen content and returns it as a PNG-compressed byte array.
`boolean`	`getShowTouchesState()` get ‘show touches’ state for enable or disable.
`boolean`	`getStatusbarSettingsButtonVisibility()` get statusbar settings button status.
`String`	`getTextOnLockScreen()` Retrieves the current custom text displayed on the lock screen.
`String`	`getTouchScreenWakeupValue()`
`IUpdateAppDevice`	`getUpdateAppManager()` Get the UpdateApp manager
`IUserCredentials`	`getUserCredentialsManager()` Get the user credentials manager
`boolean`	`isAccessibilityDisplayInversion()` Get the setting that indicates whether display color inversion is enabled.
`boolean`	`isButtonWakeup()`
`boolean`	`isEnableAutoTime()` get status for enable/disable auto time item.
`boolean`	`isEnableAutoTimeGUI()` get status for enable/disable auto time item GUI.
`boolean`	`isEnableAutoTimezone()` get status for enable/disable auto timezone item.
`boolean`	`isEnableAutoTimezoneGUI()` get status for enable/disable auto timezone item GUI.
`boolean`	`isEnableBluetooth()` Get the current Bluetooth status (enabled or disabled).
`boolean`	`isEnableCamera()` Get the current Camera status (enabled or disabled).
`boolean`	`isEnabledShowBatteryPercent()` Is the battery percentage already displayed
`boolean`	`isEnableUsb()` Get the current Camera status (enabled or disabled).
`boolean`	`isEnableWifi()` Get the current Wi-Fi status (enabled or disabled).
`boolean`	`isPowerKeyBlocked()` check PowerKey Button 's block status.
`boolean`	`isTerminalRooted()` Is the current terminal rooted.
`boolean`	`isWifiStaticIp(String ssid)` Is the current Wi-Fi using a static IP
`void`	`lockNow()` lock now
`boolean`	`reboot()` reboot terminal return true: success; false: failed。
`boolean`	`removeFromLockTaskAllowlist(String packageName)` Removes a single package from the LockTask (Kiosk) allowlist.
`Bitmap`	`screenshot()` Captures the current screen content and returns it as a `android.graphics.Bitmap`.
`void`	`setAccessibilityDisplayInversion(boolean enable)` Setting that specifies whether display color inversion is enabled.
`void`	`setAirplaneMode(boolean enable)` enable/disable Airplane Mode
`void`	`setAutoTime(boolean enable)` enable/disable auto time item.
`void`	`setAutoTimeGUI(boolean enable)` enable/disable show auto time item GUI.
`void`	`setAutoTimezone(boolean enable)` enable/disable auto timezone item.
`void`	`setAutoTimezoneGUI(boolean enable)` enable/disable show auto timezone item GUI.
`boolean`	`setBluetooth(boolean enable)` Enable or Disable the bluetooth device
`boolean`	`setButtonWakeup(boolean enable)`
`boolean`	`setCamera(boolean enable)` Enable or Disable the Camera device
`boolean`	`setCustomAttribute(String key, String value)` Set "persist.wp.usr.${key}"'s property , max count = 10.
`boolean`	`setDeviceOwner(String pkg, String deviceCls)`
`boolean`	`setLanguage(String language, String country, String variant)` set Language
`void`	`setLockScreenShowNotification(int flag)` Sets the lock screen notification visibility policy.
`boolean`	`setLockTaskAllowedPackages(String[] packageNames)` Sets the list of packages that are allowed to launch activities while the device is running in LockTask (Kiosk) mode.
`void`	`setMtp(boolean enable)` Enable/Disable MTP
`void`	`setPasswordLock(boolean enable, String password)` Sets a password to unlock the device.
`void`	`setPatternLock(boolean enable, String pattern)` Sets a pattern to unlock the device.
`void`	`setPinLock(boolean enable, String pin)` Sets a numeric PIN to unlock the device.
`void`	`setPowerKeyBlocked(boolean enable)` Block or Release The Power Key
`boolean`	`setRebootTimeByEveryDay(int hour, int minute, int second)`
`boolean`	`setRestrictBackground(boolean enable)` enable/disable Data Saver Mode。
`boolean`	`setScreenOffTimeout(int milliseconds)` Added by Stone for task #22834 to add a interface to set screen off timeout.
`void`	`setShowBatteryPercent(boolean enable)` Set whether to display the battery percentage
`void`	`setShowTouches(boolean enable)` Enabling ‘show touches’ in Android screen recordings for user research.
`void`	`setStatusBarLocked(boolean lock)` Set the status bar locked as true will make the status bar can not be pull down.
`void`	`setStatusbarSettingsButtonVisibility(boolean visibility)` visibility/hide statusbar settings button
`boolean`	`setSystemOrientation(int rotationType)` set orientation
`void`	`setTextOnLockScreen(String text)` Sets a custom text message to be displayed on the lock screen.
`boolean`	`setTouchScreenWakeupValue(String touch)`
`boolean`	`setUnknownSources(String packageName, boolean enable)` Enable packageName the permission to install apps from unknown sources.
`boolean`	`setUsb(boolean enable)` Enable or Disable the USB device
`boolean`	`setWifi(boolean enable)` Enable or Disable the Wi-Fi device
`boolean`	`setWifiDHCP(String ssid)` set the Wi-Fi DHCP IP.
`boolean`	`setWifiStaticIp(String ssid, IpBean ipBean)` set the Wi-Fi static IP.
`boolean`	`shutdown(boolean confirm, String reason, boolean wait)` Turn off the device.
`boolean`	`stopApp(String pkgName)` Force-stops a payment application.

Methods inherited from interface com.cloudpos.advance.ext.IAdvanceDevice
close, isOpened, open

- Method Detail
  - addToLockTaskAllowlist
```
boolean addToLockTaskAllowlist(String packageName)
                        throws DeviceException
```
    Adds a single package to the LockTask (Kiosk) allowlist.
    The specified package will be permitted to temporarily launch activities or present UI while the device is operating in LockTask mode. This method performs an incremental update and does not replace the existing allowlist.
    
    If the package is already present in the allowlist, no changes will be made.
    Parameters:
    packageName - the package name to be added to the LockTask allowlist
    Applications must request permission :
    
    <uses-permission android:name="android.permission.CLOUDPOS_MANAGE_APP" />
    Returns:
    
    true if the allowlist was modified as a result of this call, or false if the package was already present or the operation failed
    
    Throws:
    
    DeviceException
  - cleanLockTaskAllowedPackages
```
boolean cleanLockTaskAllowedPackages()
                              throws DeviceException
```
    Removes the specified packages from the LockTask (Kiosk) allowlist.
    This method performs an incremental removal: only the package names provided in packageNames will be removed from the current allowlist, while all other entries remain unaffected.
    
    If packageNames is null or empty, this method takes no action.
    
    Removing a package that is not currently in the allowlist has no effect.
    
    Applications must request permission:
```
 <uses-permission android:name="android.permission.CLOUDPOS_MANAGE_APP" /> 
```
    Returns:
    
    true if the allowlist was modified as a result of this call, or false if none of the specified packages were present, the input was null/empty, or the operation failed
    
    Throws:
    
    DeviceException
  - disableNavigationBarButton
```
void disableNavigationBarButton(int btnId,
                                boolean disable)
                         throws DeviceException
```
    disable navigation bar button
    Parameters:
    
    btnId - BTN_ID_HOME = 0 , BTN_ID_BACK = 1, BTN_ID_RESENT =2;
    disable - true or false
    Applications must request permission :
    
    <uses-permission android:name="android.permission.CLOUDPOS_NAVIGATION_BUTTON" />
    Throws:
    
    DeviceException - if set error
  - getAdminManager
```
IAdminDevice getAdminManager()
```
    Get the Admin manager
    
    Returns:
    
    IAdminManager
    
    See Also:
    
    IAdminDevice
  - getBatteryManager
```
IBatteryDevice getBatteryManager()
```
    Get the Battery manager
    
    Returns:
    
    IBatteryMgr
    
    See Also:
    
    IBatteryDevice
  - getBluetoothManager
```
IBluetoothDevice getBluetoothManager()
```
    Get the Bluetooth manager
    
    Returns:
    
    IBluetoothManager
    
    See Also:
    
    IBluetoothDevice
  - getEth0Mac
```
byte[] getEth0Mac()
           throws DeviceException
```
    Get the device's ethernet mac address
    Returns:
    if get success return ethernet mac byte[].
    Applications must request permission :
    
    <uses-permission android:name="android.permission.ACCESS_NETWORK_STATE" />
    Throws:
    
    DeviceException - if get error
  - getHomeManager
```
IHomeDevice getHomeManager()
```
    Get the home manager
    
    Returns:
    
    IHomeDevice
    
    See Also:
    
    IHomeDevice
  - getLocationManager
```
ILocationDevice getLocationManager()
```
    Get the location manager object to retrieve latitude and longitude information and to set the location level and location SDK.
    
    Returns:
    
    ILocationManager
    
    See Also:
    
    ILocationDevice
  - getLockScreenShowNotification
```
int getLockScreenShowNotification()
                           throws DeviceException
```
    Retrieves the current lock screen notification visibility policy.
    
    Returns:
    
    Current mode (ALL/NONE/SENSITIVE_ONLY). int ALL = 1; // Show all notifications int NONE = 2; // Hide all notifications int SENSITIVE_ONLY = 3; // Show non-sensitive notifications only (default)
    
    Throws:
    
    DeviceException
  - getLoginManager
```
ILoginDevice getLoginManager()
```
    Get the login manager.
    
    Returns:
    
    ILoginDevice
    
    See Also:
    
    ILoginDevice
  - getMtpStatus
```
boolean getMtpStatus()
              throws DeviceException
```
    Get MTP Status
    
    Returns:
    
    true:Enable MTP ; false:Disable MTP;
    
    Throws:
    
    DeviceException
  - getNetworkManager
```
INetworkDevice getNetworkManager()
```
    Get the manager for network devices (including Ethernet management, WiFi management, and APN management).
    
    Returns:
    
    INetworkManager
    
    See Also:
    
    INetworkDevice
  - getRebootTimeByEveryDay
```
String getRebootTimeByEveryDay()
                        throws DeviceException
```
    return"HH:MM:SS" or "Default"。
    Applications must request permission :
```
 <uses-permission android:name="android.permission.CLOUDPOS_REBOOT" /> 
```
    Throws:
    
    DeviceException
  - getScreenshotInPNG
```
byte[] getScreenshotInPNG()
                   throws DeviceException
```
    Captures the current screen content and returns it as a PNG-compressed byte array.
    This method is typically used by system-level services or privileged applications to retrieve the current visual content displayed on the device screen in a compressed format. The returned byte array contains the raw PNG image data, which can be directly written to a file or transmitted over a network.
    
    Note:
    - The returned byte[] may be null if the screenshot operation fails.
    - Although the image is compressed in PNG format, very large screens or high-density displays may still produce large data sizes. When transferring across Binder, this could lead to android.os.TransactionTooLargeException or significant memory pressure. Consider further compression, scaling, or using alternative IPC mechanisms for large payloads.
    - This method usually requires system-level permission or signature-level access (for example android.permission.READ_FRAME_BUFFER). Regular apps may not have access.
    - The encoding process may take additional CPU time compared to raw bitmap transfer. Performance may vary depending on screen resolution and device capabilities.
    Returns:
    a byte[] containing the PNG-encoded screen capture, or null if the screenshot could not be captured or encoded.
    Applications must request permission :
    
    <uses-permission android:name="android.permission.READ_FRAME_BUFFER" />
    Throws:
    
    DeviceException - if the call fails
  - getShowTouchesState
```
boolean getShowTouchesState()
                     throws DeviceException
```
    get ‘show touches’ state for enable or disable.
    
    Returns:
    
    ture: enable ‘show touches’; false: disable ‘show touches’.
    
    Throws:
    
    DeviceException
  - getStatusbarSettingsButtonVisibility
```
boolean getStatusbarSettingsButtonVisibility()
                                      throws DeviceException
```
    get statusbar settings button status.
    
    Returns:
    
    true: statusbar settings button visibility ; false: statusbar settings button hide.
    
    Throws:
    
    DeviceException
  - getTextOnLockScreen
```
String getTextOnLockScreen()
                    throws DeviceException
```
    Retrieves the current custom text displayed on the lock screen.
    
    Returns:
    
    The currently set lock screen text, or empty string if no text is set.
    
    Throws:
    
    DeviceException
  - getTouchScreenWakeupValue
```
String getTouchScreenWakeupValue()
                          throws DeviceException
```
    Returns:
    return touch screen wakeup value. touch:Add wake on touch；none: Only the power button wakes up
    Applications must request permission :
    
    <uses-permission android:name="android.permission.CLOSEPOS_SET_SCREEN_WAKEUP" />
    
    <uses-permission android:name="android.permission.CLOUDPOS_SET_SCREEN_WAKEUP" />
    Throws:
    
    DeviceException
  - getUpdateAppManager
```
IUpdateAppDevice getUpdateAppManager()
```
    Get the UpdateApp manager
    
    Returns:
    
    IUpdateAppManager
    
    See Also:
    
    IUpdateAppDevice
  - getUserCredentialsManager
```
IUserCredentials getUserCredentialsManager()
```
    Get the user credentials manager
    
    Returns:
    
    IUserCredentials
    
    See Also:
    
    IUserCredentials
  - isAccessibilityDisplayInversion
```
boolean isAccessibilityDisplayInversion()
                                 throws DeviceException
```
    Get the setting that indicates whether display color inversion is enabled.
    Applications must request permission :
```
 <uses-permission android:name="android.permission.READ_POS_SETTINGS" /> 
```
    Throws:
    
    DeviceException - if set error
  - isButtonWakeup
```
boolean isButtonWakeup()
                throws DeviceException
```
    Returns:
    return is button wakeup true or false
    Applications must request permission :
    
    <uses-permission android:name="android.permission.WRITE_POS_SETTINGS" />
    Throws:
    
    DeviceException - if the call fails
  - isEnableAutoTime
```
boolean isEnableAutoTime()
                  throws DeviceException
```
    get status for enable/disable auto time item.
    
    Returns:
    
    enable true: enable; false: disable
    
    Throws:
    
    DeviceException
  - isEnableAutoTimeGUI
```
boolean isEnableAutoTimeGUI()
                     throws DeviceException
```
    get status for enable/disable auto time item GUI.
    
    Returns:
    
    enable true: enable; false: disable
    
    Throws:
    
    DeviceException
  - isEnableAutoTimezone
```
boolean isEnableAutoTimezone()
                      throws DeviceException
```
    get status for enable/disable auto timezone item.
    
    Returns:
    
    enable true: enable; false: disable
    
    Throws:
    
    DeviceException
  - isEnableAutoTimezoneGUI
```
boolean isEnableAutoTimezoneGUI()
                         throws DeviceException
```
    get status for enable/disable auto timezone item GUI.
    
    Returns:
    
    enable true: enable; false: disable
    
    Throws:
    
    DeviceException
  - isEnableBluetooth
```
boolean isEnableBluetooth()
                   throws DeviceException
```
    Get the current Bluetooth status (enabled or disabled).
    
    Returns:
    
    enable true: enable; false: disable
    
    Throws:
    
    DeviceException
  - isEnableCamera
```
boolean isEnableCamera()
                throws DeviceException
```
    Get the current Camera status (enabled or disabled).
    Returns:
    enable true: enable; false: disable
    Applications must request permission :
    
    <uses-permission android:name="android.permission.CAMERA" />
    Throws:
    
    DeviceException
  - isEnabledShowBatteryPercent
```
boolean isEnabledShowBatteryPercent()
                             throws DeviceException
```
    Is the battery percentage already displayed
    Applications must request permission :
```
 <uses-permission android:name="android.permission.READ_POS_SETTINGS" /> 
```
    Throws:
    
    DeviceException - if the call fails
  - isEnableUsb
```
boolean isEnableUsb()
             throws DeviceException
```
    Get the current Camera status (enabled or disabled).
    Returns:
    enable true: enable; false: disable
    Applications must request permission :
    
    <uses-permission android:name="android.permission.USB" />
    Throws:
    
    DeviceException
  - isEnableWifi
```
boolean isEnableWifi()
              throws DeviceException
```
    Get the current Wi-Fi status (enabled or disabled).
    
    Returns:
    
    enable true: enable; false: disable
    
    Throws:
    
    DeviceException
  - isPowerKeyBlocked
```
boolean isPowerKeyBlocked()
                   throws DeviceException
```
    check PowerKey Button 's block status.
    Returns:
    true : blocked the power key; false: not block the power key.
    Applications must request permission :
    
    <uses-permission android:name="android.permission.CLOUDPOS_DISABLE_POWER_KEY" />
    Throws:
    
    DeviceException
  - isTerminalRooted
```
boolean isTerminalRooted()
                  throws DeviceException
```
    Is the current terminal rooted.
    
    Returns:
    
    true: is rooted; false: not root
    
    Throws:
    
    DeviceException
  - isWifiStaticIp
```
boolean isWifiStaticIp(String ssid)
                throws DeviceException
```
    Is the current Wi-Fi using a static IP
    Parameters:
    
    ssid - the Wi-Fi ssid
    
    Returns:
    
    true The current Wi-Fi is using a static IP; false The current Wi-Fi is using DHCP.
    
    Throws:
    DeviceException - if the call fails
    Applications must request permission :
    
    <uses-permission android:name="android.permission.CHANGE_WIFI_STATE" />
    
    <uses-permission android:name="android.permission.ACCESS_WIFI_STATE" />
    
    <uses-permission android:name="android.permission.ACCESS_FINE_LOCATION" />
  - lockNow
```
void lockNow()
      throws DeviceException
```
    lock now
    
    Throws:
    
    DeviceException
  - reboot
```
boolean reboot()
        throws DeviceException
```
    reboot terminal return true: success; false: failed。
    Applications must request permission :
```
 <uses-permission android:name="android.permission.CLOUDPOS_REBOOT" /> 
```
    Throws:
    
    DeviceException
  - removeFromLockTaskAllowlist
```
boolean removeFromLockTaskAllowlist(String packageName)
                             throws DeviceException
```
    Removes a single package from the LockTask (Kiosk) allowlist.
    After removal, the specified package will no longer be permitted to launch activities or present UI while the device is operating in LockTask mode.
    
    If the package is not currently present in the allowlist, this method performs no action.
    Parameters:
    packageName - the package name to be removed from the LockTask allowlist
    Applications must request permission :
    
    <uses-permission android:name="android.permission.CLOUDPOS_MANAGE_APP" />
    Returns:
    
    true if the allowlist was modified as a result of this call, or false if the package was not present or the operation failed
    
    Throws:
    
    DeviceException
  - screenshot
```
Bitmap screenshot()
           throws DeviceException
```
    Captures the current screen content and returns it as a android.graphics.Bitmap.
    This method is typically used by system-level services or privileged applications to retrieve the current visual content displayed on the device screen.
    
    Note:
    - The returned Bitmap may be null if the screenshot operation fails.
    - Since Bitmap is transferred across Binder, large images may cause android.os.TransactionTooLargeException or high memory usage. For performance and reliability, consider scaling or compressing the bitmap.
    - This method usually requires system-level permission or signature-level access (for example android.permission.READ_FRAME_BUFFER). Regular apps may not have access.
    Returns:
    a Bitmap object representing the current screen content, or null if the screenshot could not be captured.
    Applications must request permission :
    
    <uses-permission android:name="android.permission.READ_FRAME_BUFFER" />
    Throws:
    
    DeviceException - if the call fails
  - setAccessibilityDisplayInversion
```
void setAccessibilityDisplayInversion(boolean enable)
                               throws DeviceException
```
    Setting that specifies whether display color inversion is enabled.
    Applications must request permission :
```
 <uses-permission android:name="android.permission.WRITE_POS_SETTINGS" /> 
```
    Throws:
    
    DeviceException - if set error
  - setAirplaneMode
```
void setAirplaneMode(boolean enable)
              throws DeviceException
```
    enable/disable Airplane Mode
    
    Parameters:
    
    enable - : true: alirplane mode on ; false: alirplane mode off.
    
    Throws:
    
    DeviceException
  - setAutoTime
```
void setAutoTime(boolean enable)
          throws DeviceException
```
    enable/disable auto time item.
    
    Parameters:
    
    enable - true: enable; false: disable
    
    Throws:
    
    DeviceException
  - setAutoTimeGUI
```
void setAutoTimeGUI(boolean enable)
             throws DeviceException
```
    enable/disable show auto time item GUI.
    
    Parameters:
    
    enable - true: enable; false: disable
    
    Throws:
    
    DeviceException
  - setAutoTimezone
```
void setAutoTimezone(boolean enable)
              throws DeviceException
```
    enable/disable auto timezone item.
    
    Parameters:
    
    enable - true: enable; false: disable
    
    Throws:
    
    DeviceException
  - setAutoTimezoneGUI
```
void setAutoTimezoneGUI(boolean enable)
                 throws DeviceException
```
    enable/disable show auto timezone item GUI.
    
    Parameters:
    
    enable - true: enable; false: disable
    
    Throws:
    
    DeviceException
  - setBluetooth
```
boolean setBluetooth(boolean enable)
              throws DeviceException
```
    Enable or Disable the bluetooth device
    Parameters:
    
    enable - a boolean indicating whether to enable or disable the bluetooth device.
    
    Returns:
    true is success, false is fail.
    Applications must request permission :
    
    <uses-permission android:name="android.permission.BLUETOOTH" />
    Throws:
    
    DeviceException
  - setButtonWakeup
```
boolean setButtonWakeup(boolean enable)
                 throws DeviceException
```
    Parameters:
    
    enable - Enable/disable waking up terminal by function key .
    
    Returns:
    return result for success or failed!.
    Applications must request permission :
    
    <uses-permission android:name="android.permission.WRITE_POS_SETTINGS" />
    Throws:
    
    DeviceException - if the call fails
  - setCamera
```
boolean setCamera(boolean enable)
           throws DeviceException
```
    Enable or Disable the Camera device
    Parameters:
    
    enable - a boolean indicating whether to enable or disable the Camera device.
    
    Returns:
    true is success, false is fail.
    Applications must request permission :
    
    <uses-permission android:name="android.permission.CAMERA" />
    Throws:
    
    DeviceException
  - setCustomAttribute
```
boolean setCustomAttribute(String key,
                           String value)
                    throws DeviceException
```
    Set "persist.wp.usr.${key}"'s property , max count = 10. Permission： android.permission.CLOUDPOS_SET_USR_PROP
    Parameters:
    
    key: - property's key, length less than 16. for example: persist.wp.usr.${key} ${value}.
    
    value: - property's value, length less than 32.
    
    Returns:
    set success for true ; set failed for false
    Applications must request permission :
    
    <uses-permission android:name="android.permission.CLOUDPOS_SET_USR_PROP" />
    Throws:
    
    DeviceException
  - setDeviceOwner
```
boolean setDeviceOwner(String pkg,
                       String deviceCls)
                throws DeviceException
```
    Parameters:
    
    pkg: - package name.
    
    deviceCls: - policyReceiver's class name.
    
    Returns:
    
    active success for true ; active failed for false
    
    Throws:
    
    DeviceException
  - setLanguage
```
boolean setLanguage(String language,
                    String country,
                    String variant)
             throws DeviceException
```
    set Language
    
    Parameters:
    
    language: - (Null is not allowed)An ISO 639 alpha-2 or alpha-3 language code, or a language subtag up to 8 characters in length. See the Locale class description about valid language values.
    
    country - : (Null is allowed)An ISO 3166 alpha-2 country code or a UN M.49 numeric-3 area code. See the Locale class description about valid country values.
    
    variant - : (Null is allowed)Any arbitrary value used to indicate a variation of a Locale. See the Locale class description for the details.
    for example: Locale(String language, String country, String variant) or Locale(String language, String country) or Locale(String language)
    
    Returns:
    
    true:set success ; false: set failed;
    
    Throws:
    
    DeviceException
  - setLockScreenShowNotification
```
void setLockScreenShowNotification(int flag)
                            throws DeviceException
```
    Sets the lock screen notification visibility policy.
    
    Parameters:
    
    flag - Visibility mode. Valid values: int ALL = 1; // Show all notifications int NONE = 2; // Hide all notifications int SENSITIVE_ONLY = 3; // Show non-sensitive notifications only (default)
    
    Throws:
    
    DeviceException - if flag is not 1 or 2 or 3
  - setLockTaskAllowedPackages
```
boolean setLockTaskAllowedPackages(String[] packageNames)
                            throws DeviceException
```
    Sets the list of packages that are allowed to launch activities while the device is running in LockTask (Kiosk) mode.
    The provided package list defines the complete allowlist of privileged applications that are permitted to temporarily break out of the kiosk foreground and present UI (for example, system dialogs or auxiliary activities).
    
    If packageNames is null or empty, the current LockTask allowlist will be cleared and no additional applications will be granted privileged access.
    
    This method replaces any previously configured allowlist.
    Parameters:
    packageNames - an array of package names to be allowed in LockTask mode, or null to clear the privileged application list
    Applications must request permission :
    
    <uses-permission android:name="android.permission.CLOUDPOS_MANAGE_APP" />
    Returns:
    
    true successfully false Terminal system version not supported
    
    Throws:
    
    DeviceException
  - setMtp
```
void setMtp(boolean enable)
     throws DeviceException
```
    Enable/Disable MTP
    
    Parameters:
    
    enable: - true:Enable MTP ; false:Disable MTP;
    
    Throws:
    
    DeviceException
  - setPasswordLock
```
void setPasswordLock(boolean enable,
                     String password)
              throws DeviceException
```
    Sets a password to unlock the device.
    Parameters:
    
    password - the password to set, must be at least 4 characters and may contain letters and numbers.
    
    Throws:
    DeviceException -
    Applications must request permission :
    
    <uses-permission android:name="android.permission.CREATE_USERS" />
  - setPatternLock
```
void setPatternLock(boolean enable,
                    String pattern)
             throws DeviceException
```
    Sets a pattern to unlock the device. The pattern must consist of 4 to 16 connected points in a 3x3 grid, corresponding to the following grid:
```
 1    2   3
 4    5   6
 7    8   9
 
```
    Each point in the pattern must be unique and cannot be repeated.
    
    Example: To set an L-shaped pattern, use the array: {1, 4, 7, 8, 9}.
    Parameters:
    
    pattern - an array of integers representing the pattern, with each element being a number between 1 and 9.
    
    Throws:
    DeviceException -
    Applications must request permission :
    
    <uses-permission android:name="android.permission.CREATE_USERS" />
  - setPinLock
```
void setPinLock(boolean enable,
                String pin)
         throws DeviceException
```
    Sets a numeric PIN to unlock the device.
    Parameters:
    
    pin - the PIN to set, must be at least 4 digits (numeric only).
    
    Throws:
    DeviceException -
    Applications must request permission :
    
    <uses-permission android:name="android.permission.CREATE_USERS" />
  - setPowerKeyBlocked
```
void setPowerKeyBlocked(boolean enable)
                 throws DeviceException
```
    Block or Release The Power Key
    Parameters:
    enable: - true:Block The Power Key ; false:Release The Power Key ;
    Applications must request permission :
    
    <uses-permission android:name="android.permission.CLOUDPOS_DISABLE_POWER_KEY" />
    Throws:
    
    DeviceException
  - setRebootTimeByEveryDay
```
boolean setRebootTimeByEveryDay(int hour,
                                int minute,
                                int second)
                         throws DeviceException
```
    Parameters:
    hour - [0,23], minute [0,59], second [0,59] return true: success; false: failed。
    Applications must request permission :
    
    <uses-permission android:name="android.permission.CLOUDPOS_REBOOT" />
    Throws:
    
    DeviceException
  - setRestrictBackground
```
boolean setRestrictBackground(boolean enable)
                       throws DeviceException
```
    enable/disable Data Saver Mode。
    
    Parameters:
    
    enable: - true: enable Data Saver Mode，false: diable Data Saver Mode.
    
    Throws:
    
    DeviceException
  - setScreenOffTimeout
```
boolean setScreenOffTimeout(int milliseconds)
                     throws DeviceException
```
    Added by Stone for task #22834 to add a interface to set screen off timeout.
    Parameters:
    
    milliseconds - the time you want to set, can be one of following: 15000 - 15s 30000 - 30s 60000 - 1 minute 120000 - 2 minutes 300000 - 5 minutes 600000 - 10 minutes 1800000 - 30 minutes 2147483647(Integer.MAX_VALUE) - never
    
    Returns:
    whether the new milliseconds has been set.
    Applications must request permission :
    
    <uses-permission android:name="android.permission.CLOUDPOS_SET_SCREEN_OFF_TIMEOUT" />
    Throws:
    
    DeviceException
  - setShowBatteryPercent
```
void setShowBatteryPercent(boolean enable)
                    throws DeviceException
```
    Set whether to display the battery percentage
    Parameters:
    enable - a boolean value to set whether to display the battery percentage
    Applications must request permission :
    
    <uses-permission android:name="android.permission.WRITE_POS_SETTINGS" />
    Throws:
    
    DeviceException - if set error
  - setShowTouches
```
void setShowTouches(boolean enable)
             throws DeviceException
```
    Enabling ‘show touches’ in Android screen recordings for user research.
    
    Parameters:
    
    enable: - true, false;
    
    Throws:
    
    DeviceException
  - setStatusBarLocked
```
void setStatusBarLocked(boolean lock)
                 throws DeviceException
```
    Set the status bar locked as true will make the status bar can not be pull down.
    Applications must request permission :
```
 <uses-permission android:name="android.permission.CLOUDPOS_LOCK_STATUS_BAR" /> 
```
    Parameters:
    
    lock, - true for lock, false for disable lock.
    
    Throws:
    
    DeviceException
  - setStatusbarSettingsButtonVisibility
```
void setStatusbarSettingsButtonVisibility(boolean visibility)
                                   throws DeviceException
```
    visibility/hide statusbar settings button
    
    Parameters:
    
    visibility - : true: statusbar settings button show ; false: statusbar settings button hide.
    
    Throws:
    
    DeviceException
  - setSystemOrientation
```
boolean setSystemOrientation(int rotationType)
                      throws DeviceException
```
    set orientation
    
    Parameters:
    
    rotationType - int ROTATION_0 = 0; Rotation constant: 0 degree rotation (natural orientation) int ROTATION_90 = 1; Rotation constant: 90 degree rotation. int ROTATION_180 = 2;Rotation constant: 180 degree rotation. int ROTATION_270 = 3;Rotation constant: 270 degree rotation.
    
    Returns:
    
    result true: success; false: failed
    
    Throws:
    
    DeviceException
  - setTextOnLockScreen
```
void setTextOnLockScreen(String text)
                  throws DeviceException
```
    Sets a custom text message to be displayed on the lock screen.
    
    Parameters:
    
    text - The message to display. Cannot be null. Use empty string to clear the lock screen text.
    
    Throws:
    
    DeviceException - if text is null
  - setTouchScreenWakeupValue
```
boolean setTouchScreenWakeupValue(String touch)
                           throws DeviceException
```
    Parameters:
    
    touch:Add - wake on touch； double：Add wake on double touch none: Only the power button wakes up
    
    Returns:
    return result for success or failed!.
    Applications must request permission :
    
    <uses-permission android:name="android.permission.CLOSEPOS_SET_SCREEN_WAKEUP" />
    
    <uses-permission android:name="android.permission.CLOUDPOS_SET_SCREEN_WAKEUP" />
    Throws:
    
    DeviceException
  - setUnknownSources
```
boolean setUnknownSources(String packageName,
                          boolean enable)
                   throws DeviceException
```
    Enable packageName the permission to install apps from unknown sources.
    Returns:
    true: set success ; false: set failed, packageName not found.
    Applications must request permission :
    
    <uses-permission android:name="android.permission.CLOUDPOS_SET_UNKOWN_SOURCE" />
    Throws:
    
    DeviceException
  - setUsb
```
boolean setUsb(boolean enable)
        throws DeviceException
```
    Enable or Disable the USB device
    Parameters:
    
    enable - a boolean indicating whether to enable or disable the USB device.
    
    Returns:
    true is success, false is fail.
    Applications must request permission :
    
    <uses-permission android:name="android.permission.USB" />
    Throws:
    
    DeviceException
  - setWifi
```
boolean setWifi(boolean enable)
         throws DeviceException
```
    Enable or Disable the Wi-Fi device
    Parameters:
    
    enable - a boolean indicating whether to enable or disable the Wi-Fi device.
    
    Returns:
    true is success, false is fail.
    Applications must request permission :
    
    <uses-permission android:name="android.permission.WIFI" />
    Throws:
    
    DeviceException
  - setWifiDHCP
```
boolean setWifiDHCP(String ssid)
             throws DeviceException
```
    set the Wi-Fi DHCP IP.
    Parameters:
    
    ssid - the Wi-Fi ssid
    
    Returns:
    
    true on success; false otherwise.
    
    Throws:
    DeviceException - if the call fails
    Applications must request permission :
    
    <uses-permission android:name="android.permission.CHANGE_WIFI_STATE" />
  - setWifiStaticIp
```
boolean setWifiStaticIp(String ssid,
                        IpBean ipBean)
                 throws DeviceException
```
    set the Wi-Fi static IP.
    Parameters:
    
    ssid - the Wi-Fi ssid
    
    ipBean - the Wi-Fi ipBean , set ipAddress,prefixLength,gateway,dnsServer
    
    Returns:
    
    true on success; false otherwise.
    
    Throws:
    DeviceException - if the call fails
    Applications must request permission :
    
    <uses-permission android:name="android.permission.CHANGE_WIFI_STATE" />
  - shutdown
```
boolean shutdown(boolean confirm,
                 String reason,
                 boolean wait)
          throws DeviceException
```
    Turn off the device.
    Parameters:
    
    confirm - If true, shows a shutdown confirmation dialog.
    
    reason - code to pass to android_reboot() (e.g. "userrequested"), or null.
    wait - If true, this call waits for the shutdown to complete and does not return. return true: success; false: failed。
    Applications must request permission :
    
    <uses-permission android:name="android.permission.CLOUDPOS_REBOOT" />
    Throws:
    
    DeviceException
  - stopApp
```
boolean stopApp(String pkgName)
         throws DeviceException
```
    Force-stops a payment application.
    This API terminates the target process immediately and clears its running state. Only built-in/system special payment applications are allowed to be terminated by this method. Calling this on non-built-in apps will return false without performing any action.
    Parameters:
    
    pkgName - the package name of the payment application
    
    Returns:
    true if the app process was successfully terminated; false otherwise
    Applications must request permission :
    
    <uses-permission android:name="android.permission.CLOUDPOS_MANAGE_APP" />
    Throws:
    
    DeviceException

Interface ISystemDevice

Method Summary

Methods inherited from interface com.cloudpos.advance.ext.IAdvanceDevice

Method Detail

addToLockTaskAllowlist

cleanLockTaskAllowedPackages

disableNavigationBarButton

getAdminManager

getBatteryManager

getBluetoothManager

getEth0Mac

getHomeManager

getLocationManager

getLockScreenShowNotification

getLoginManager

getMtpStatus

getNetworkManager

getRebootTimeByEveryDay

getScreenshotInPNG

getShowTouchesState

getStatusbarSettingsButtonVisibility

getTextOnLockScreen

getTouchScreenWakeupValue

getUpdateAppManager

getUserCredentialsManager

isAccessibilityDisplayInversion

isButtonWakeup

isEnableAutoTime

isEnableAutoTimeGUI

isEnableAutoTimezone

isEnableAutoTimezoneGUI

isEnableBluetooth

isEnableCamera

isEnabledShowBatteryPercent

isEnableUsb

isEnableWifi

isPowerKeyBlocked

isTerminalRooted

isWifiStaticIp

lockNow

reboot

removeFromLockTaskAllowlist

screenshot

setAccessibilityDisplayInversion

setAirplaneMode

setAutoTime

setAutoTimeGUI

setAutoTimezone

setAutoTimezoneGUI

setBluetooth

setButtonWakeup

setCamera

setCustomAttribute

setDeviceOwner

setLanguage

setLockScreenShowNotification

setLockTaskAllowedPackages

setMtp

setPasswordLock

setPatternLock

setPinLock

setPowerKeyBlocked

setRebootTimeByEveryDay

setRestrictBackground

setScreenOffTimeout

setShowBatteryPercent

setShowTouches

setStatusBarLocked

setStatusbarSettingsButtonVisibility

setSystemOrientation

setTextOnLockScreen

setTouchScreenWakeupValue

setUnknownSources

setUsb

setWifi

setWifiDHCP

setWifiStaticIp

shutdown

stopApp