com.eloview.sdk.systemManager

Class System

java.lang.Object

com.eloview.sdk.consts.Consts

com.eloview.sdk.accountManager.AccountManager

com.eloview.sdk.systemManager.System

All Implemented Interfaces:

java.lang.Cloneable

public class System
extends AccountManager

System class provides below operations.

• Get an auth token using getEloAccessToken.
• Capture the device screenshot using captureScreenShot.
• Set Device orientation in portrait, landscape, reverse-portrait or reverse-landscape using setOrientation.
• Get Device orientation. For e.g. portrait, landscape using getOrientation.
• Factory reset device without any user interaction. It deletes the user data partition using factoryReset.
• Reboot the device silently using silentReboot.
• Enable/Disable NavigationBar in Standard AndroidMode using setNavigationBarEnabled.
• Enable/Disable StatusBar in Standard AndroidMode using setStatusBarEnabled.
• Allow all runtime permissions so application does not pop up permission dialog using setGrantAllAppPermissionEnabled.
• Get property status of NavigationBar using getNavigationBarEnabled.
• Get property status of StatusBar using getStatusBarEnabled.
• Get property status of GrantAllAppPermission using getGrantAllAppPermissionEnabled.
• Set BackLightTimeOut property using setBacklightTimeOut.
• Get property status of BackLightTimeOut using getBacklightTimeOut.
• Set System Password Lock using setLockScreenPassword.
• Change System Password Lock using changeLockScreenPassword.
• Auto grant runtime USB permissions in Android Home Mode using autoallowUSBPermission
• Lock or unlock the secure processor firmware on M60/M60C devices using setFirmwareStatusLockEnabled
• APIs to set/change the device pin using setLockScreenPin and changeLockScreenPin
• A method to toggle the WiFi state using setWifiEnabled and get the current WiFi state using getWifiEnabled
• A method to clear user applications cache and userdata using clearAllAppCacheUserData and clearAppCacheUserData
• APIs to enable ADB using setAdbEnabled, and to set custom ports for ADB using customePortAdb
• Enable/Disable Home button on the device using setHomeButtonEnabled
• Enable/Disable Power button on the device using setPowerButtonEnabled
• Enable/Disable Text Editor assist menu using setTextEditorAssistMenuEnabled
• Enable/Disable the 'show more' options on the volume panel setVolumePanelShowMoreEnabled
• Enable/Disable Zebra Barcode scanner using setBarcodeReaderEnabled
• Perform a scan using zebra Barcode scanner setScanBarcodeReaderEnabled
• Enable/disable Elo Logging feature using setEloLoggingEnabled
• Enable/Disable random WiFi MAC address using setRandomWifiMacAddressEnabled
• Enable/Disable Star Printer access from WebView via JavaScript interface setStarPeripheralConnectEnabled
• check if auto allowing USB permissions is enabled or disabled using getAutoAllowUSBPermission
• Set the device owner using setDeviceOwner, remove the device owner using removeDeviceOwner(java.lang.String) removeDeviceOwner}, and get the device owner status using getDeviceOwnerStatus() getDeviceOwnerStatus}
• Set/get the Display DPI using setDpi and getDpi
• Set and get the current language on the device using setLanguage and getLanguage
• Set and get the type of lock on the device setLockType and getLockType
• Set and get the status of Multi Client IME using setMultiClientImeEnabled and getMultiClientImeEnabled
• Set/get the NTP server URL using setNtpServerUrl and getNtpServerUrl
• Set/get the NTP poll interval using setNtpPollInterval and getNtpPollInterval
• Enable/Disable install permissions to specific apps using setInstallPermissionToSpecificApp or to all apps using setInstallAllAppPermissionEnabled
• Check which apps have install permissions using getInstallPermissionToSpecificApp
• Set/get the display resolution using setScreenSize and getScreenSize
• Set/get the smallest pixel width as shown in developer options setSmallestPixelWidth and getSmallestPixelWidth
• Set/get the Timezone using setTimeZone and getTimeZone
• Enable/Disable accessibility services using setAccessibilityService
• Enable/Disable auto Date and time using setAutoDateTimeEnabled
• Enable/Disable Bluetooth device pairing confirmation dialog for specific devices using setBluetoothDevicePairingConfirmationEnabled
• Set the Date and Time on the device using setDateTime
• Set Display size (Default/Large/Larger/Largest) using setDisplaySize
• Set Wi-Fi network configuration using a CSV file setEloNetworkConf
• Set Font size using setFontSize
• Enable/Disable Idle mode using setIdleModeEnabled
• Set Location of the device using setLocationEnabled
• Mute/Un-mute microphone using setMicrophoneMuteEnabled
• Enable/Disable showing the password while typing it in using setPasswordEnabled
• Enable/Disable Google Playprotect using setPlayProtect
• Set/Get the reserved log space on the device using setReservedLogSpace and getReservedLogSpace
• Set the time format on the device using setTimeFormatEnabled
• Enable/Disable the touch sound on the device using setTouchSoundEnabled
• Set volume level for various volume types such as Alarm, Call, Media, Notification using setVolumeLevel
• Enable/Disable the 'share' option when text is selected on the device using setShowTextEditorShareMenuEnabled
• Shutdown the device using silentShutDown
• Set the default launcher on the device using setSilentDefaultLauncher
• Lock/unlock the secure processor firmware using setFirmwareStatusLockEnabled, get the status using getFirmwareStatusLockEnabled and upgrade the firmware using spFirmwareUpgrade
• show notification and start activity from Foreground service using startActivityFromForegroundService
• Enable/Disable the dark mode on the device using setDarkModeEnabled
• Wake-up the device screen if it is asleep using wakeupScreen
• Enable/Disable the charging sound and vibration on the device using setChargingSoundAndVibrationEnabled
• Enable/Disable the screen locking sound on the device using setScreenLockSoundEnabled
• Enable/Disable the idle mode tile on the device using setIdleModeTileEnabled
• Get the host name of the device using getHostName
• Set the host name of the device using setHostName
• Enable/Disable the hotspot accessibility on the device using setHotspotAccessibilityEnabled
• Get the hotspot accessibility on the device using getHotspotAccessibilityEnabled
• Get the MD5 checksum of a file using getMD5Checksum
• Bind and unBind the Service in order to start using the System APIs using bindService unbindService

Field Summary

Fields

Modifier and Type	Field and Description
static int	ERROR_OTHER
static int	ERROR_SINGLE_APP_MODE
static int	RECEIVE_KEY_EVENT
static int	SUCCESS_CODE

Fields inherited from class com.eloview.sdk.accountManager.AccountManager

ACCESS_TOKEN_INVALID, ACCESS_TOKEN_VALID, API_ACCESS_TOKEN_INVALID, API_ACCESS_TOKEN_VALID, instance, IS_USER_LOGIN_OAUTH, isPolaris, OAUTH_TOKEN_INVALID, OAUTH_TOKEN_VALID, REQUEST_AUTH_LOGIN, REQUEST_AUTH_LOGOUT, SETUP_OAUTH_ERROR, SETUP_OAUTH_SUCCESS, TOKEN_VERIFY_FAIL, TOKEN_VERIFY_SUCCESS

Fields inherited from class com.eloview.sdk.consts.Consts

GENERIC_ERROR, OAUTH_PATH_TOKEN, OAUTH_PATH_VERIFY

Constructor Summary

Constructors

Constructor and Description
System()

Method Summary

Modifier and Type	Method and Description
void	bindService(android.content.Context context, ServiceConnectionCallback callback, java.lang.String accessToken) This method is used to bind the service to access the System APIs.
boolean	captureScreenShot(java.lang.String fileName) This method is used to capture a screenshot.
int	changeLockScreenPassword(android.content.Context context, java.lang.String oldPassword, java.lang.String newPassword, boolean autoUnlock) API used to apply the screen lock Password.
int	changeLockScreenPin(android.content.Context context, java.lang.String oldPin, java.lang.String newPin, boolean autoUnlock) API used to change the screen lock Pin when screen lock pin is already set.
boolean	clearAllAppCacheUserData(java.lang.String packageNames) This method is used to clear cache and userdata of all apps except the ones in the exception list
boolean	clearAppCacheUserData(java.lang.String packageNames) This method is used to clear cache and userdata of the given applications
boolean	copyFile(java.lang.String source, java.lang.String destination) Function used to copy file from source path to destination path.
java.lang.String	enableSecureWhiteListMode() This API will enable BIN whitelisting mode on the payment device.
void	factoryReset(boolean eraseSdcard) This method is used to perform a factory reset on the device.
boolean	getAutoAllowUsbPermissionEnabled() This method is used to get current status of runtime usb permissions in AndroidHomeMode. To reboot device use silentReboot.
boolean	getAutoIdleModeEnabled() This method is used to get the Auto Idle Mode Status.
int	getBacklightTimeOut() This method is used to get the currently set back-light timeout.
int	getBrightness() This method is used to set the Brightness of the device
int	getCFDDpi() This method is used to get the External Display resolution DPI
boolean	getChargingSoundAndVibrationEnabled() This method is used to get the Charging Sound and Vibration Status(Android Settings -> Sound -> Advanced -> Charging sounds and vibration)
java.lang.String	getDeviceOwnerStatus() Function will return current device owner package name when the device owner is set through the SDK.
int	getDpi() This method is used to get the Display resolution DPI
java.lang.String	getExternalScreenOrientation() This method is used to get external Screen Orientation details.
int	getFirmwareStatusLockEnabled() This method is used to get status of secure processor firmware
boolean	getGrantAllAppPermissionEnabled() This method provides property status of setGrantAllAppPermissionEnabled.
java.lang.String	getHostName() This method is used to get the device HostName.
boolean	getHotspotAccessibilityEnabled() This method is used to get the status of Hotspot accessibility
boolean	getInstallPermissionToSpecificApp(java.lang.String sourcePkg) This method provides property status of installSpecificAppPermission.
java.lang.String	getLanguage() This method is used to get the language set on the device.
java.lang.String	getLockType() This method is used to get the lock type Description On clicking Getlock type button the Current Device lock setting will come in output message (Ex.
java.lang.String	getMD5Checksum(java.lang.String absoluteFilePath) This method is used to verify signature of the file.
java.lang.String	getMediaProjectionPermission() This method is used to return the packages allowed for MediaProjectionPermission
boolean	getMediaProjectionPermissionAllApps() This method is used to check if MediaProjectionPermission is automatically allowed for all the apps or not
boolean	getMultiClientImeEnabled() This method is used to get Multi Client IME enable value
boolean	getNavigationBarEnabled() This method provides property status of NavigationBar.
long	getNtpPollInterval() This method is used to get the NTP Poll Interval set on the device.
java.lang.String	getNtpServerUrl() This method is used to get NTP server address
java.lang.String	getOrientation() This method is used to get orientation details for all devices
boolean	getPlayProtect() This method provides property status of PLAYPROTECT.
int	getReservedLogSpace() This method is used to get reserved log space on the device.
boolean	getScreenLockSoundEnabled() This method is used to get the Screen Locking Sound Status
java.lang.String	getScreenSize() This method is used to get the Display resolution
boolean	getSecureWhitelistModeStatus() This API will result "TRUE" if BIN whitelisting is already enabled or will result "FALSE"
boolean	getShowInsetsOnSwipe() Function used to retrieve true/false value for whether status and navigation bars (insets) will be shown when swiping from top or bottom of screen after insets are hidden using native Android API's.
int	getSmallestPixelWidth() This method is used to get the smallest pixel width (as shown in developer options.)
boolean	getStatusBarEnabled() This method provides property status of StatusBar.
boolean	getStickyEloViewModeEnabled() This method is used to get status of sticky EloView boot mode
java.lang.String	getTimeZone() This method is used to get the timezone set on the device.
boolean	getTouchSoundEnabled() This method is used to get the Touch Sound State.
boolean	getWifiEnabled() This method is used to get the current status of Wifi.
static boolean	is7PayDevice() This method is used to get the device orientation.
static boolean	isM100Device() This method is used to get the device orientation.
static boolean	isM50Device() This method is used to get the device orientation.
boolean	isM51Device() This method is used to get the device orientation.
static boolean	isM60Device() This method is used to get the device orientation.
java.lang.String	readSystemProperty(java.lang.String key)
boolean	removeDeviceOwner(java.lang.String packageName) Function will remove the ownership of device owner package Note : This function can only be called by the device owner in order to remove package as device owner.
void	setAccessibilityService(java.lang.String packageName, boolean enableAccessibilityService) This method is used to enable/disable accessibility services
void	setAdbEnabled(boolean enable) This method is used to Enable ADB
boolean	setAdbPort(java.lang.String portNumber) This method is used to Set Custom ADB TCP port
void	setAutoAllowUsbPermissionEnabled(boolean grantPermission) This method is used to grant runtime usb permissions in AndroidHomeMode. After applying changes device requires reboot to reflect the changes. ON 3.0 DEVICES THIS METHOD WILL TOGGLE THE USB PERMISSIONS AND THE VARIABLE 'grantPermission' IS NOT USED. SO FOR EXAMPLE IF AUTOMATICALLY ALLOWING USB PERMISSIONS IS CURRENTLY NOT ENABLED FOR AN APP, CALLING THIS FUNCTION WILL ENABLE IT.
void	setAutoDateTimeEnabled(boolean AutoDateTime) This method is used to enable/disable Setting Automatic Date and Time from the network on the device.
boolean	setBacklightEnabled(boolean enable) This method is used to set the device backlight Turn ON or OFF
boolean	setBacklightTimeOut(int timeout) This method is used to set the backlight timeout.
void	setBarcodeReaderEnabled(boolean enableBCR) This method is used to enable/disable BCR
boolean	setBluetoothDevicePairingConfirmationEnabled(android.bluetooth.BluetoothDevice device, java.lang.Boolean enable) This method is used to enable/disable Pairing notification request for specific bluetooth device.
void	setBluetoothEnabled(boolean bluetoothState) This method is used to Enable/Disable bluetooth
void	setBluetoothScanning(boolean enable) This method is used to enable/disable BluetoothScanning
void	setBrightness(int value) This method is used to set the Brightness of the device
boolean	setCFDDpi(int DPI) This method is used to set the External Display resolution DPI.
void	setChargingSoundAndVibrationEnabled(boolean btnState) This method is used to Enable/Disable Charging sounds and vibration
void	setCopyPasteModeEnabled(boolean copyPasteMode) This method is used to enable/disable Copy Paste functionality of a device
void	setDarkModeEnabled(boolean enable) This method is used to toggle the status of dark theme on the device.
void	setDateTime(long epoch) This method is used to set the date and time on the device.
boolean	setDeviceOwner(java.lang.String packageName, java.lang.String className) Function will set a component as device owner This function is asynchronous.
boolean	setDisplaySize(java.lang.String size) This method is used to set the Display size
boolean	setDpi(int DPI) This method is used to set the Display resolution DPI.
void	setEloLoggingEnabled(boolean enable) This method is used to enable/disable Elo logging functionality.
int	setEloNetworkConf(android.content.Context ctx, android.net.Uri CsvURL) This method is used to set the Network configurations for wifi.
void	setExternalAudioDeviceEnabled(boolean externalSpeakerState) This method is used to select Internal/External Speaker.
boolean	setExternalScreenOrientation(java.lang.String orientation) This method is used to set External Screen Orientation
boolean	setFirmwareStatusLockEnabled(boolean status) This method is used to lock or unlock the secure processor firmware update
boolean	setFontSize(java.lang.String size) This method is used to set the Font size
void	setGrantAllAppPermissionEnabled(boolean grantPermission) This method is used to grant all runtime permissions in AndroidHomeMode to all apps. After applying changes device requires reboot to reflect the changes.
void	setHomeButtonEnabled(boolean enable) This method is used to Enable the Home button.
void	setHostName(java.lang.String hostname) This method is used to Set the Host Name
void	setHotspotAccessibilityEnabled(boolean status) This method is used to Enable Disable Hotspot accessibility
void	setIdleModeEnabled(boolean IdleMode) This method is used to Enable/Disable Auto-Idle mode
int	setIdleModeTileEnabled(boolean enable) This method is used to Enable/Disable idle mode tile.
boolean	setInstallAllAppPermissionEnabled(boolean grantPermission) This method is used to grant install permission to all app source package.
boolean	setInstallPermissionToSpecificApp(java.lang.String sourcePackage, boolean state) This method is used to grant install permission to specific app source package.
boolean	setKeyListener(java.lang.String packageName, java.lang.String receiverName, java.util.ArrayList<java.lang.Integer> keys, java.util.ArrayList<java.lang.Boolean> intercept) This method is used to register a key event listener that will be able to work in a background thread.
boolean	setLanguage(java.lang.String locale) This method is used to set the language on the device.
boolean	setLocationEnabled(boolean enable) This method is used to set the Volume Control
int	setLockScreenPassword(android.content.Context context, java.lang.String newPassword, boolean autoUnlock) API used to apply the screen lock Password for the First Time only.
int	setLockScreenPin(android.content.Context context, java.lang.String newPin, boolean autoUnlock) API used to apply the screen lock Pin for the First Time only.
void	setLockStatusBarEnabled(boolean status) This method is used to Enable / Disable Status Bar Swipe Lock
int	setLockType(java.lang.String pass, java.lang.String type) This method is used to set the lock type On Clicking Set locktype Button if current device lock setting is password or pin the dialog box will come to enter older password/pin to override with swipe or none.
void	setMediaProjectionPermission(java.lang.String pkgName) This method is used to allow a specific package to have MediaProjectionPermission
void	setMediaProjectionPermissionAllApps(boolean allowAutoPermit) This method is used to enable/disable to auto allow the MediaProjectionPermission for all the apps
void	setMicrophoneMuteEnabled(boolean state) This method is used to mute/unmute microphone
boolean	setMultiAppModeEnabled(android.content.Context context, boolean status) This method is used to change app mode (Enable - multi app mode, Disable - single app mode)
boolean	setMultiClientImeEnabled(boolean enable, boolean reboot) This method is used to enable/disable Multi-Client IME After applying, device will reboot to reflect the changes.
void	setNavigationBarEnabled(boolean enableNavigationBar) This method is used to enable/disable NavigationBar in AndroidHomeMode (not supported in EloView modes). By default the navigation bar is enabled After applying changes device requires reboot to reflect the changes.
void	setNotificationStatusEnabled(boolean status) This method is used to enable/disable Notification with statusbar
boolean	setNtpPollInterval(long interval, java.lang.Boolean rebootRequired) This method is used to set NTP Client Polling Interval for the device.
void	setNtpServerUrl(java.lang.String ntpUrl, boolean rebootRequired) This method is used to set NTP server address.
void	setOrientation(java.lang.String orientation) This method is used to set orientation of any device
boolean	setOrientation(java.lang.String orientation, boolean noRebootReq) This method is used to set display orientation for LIDS 2.0/BACKPACK devices only
void	setOrientation(java.lang.String orientation, boolean noRebootReq, boolean rotateISeriesorHandheld) This method is used to set orientation of any device
void	setPasswordEnabled(boolean state) This method is used to enable/disable show password
void	setPeripheralConnectEnabled(boolean value) This method is used to enable/disable Hardware/System access from WebView via JavaScript Interface.
void	setPlayProtect(boolean enablePlayProtect) This method is used to enable/disable PLAYPROTECT. Google Play Protect checks your apps and devices for harmful behavior and is only available on GMS enabled devices.
void	setPowerButtonEnabled(boolean enable) This method is used to Enable/Disable the Power button.
void	setRandomWifiMacAddressEnabled(boolean mac) This method is enable/disable Random WiFi MAC address
void	setRecentButtonEnabled(boolean enable) This method is used to Enable Recent Button
void	setReservedLogSpace(int logSpace) This method is used to set the size of the reserved log space.
void	setScanBarcodeReaderEnabled(boolean scanBCR) This method is used to start/stop scan Barcode
void	setScreenLockSoundEnabled(boolean btnState) This method is used to Enable/Disable Screen Lock Sound
boolean	setScreenSize(int width, int height) This method is used to set the Display resolution
void	setScreenWakeUp(long delay) This method is used to wake up the screen if it's asleep.
void	setShowInsetsOnSwipe(boolean show) Function used to hide/show status and navigation bars (insets) when swiping from top or bottom of screen after insets are hidden using native Android API's.
void	setShowTapsEnabled(boolean showTapsState) This method is used to Enable/Disable Show Taps
void	setShowTextEditorShareMenuEnabled(boolean value) This method is used to enable/disable showing menu option on text selection in AndroidHomeMode.
boolean	setSilentDefaultLauncher(java.lang.String packageName) This method is used to silently set the default launcher application
boolean	setSmallestPixelWidth(int smallestWidth) This method is used to set the smallest pixel width (as shown in developer options.
void	setStarPeripheralConnectEnabled(boolean value) This method is used to enable/disable Star hardware access from WebView via JavaScript Interface.
boolean	setStatusBarEnabled(boolean enableStatusBar) This method is used to enable/disable StatusBar in AndroidHomeMode or EloView Connect mode.. After applying changes device requires reboot to reflect the changes.
boolean	setStatusBarVisibilityEnabled(boolean visible) This method is for Android 10.
void	setStickyEloViewModeEnabled(boolean stickyMode) This method is used to set sticky EloView boot mode
void	setTextEditorAssistMenuEnabled(boolean enable) This method is used to enable/disable the Assist Menu in Text Editor
void	setTimeFormatEnabled(boolean TimeFormat_24) This method is used to set time format
boolean	setTimeZone(java.lang.String timezone) This method is used to set the timezone on the device.
boolean	setTouchSoundEnabled(boolean touchSound) This method is used to set the Touch Sound
void	setUSBPorts(java.lang.String json)
void	setVirtualKeyBoard(java.lang.String virtualKeyboard) This method is used to set the virtual keyboard on the device.
boolean	setVolumeLevel(java.lang.String volumeType, int value) This method is used to set the volume for "Alarm", "Call", "Media", "Notification" or "All"
void	setVolumePanelShowMoreEnabled(boolean enable) This method is used to enable show more option in volume panel.
void	setWifiEnabled(boolean wifiState) This method is used to change Wifi state.
void	setWifiScanning(boolean enable) This method is used to enable/disable wifiscanning
void	silentReboot() This method is used to reboot the device.
void	silentShutDown(int delay) This method is used to shutdown the device
boolean	spFirmwareUpgrade() This method is used to upgrade the firmware of the secure processor on M60 payment devices First add QE1000_new.uld (firmware file) needs to be stored at /sdcard/Download/ folder
void	startActivityFromForegroundService(android.content.Context context, android.content.Intent activityIntent, android.app.Service foregroundService) API used to create, show a notification and start an activity from a foreground service.
void	testPeripheralMode() Function used to launch test peripheral mode.
void	unbindService(android.content.Context context) This method is used to unbind the service.
java.lang.String	verifyFileSignature(byte[] zipFileByteArray) This method is used to Verify File Integrity from zip file bytes.
java.lang.String	verifyFileSignature(java.lang.String absoluteFilePath, java.lang.String absoluteSha256Path) This method is used to verify signature of the file.
boolean	wakeupScreen() This method is used to wake up the screen if it's asleep.
boolean	writeFile(java.lang.String destination, java.lang.String data, boolean readable, boolean append, boolean overwrite) Function used to create file at a destination path with given data.
java.lang.String	writeSignedFileToStorage(byte[] zipFileByteArray) This API will verify the zip file bytes and copy the file to the /data/CastlesFile/protected folder.
void	writeSystemProperty(java.lang.String key, java.lang.String value)

Methods inherited from class com.eloview.sdk.accountManager.AccountManager

configureOAuthHostedUI, destroyOAuth, getBaseUri, getClientId, getEloAccessToken, getEloOAuthToken, getEnvironment, getProperty, isPolaris, isPolarisLocked, logoutOAuth, onOAuthActivityResult, selectEnvironment, setDefaultEnvironment, setProperty, stopOAuth, unregisterAccountManagerListener, verifyEloToken

Methods inherited from class com.eloview.sdk.consts.Consts

clone, getEloIntentWithFlag, getMigrate, isDevice7Inch, isDeviceM100

Methods inherited from class java.lang.Object

equals, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Field Detail

RECEIVE_KEY_EVENT

public static final int RECEIVE_KEY_EVENT

See Also:

Constant Field Values

SUCCESS_CODE

public static final int SUCCESS_CODE

See Also:

Constant Field Values

ERROR_SINGLE_APP_MODE

public static final int ERROR_SINGLE_APP_MODE

See Also:

Constant Field Values

ERROR_OTHER

public static final int ERROR_OTHER

See Also:

Constant Field Values

Constructor Detail

System

public System()

Method Detail

isM60Device

public static boolean isM60Device()

This method is used to get the device orientation.

Returns:

Device orientation. For e.g. portrait, landscape

isM50Device

public static boolean isM50Device()

This method is used to get the device orientation.

Returns:

Device orientation. For e.g. portrait, landscape

isM100Device

public static boolean isM100Device()

This method is used to get the device orientation.

Returns:

Device orientation. For e.g. portrait, landscape

is7PayDevice

public static boolean is7PayDevice()

This method is used to get the device orientation.

Returns:

Device orientation. For e.g. portrait, landscape

isM51Device

public boolean isM51Device()

This method is used to get the device orientation.

Returns:

Device orientation. For e.g. portrait, landscape

bindService

public void bindService(android.content.Context context,
                        ServiceConnectionCallback callback,
                        java.lang.String accessToken)

This method is used to bind the service to access the System APIs. Use this method to bind to the service before using the System APIs.

Parameters:

context - Context of the application

callback - Callback to get the status of the service connection

accessToken - Access token to verify the service connection

unbindService

public void unbindService(android.content.Context context)

This method is used to unbind the service. Use this method to unbind from the service when clearing resources.

Parameters:

context - Context of the application

captureScreenShot

public boolean captureScreenShot(java.lang.String fileName)

This method is used to capture a screenshot. The screenshot will be store in location "/sdcard/elo/screenshot" and the return message also contains the path of the screenshot location.

Parameters:

fileName - A filename in png format. Eg. "screenshot.png"

Returns:

true if the screenshot is captured successfully, false otherwise.

setAccessibilityService

public void setAccessibilityService(java.lang.String packageName,
                                    boolean enableAccessibilityService)

This method is used to enable/disable accessibility services

setMultiClientImeEnabled

public boolean setMultiClientImeEnabled(boolean enable,
                                        boolean reboot)

This method is used to enable/disable Multi-Client IME After applying, device will reboot to reflect the changes.

Parameters:

enable - whether to enable or disable

reboot - Set this to 'true' to immediately reboot the device after enabling/disabling multi-client IME. Set this to 'false' to prevent the device from rebooting. If set to 'false' the user needs to take care of rebooting the device at a later time for this setting to take effect.

setWifiScanning

public void setWifiScanning(boolean enable)

This method is used to enable/disable wifiscanning

Parameters:

enable - whether to enable or disable

setBluetoothScanning

public void setBluetoothScanning(boolean enable)

This method is used to enable/disable BluetoothScanning

Parameters:

enable - whether to enable or disable

setKeyListener

public boolean setKeyListener(java.lang.String packageName,
                              java.lang.String receiverName,
                              java.util.ArrayList<java.lang.Integer> keys,
                              java.util.ArrayList<java.lang.Boolean> intercept)

This method is used to register a key event listener that will be able to work in a background thread.

Parameters:

packageName - Name of package the key listener component belongs to

receiverName - Class Name of the key listener component (use class.getName())

keys - Array list of keycode integers. Use KeyEvent.KEYCODE_*

intercept - true iff the system should only send the KeyEvent to the listener, and not to the user

getMultiClientImeEnabled

public boolean getMultiClientImeEnabled()

This method is used to get Multi Client IME enable value

setDpi

public boolean setDpi(int DPI)

This method is used to set the Display resolution DPI. Requires a reboot to take affect.

Parameters:

DPI - Integer value to set the screen density in DPI (160, 240, 320, 480 or 640).

setCFDDpi

public boolean setCFDDpi(int DPI)

This method is used to set the External Display resolution DPI.

Parameters:

DPI - Integer value to set the screen density in DPI (160, 240, 320, 480 or 640).

setScreenSize

public boolean setScreenSize(int width,
                             int height)

This method is used to set the Display resolution

Parameters:

width - Integer value to set the screen resolution width

height - Integer value to set the screen resolution height

setDisplaySize

public boolean setDisplaySize(java.lang.String size)

This method is used to set the Display size

Parameters:

size - string value to set the screen display size =

setFontSize

public boolean setFontSize(java.lang.String size)

This method is used to set the Font size

Parameters:

size - string value to set the Font size

setSmallestPixelWidth

public boolean setSmallestPixelWidth(int smallestWidth)

This method is used to set the smallest pixel width (as shown in developer options. The DPI will change when the smallest pixel width is modified)

Parameters:

smallestWidth - int value to set the screen smallest pixel width

getSmallestPixelWidth

public int getSmallestPixelWidth()

This method is used to get the smallest pixel width (as shown in developer options.)

setSilentDefaultLauncher

public boolean setSilentDefaultLauncher(java.lang.String packageName)

This method is used to silently set the default launcher application

Parameters:

packageName - String containing package names of the app to set as launcher.
The packageName should be that of a launcher application.

Returns:

true if the default launcher is set successfully, false otherwise.

clearAppCacheUserData

public boolean clearAppCacheUserData(java.lang.String packageNames)

This method is used to clear cache and userdata of the given applications

Parameters:

packageNames - String containing package names of the apps to clear cache and userdata

Returns:

true if the cache and userdata is cleared successfully, false otherwise.

clearAllAppCacheUserData

public boolean clearAllAppCacheUserData(java.lang.String packageNames)

This method is used to clear cache and userdata of all apps except the ones in the exception list

Parameters:

packageNames - String containing package names of the apps to be excepted from clearing cache and userdata

Returns:

true if the cache and userdata is cleared successfully, false otherwise.

setRandomWifiMacAddressEnabled

public void setRandomWifiMacAddressEnabled(boolean mac)

This method is enable/disable Random WiFi MAC address

Parameters:

mac - boolean. true for randomized MAC and false for a fixed MAC address.

setIdleModeEnabled

public void setIdleModeEnabled(boolean IdleMode)

This method is used to Enable/Disable Auto-Idle mode

Parameters:

IdleMode - Boolean value to set the idle mode enable/disable. By default auto-idle mode is enabled.

setIdleModeTileEnabled

public int setIdleModeTileEnabled(boolean enable)

This method is used to Enable/Disable idle mode tile. Only works in android home mode, GMS mode, and eloview connect mode.

Parameters:

enable - boolean value to set the idle mode tile. By default idle mode tile is enabled.

Returns:

IdleModeTileStatus int value {0, 1 & -1} 0 indicates a successful operation, 1 a failure and -1 when it's not supported

setNtpServerUrl

public void setNtpServerUrl(java.lang.String ntpUrl,
                            boolean rebootRequired)

This method is used to set NTP server address. A reboot is required for this to take effect.

Parameters:

ntpUrl - NTP server address

rebootRequired - If this is set to true device will reboot immediately. If set to false device will not reboot immediately but device needs to be rebooted for the change to take effect using the silentReboot API.

getNtpServerUrl

public java.lang.String getNtpServerUrl()

This method is used to get NTP server address

Returns:

NTP server address

setPasswordEnabled

public void setPasswordEnabled(boolean state)

This method is used to enable/disable show password

Parameters:

state - true to enable show password, false to disable show password

setMicrophoneMuteEnabled

public void setMicrophoneMuteEnabled(boolean state)

This method is used to mute/unmute microphone

Parameters:

state - true to enable microphone, false to disable microphone

setLockType

public int setLockType(java.lang.String pass,
                       java.lang.String type)

This method is used to set the lock type On Clicking Set locktype Button if current device lock setting is password or pin the dialog box will come to enter older password/pin to override with swipe or none. Get Locktype must be call before this method to override with new lock settings. If current Device lock setting is Swipe or None it will override directly without dialog box.

Parameters:

type - string value to set lock type

Returns:

0 if success, -1 if unknown error, -2 if incorrect pin provided, -3 if incorrect password provided, -4 if system service is not connected

getLockType

public java.lang.String getLockType()

This method is used to get the lock type Description On clicking Getlock type button the Current Device lock setting will come in output message (Ex. Password,Pin,Swipe,None,or Pattern). It is mandatory step to override with new lock setting.

Returns:

lock type

getHostName

public java.lang.String getHostName()

This method is used to get the device HostName.

Returns:

HostName

setHostName

public void setHostName(java.lang.String hostname)

This method is used to Set the Host Name

Parameters:

hostname - The chosen port number

getChargingSoundAndVibrationEnabled

public boolean getChargingSoundAndVibrationEnabled()

This method is used to get the Charging Sound and Vibration Status(Android Settings -> Sound -> Advanced -> Charging sounds and vibration)

Returns:

Charging Sound and Vibration Status

setChargingSoundAndVibrationEnabled

public void setChargingSoundAndVibrationEnabled(boolean btnState)

This method is used to Enable/Disable Charging sounds and vibration

Parameters:

btnState - "Enable" to Enable Charging Sound and Vibration and "Disable" to Disable Charging Sound and Vibration

getScreenLockSoundEnabled

public boolean getScreenLockSoundEnabled()

This method is used to get the Screen Locking Sound Status

Returns:

Screen Locking Sound Status

setScreenLockSoundEnabled

public void setScreenLockSoundEnabled(boolean btnState)

This method is used to Enable/Disable Screen Lock Sound

Parameters:

btnState - "Enable" to Enable Screen Lock Sound and "Disable" to Disable Screen Lock Sound

getAutoIdleModeEnabled

public boolean getAutoIdleModeEnabled()

This method is used to get the Auto Idle Mode Status.

Returns:

Auto Idle Mode Status

getTouchSoundEnabled

public boolean getTouchSoundEnabled()

This method is used to get the Touch Sound State.

Returns:

Touch Sound State

setTouchSoundEnabled

public boolean setTouchSoundEnabled(boolean touchSound)

This method is used to set the Touch Sound

Parameters:

touchSound - Boolean value to enable/disable touch sound

Returns:

true if the operation is successful, false otherwise

setLocationEnabled

public boolean setLocationEnabled(boolean enable)

This method is used to set the Volume Control

Parameters:

enable - Boolean value to enable/disable location services

Returns:

true if the operation is successful, false otherwise

getDpi

public int getDpi()

This method is used to get the Display resolution DPI

Returns:

DPI

getCFDDpi

public int getCFDDpi()

This method is used to get the External Display resolution DPI

Returns:

DPI

getScreenSize

public java.lang.String getScreenSize()

This method is used to get the Display resolution

Returns:

Display resolution

silentShutDown

public void silentShutDown(int delay)

This method is used to shutdown the device

Parameters:

delay - A delay in seconds before shutting down the device

getReservedLogSpace

public int getReservedLogSpace()

This method is used to get reserved log space on the device. Only available for builds l1-lava or newer. Won't work on 4.46.70.

Returns:

reserved log space in MegaBytes

setReservedLogSpace

public void setReservedLogSpace(int logSpace)

This method is used to set the size of the reserved log space. Only available for builds l1-lava or newer for 3.0 devices. Won't work on 4.46.70. This API is supported on 4.0 devices. Please refer to the SDK test app for proper utilization of this API.

Parameters:

logSpace - log space to be reserved can be the following values: "144","256","512","756","1024","2048"

setOrientation

public void setOrientation(java.lang.String orientation,
                           boolean noRebootReq,
                           boolean rotateISeriesorHandheld)

This method is used to set orientation of any device

Parameters:

orientation - value should be "-1", "0", "90", "180" or "270"

noRebootReq - If device should reboot after orientation is set

rotateISeriesorHandheld - Indicates whether should rotate I-series or handheld device

getOrientation

public java.lang.String getOrientation()

This method is used to get orientation details for all devices

Returns:

orientation details

setOrientation

public void setOrientation(java.lang.String orientation)

This method is used to set orientation of any device

Parameters:

orientation - value should be "-1", "0", "90", "180" or "270"

factoryReset

public void factoryReset(boolean eraseSdcard)

This method is used to perform a factory reset on the device. It will erase all the internal storage records and restart the device.

Parameters:

eraseSdcard - boolean true to erase SDCard data too. false for not erasing SDCard data.

silentReboot

public void silentReboot()

This method is used to reboot the device.

setOrientation

public boolean setOrientation(java.lang.String orientation,
                              boolean noRebootReq)

This method is used to set display orientation for LIDS 2.0/BACKPACK devices only

Parameters:

orientation - value should be "0", "90", "180", or "270"

noRebootReq - If device should reboot after orientation is set

Returns:

boolean true on successful setOrientation , false on fail

setBarcodeReaderEnabled

public void setBarcodeReaderEnabled(boolean enableBCR)

This method is used to enable/disable BCR

Parameters:

enableBCR - boolean (true/false)

setScanBarcodeReaderEnabled

public void setScanBarcodeReaderEnabled(boolean scanBCR)

This method is used to start/stop scan Barcode

Parameters:

scanBCR - boolean (true/false)

getWifiEnabled

public boolean getWifiEnabled()

This method is used to get the current status of Wifi. This function will return true if Wifi is enabled.
And false if Wifi is disabled. This method can be accessed without an access token

Returns:

boolean True if Wifi is enabled and false if Wifi is disabled.

setWifiEnabled

public void setWifiEnabled(boolean wifiState)

This method is used to change Wifi state.

Parameters:

wifiState - String (true/false). True to enable wifi and false to disable wifi.

setStatusBarEnabled

public boolean setStatusBarEnabled(boolean enableStatusBar)

This method is used to enable/disable StatusBar in AndroidHomeMode or EloView Connect mode..
After applying changes device requires reboot to reflect the changes.
To reboot device use silentReboot.

Parameters:

enableStatusBar - boolean (true/false).

Returns:

true if the operation is successful, false otherwise

setBluetoothDevicePairingConfirmationEnabled

public boolean setBluetoothDevicePairingConfirmationEnabled(android.bluetooth.BluetoothDevice device,
                                                            java.lang.Boolean enable)

This method is used to enable/disable Pairing notification request for specific bluetooth device.

Parameters:

device - BluetoothDevice

enable - boolean (true/false) true to enable pairing notification request and false to disable pairing notification request.

Returns:

true if the operation is successful, false otherwise

setStatusBarVisibilityEnabled

public boolean setStatusBarVisibilityEnabled(boolean visible)

This method is for Android 10. It is used to enable/disable StatusBar and make it Invisible in Android HOme mode or EloView connect mode.
After applying changes device requires reboot to reflect the changes.
To reboot device use silentReboot.

Parameters:

visible - boolean (true/false)

Returns:

true if the operation is successful, false otherwise

getAutoAllowUsbPermissionEnabled

public boolean getAutoAllowUsbPermissionEnabled()

This method is used to get current status of runtime usb permissions in AndroidHomeMode.
To reboot device use silentReboot.

Returns:

true if auto allow usb permissions is enabled, false otherwise

setAutoAllowUsbPermissionEnabled

public void setAutoAllowUsbPermissionEnabled(boolean grantPermission)

This method is used to grant runtime usb permissions in AndroidHomeMode.
After applying changes device requires reboot to reflect the changes.
ON 3.0 DEVICES THIS METHOD WILL TOGGLE THE USB PERMISSIONS AND THE VARIABLE 'grantPermission' IS NOT USED.
SO FOR EXAMPLE IF AUTOMATICALLY ALLOWING USB PERMISSIONS IS CURRENTLY NOT ENABLED FOR AN APP, CALLING
THIS FUNCTION WILL ENABLE IT. AND IF AUTO ALLOWING USB PERMISSIONS IS CURRENTLY ENABLED, THEN CALLING
THIS FUNCTION WILL DISBALE IT

To reboot device use silentReboot.

Parameters:

grantPermission - boolean (true/false)

getNavigationBarEnabled

public boolean getNavigationBarEnabled()

This method provides property status of NavigationBar.

Returns:

true if NavigationBar is enabled, false otherwise

setNavigationBarEnabled

public void setNavigationBarEnabled(boolean enableNavigationBar)

This method is used to enable/disable NavigationBar in AndroidHomeMode (not supported in EloView modes).
By default the navigation bar is enabled After applying changes device requires reboot to reflect the changes.
To reboot device use silentReboot.

Parameters:

enableNavigationBar - boolean (true/false). Default value is true.

getPlayProtect

public boolean getPlayProtect()

This method provides property status of PLAYPROTECT.

Returns:

true if PLAYPROTECT is enabled, false otherwise

setPlayProtect

public void setPlayProtect(boolean enablePlayProtect)

This method is used to enable/disable PLAYPROTECT.
Google Play Protect checks your apps and devices for harmful behavior and is only available on GMS enabled devices. After applying changes device requires reboot to reflect the changes.
To reboot device use silentReboot.

Parameters:

enablePlayProtect - boolean (true/false)

getStatusBarEnabled

public boolean getStatusBarEnabled()

This method provides property status of StatusBar.

Returns:

true if StatusBar is enabled, false otherwise

getGrantAllAppPermissionEnabled

public boolean getGrantAllAppPermissionEnabled()

This method provides property status of setGrantAllAppPermissionEnabled.

Returns:

true if setGrantAllAppPermissionEnabled is enabled, false otherwise

setGrantAllAppPermissionEnabled

public void setGrantAllAppPermissionEnabled(boolean grantPermission)

This method is used to grant all runtime permissions in AndroidHomeMode to all apps.
After applying changes device requires reboot to reflect the changes.
To reboot device use silentReboot.

Parameters:

grantPermission - boolean (true/false)

setInstallAllAppPermissionEnabled

public boolean setInstallAllAppPermissionEnabled(boolean grantPermission)

This method is used to grant install permission to all app source package.

Parameters:

grantPermission - boolean (true/false)

Returns:

true if the operation is successful, false otherwise

setInstallPermissionToSpecificApp

public boolean setInstallPermissionToSpecificApp(java.lang.String sourcePackage,
                                                 boolean state)

This method is used to grant install permission to specific app source package.

Parameters:

sourcePackage - String package name of the app to grant install permission

state - boolean (true/false) true to enable install permission and false to disable install permission.

Returns:

true if the operation is successful, false otherwise

getInstallPermissionToSpecificApp

public boolean getInstallPermissionToSpecificApp(java.lang.String sourcePkg)

This method provides property status of installSpecificAppPermission.

Parameters:

sourcePkg - String package name of the app to check install permission

Returns:

true if installSpecificAppPermission is enabled, false otherwise

setShowTextEditorShareMenuEnabled

public void setShowTextEditorShareMenuEnabled(boolean value)

This method is used to enable/disable showing menu option on text selection in AndroidHomeMode.

Parameters:

value - boolean true/false. This by default set to true in Android home mode and false in EloView mode.

setPeripheralConnectEnabled

public void setPeripheralConnectEnabled(boolean value)

This method is used to enable/disable Hardware/System access from WebView via JavaScript Interface.

Parameters:

value - String true/false

setStarPeripheralConnectEnabled

public void setStarPeripheralConnectEnabled(boolean value)

This method is used to enable/disable Star hardware access from WebView via JavaScript Interface.

Parameters:

value - boolean true/false

setDeviceOwner

public boolean setDeviceOwner(java.lang.String packageName,
                              java.lang.String className)
                       throws java.lang.NullPointerException

Function will set a component as device owner
This function is asynchronous. handler will be called for return data.
Please note that use of this API may interfere with EloView and standard device functionality.

Parameters:

packageName - device owner package name

className - canonical class name of class which extending device admin receiver

Returns:

true if the operation is successful, false otherwise

Throws:

java.lang.NullPointerException - if NonNull parameters are empty or null

getDeviceOwnerStatus

public java.lang.String getDeviceOwnerStatus()

Function will return current device owner package name when the device owner is set through the SDK.

Returns:

device owner package name

removeDeviceOwner

public boolean removeDeviceOwner(java.lang.String packageName)
                          throws java.lang.SecurityException

Function will remove the ownership of device owner package Note : This function can only be called by the device owner in order to remove package as device owner.

Parameters:

packageName - device owner package name

Throws:

java.lang.SecurityException - if the caller does not own the current device owner component.

setScreenWakeUp

public void setScreenWakeUp(long delay)

This method is used to wake up the screen if it's asleep. This API can be used to wakeup the screen after a particular
delay. So for example you can set your device to sleep after a particular amount of idle time using setBackLightTimeout
and set a wakeup time again using this API.

Parameters:

delay - This parameter is a long integer value describing the number of milliseconds after which to wake up the screen. For e.g. 15 seconds = 15*1000. and 30 minute = 30*60*1000 and 8 hours = 8*60*60*1000.

wakeupScreen

public boolean wakeupScreen()

This method is used to wake up the screen if it's asleep.

Returns:

true if successful, false otherwise

setBacklightEnabled

public boolean setBacklightEnabled(boolean enable)

This method is used to set the device backlight Turn ON or OFF

Parameters:

enable - boolean (true/false) true to enable backlight and false to disable backlight.

Returns:

true if the operation is successful, false otherwise

setBacklightTimeOut

public boolean setBacklightTimeOut(int timeout)

This method is used to set the backlight timeout. Timeout can be from 1 second to 30 minutes, or Never. These features are currently geared towards 1.0 i-Series units only.

Parameters:

timeout - This parameter is an integer value describing the number of milliseconds till timeout. Use a value of 0 is for "never" setting the backlight off. For e.g. 15 seconds = 15*1000. and 30 minute = 30*60*1000.

Returns:

true if the operation is successful, false otherwise

getBacklightTimeOut

public int getBacklightTimeOut()

This method is used to get the currently set back-light timeout.

Returns:

int value of the currently set backlight timeout in milliseconds.

setTimeZone

public boolean setTimeZone(java.lang.String timezone)

This method is used to set the timezone on the device.

Parameters:

timezone - A Standard TimeZone ID. You can get available TimeZone IDs using android.icu.util.TimeZone.getAvailableIDs()

Returns:

true if the operation is successful, false otherwise

getTimeZone

public java.lang.String getTimeZone()

This method is used to get the timezone set on the device.

Returns:

String value of the currently set timezone.

getLanguage

public java.lang.String getLanguage()

This method is used to get the language set on the device.

Returns:

String value of the currently set language.

setLanguage

public boolean setLanguage(java.lang.String locale)

This method is used to set the language on the device.

Parameters:

locale - A Standard language code.

setDateTime

public void setDateTime(long epoch)

This method is used to set the date and time on the device.

Parameters:

epoch - Input date and time in epoch time. An epoch is the number of milliseconds since January 1, 1970. Refer to the test application code to see how to get the epoch time.

setNtpPollInterval

public boolean setNtpPollInterval(long interval,
                                  java.lang.Boolean rebootRequired)

This method is used to set NTP Client Polling Interval for the device.

Parameters:

interval - Interval to poll in milliseconds. The minimum interval is 15 minutes (900000 ms)

rebootRequired - true if reboot is required, false otherwise

Returns:

true if the operation is successful, false otherwise

getNtpPollInterval

public long getNtpPollInterval()

This method is used to get the NTP Poll Interval set on the device.

Returns:

int value of the currently set NTP Poll Interval.

setAutoDateTimeEnabled

public void setAutoDateTimeEnabled(boolean AutoDateTime)

This method is used to enable/disable Setting Automatic Date and Time from the network on the device.

Parameters:

AutoDateTime - true for enabling automatic date/time and false for disabling automatic date/time.

setTimeFormatEnabled

public void setTimeFormatEnabled(boolean TimeFormat_24)

This method is used to set time format

Parameters:

TimeFormat_24 - Input true/false to enable/disable to set 24/12 hour format

setEloNetworkConf

public int setEloNetworkConf(android.content.Context ctx,
                             android.net.Uri CsvURL)

This method is used to set the Network configurations for wifi.

Parameters:

ctx - A context object of the calling Class (Activity/Service).

CsvURL - Csv file input where user has set the required network configurations for connection

Returns:

0 for Success, -1 for failure to parse file, -2 for incorrect file format

setPowerButtonEnabled

public void setPowerButtonEnabled(boolean enable)

This method is used to Enable/Disable the Power button.

setHomeButtonEnabled

public void setHomeButtonEnabled(boolean enable)

This method is used to Enable the Home button.

setVolumePanelShowMoreEnabled

public void setVolumePanelShowMoreEnabled(boolean enable)

This method is used to enable show more option in volume panel.

setTextEditorAssistMenuEnabled

public void setTextEditorAssistMenuEnabled(boolean enable)

This method is used to enable/disable the Assist Menu in Text Editor

setLockScreenPassword

public int setLockScreenPassword(android.content.Context context,
                                 java.lang.String newPassword,
                                 boolean autoUnlock)

API used to apply the screen lock Password for the First Time only.

Parameters:

context - Context

newPassword - new password/PIN to be set

autoUnlock - true: On reboot device will auto unlock passcode screen
false: On reboot device will show passcode screen

Returns:

true if the operation is successful, false otherwise

setLockScreenPin

public int setLockScreenPin(android.content.Context context,
                            java.lang.String newPin,
                            boolean autoUnlock)

API used to apply the screen lock Pin for the First Time only.

Parameters:

context - Context

newPin - new PIN to be set

autoUnlock - true: On reboot device will auto unlock Pin screen
false: On reboot device will show pin screen

Returns:

true if the operation is successful, false otherwise

changeLockScreenPassword

public int changeLockScreenPassword(android.content.Context context,
                                    java.lang.String oldPassword,
                                    java.lang.String newPassword,
                                    boolean autoUnlock)

API used to apply the screen lock Password.

Parameters:

context - Context

oldPassword - old password/PIN already set

newPassword - new password/PIN to be set

autoUnlock - true: On reboot device will auto unlock passcode screen
false: On reboot device will show passcode screen

Returns:

true if the operation is successful, false otherwise

changeLockScreenPin

public int changeLockScreenPin(android.content.Context context,
                               java.lang.String oldPin,
                               java.lang.String newPin,
                               boolean autoUnlock)

API used to change the screen lock Pin when screen lock pin is already set.

Parameters:

context - Context

oldPin - The pin currently set on the device

newPin - new PIN to be set

autoUnlock - true: On reboot device will auto unlock Pin screen
false: On reboot device will show pin screen

startActivityFromForegroundService

public void startActivityFromForegroundService(android.content.Context context,
                                               android.content.Intent activityIntent,
                                               android.app.Service foregroundService)

API used to create, show a notification and start an activity from a foreground service. This method must be called from a foreground service. Notification is created with default text "ELo SDK Foreground service notification".

Parameters:

context - Context

activityIntent - an intent created with the name of the activity to launch

foregroundService - An instance of the foreground service class from which this method is called

setVolumeLevel

public boolean setVolumeLevel(java.lang.String volumeType,
                              int value)

This method is used to set the volume for "Alarm", "Call", "Media", "Notification" or "All"

Parameters:

volumeType - volume type ("Alarm", "Call", "Media", "Notification" or "All")

value - int value (0-100)

Returns:

true if the operation is successful, false otherwise

setCopyPasteModeEnabled

public void setCopyPasteModeEnabled(boolean copyPasteMode)

This method is used to enable/disable Copy Paste functionality of a device

Parameters:

copyPasteMode - : boolean (true/false) to enable or disable copy paste functionality

setMediaProjectionPermissionAllApps

public void setMediaProjectionPermissionAllApps(boolean allowAutoPermit)

This method is used to enable/disable to auto allow the MediaProjectionPermission for all the apps

Parameters:

allowAutoPermit - : boolean (true/false) to enable or disable MediaProjectionPermission

getMediaProjectionPermissionAllApps

public boolean getMediaProjectionPermissionAllApps()

This method is used to check if MediaProjectionPermission is automatically allowed for all the apps or not

Returns:

boolean : true/false true: MediaProjectionPermission is allowed for all apps, false: not allowed

setMediaProjectionPermission

public void setMediaProjectionPermission(java.lang.String pkgName)

This method is used to allow a specific package to have MediaProjectionPermission

Parameters:

pkgName - : the name of the package that needs permission

getMediaProjectionPermission

public java.lang.String getMediaProjectionPermission()

This method is used to return the packages allowed for MediaProjectionPermission

Returns:

String : a comma separated string listing all the packages allowed for MediaProjectionPermission

setVirtualKeyBoard

public void setVirtualKeyBoard(java.lang.String virtualKeyboard)

This method is used to set the virtual keyboard on the device.

Parameters:

virtualKeyboard - A virtual keyboard component name.

setEloLoggingEnabled

public void setEloLoggingEnabled(boolean enable)

This method is used to enable/disable Elo logging functionality.

Parameters:

enable - Set to true to enable logging and to false to disable logging.

setAdbPort

public boolean setAdbPort(java.lang.String portNumber)

This method is used to Set Custom ADB TCP port

Parameters:

portNumber - The chosen port number. Port numbers should be odd numbers in the range of 5555 to 5585.

Returns:

true if the operation is successful, false otherwise

setAdbEnabled

public void setAdbEnabled(boolean enable)

This method is used to Enable ADB

setDarkModeEnabled

public void setDarkModeEnabled(boolean enable)

This method is used to toggle the status of dark theme on the device.

Parameters:

enable - Set to true to enable dark mode and to false to disable dark mode.

setNotificationStatusEnabled

public void setNotificationStatusEnabled(boolean status)

This method is used to enable/disable Notification with statusbar

Parameters:

status - Set to true to disable notifications and to false to enable notifications.

setLockStatusBarEnabled

public void setLockStatusBarEnabled(boolean status)

This method is used to Enable / Disable Status Bar Swipe Lock

Parameters:

status - The status

spFirmwareUpgrade

public boolean spFirmwareUpgrade()

This method is used to upgrade the firmware of the secure processor on M60 payment devices First add QE1000_new.uld (firmware file) needs to be stored at /sdcard/Download/ folder

getStickyEloViewModeEnabled

public boolean getStickyEloViewModeEnabled()

This method is used to get status of sticky EloView boot mode

Returns:

true if sticky EloView boot mode is enabled, false otherwise

setStickyEloViewModeEnabled

public void setStickyEloViewModeEnabled(boolean stickyMode)

This method is used to set sticky EloView boot mode

Parameters:

stickyMode - true to enable sticky EloView boot mode and false to disable it

setRecentButtonEnabled

public void setRecentButtonEnabled(boolean enable)

This method is used to Enable Recent Button

setFirmwareStatusLockEnabled

public boolean setFirmwareStatusLockEnabled(boolean status)

This method is used to lock or unlock the secure processor firmware update

Parameters:

status - true to lock firmware upgrade and false to unlock

Returns:

true if the operation is successful, false otherwise

getFirmwareStatusLockEnabled

public int getFirmwareStatusLockEnabled()

This method is used to get status of secure processor firmware

Returns:

0 if locked, 1 if PCI flag is on, 2 if PCI flag is off, -1 on error

setMultiAppModeEnabled

public boolean setMultiAppModeEnabled(android.content.Context context,
                                      boolean status)

This method is used to change app mode (Enable - multi app mode, Disable - single app mode)

Parameters:

context - A context object of the calling class (Activity/Service)

status - boolean (true/false) to enable or disable multi app mode

Returns:

true if the operation is successful, false otherwise

readSystemProperty

public java.lang.String readSystemProperty(java.lang.String key)

writeSystemProperty

public void writeSystemProperty(java.lang.String key,
                                java.lang.String value)

setBluetoothEnabled

public void setBluetoothEnabled(boolean bluetoothState)

This method is used to Enable/Disable bluetooth

Parameters:

bluetoothState - "Enable" to Enable Bluetooth and "Disable" to Disable Bluetooth

setUSBPorts

public void setUSBPorts(java.lang.String json)

setShowTapsEnabled

public void setShowTapsEnabled(boolean showTapsState)

This method is used to Enable/Disable Show Taps

Parameters:

showTapsState - "Enable" to Enable Show Taps and "Disable" to Disable Show Taps

setExternalAudioDeviceEnabled

public void setExternalAudioDeviceEnabled(boolean externalSpeakerState)

This method is used to select Internal/External Speaker.

Parameters:

externalSpeakerState - true for External Speaker and false for Internal speaker.

getHotspotAccessibilityEnabled

public boolean getHotspotAccessibilityEnabled()

This method is used to get the status of Hotspot accessibility

Returns:

true if the operation is successful, false otherwise

setHotspotAccessibilityEnabled

public void setHotspotAccessibilityEnabled(boolean status)

This method is used to Enable Disable Hotspot accessibility

Parameters:

status - The status

verifyFileSignature

public java.lang.String verifyFileSignature(java.lang.String absoluteFilePath,
                                            java.lang.String absoluteSha256Path)

This method is used to verify signature of the file.

Parameters:

absoluteFilePath - absolute file path of original file to verify integrity

absoluteSha256Path - absolute sha-256 path for checksum of file

getMD5Checksum

public java.lang.String getMD5Checksum(java.lang.String absoluteFilePath)

This method is used to verify signature of the file.

Parameters:

absoluteFilePath - accessToken

Returns:

md5 checksum of the file

getShowInsetsOnSwipe

public boolean getShowInsetsOnSwipe()

Function used to retrieve true/false value for whether status and navigation bars (insets) will be shown when swiping from top or bottom of screen after insets are hidden using native Android API's. The value will always be false in eloview mode. This value can be changed with setShowInsetsOnSwipe in GMS and Android home mode.

Returns:

true/false value for whether insets will be shown when swiping from top or bottom of screen

setShowInsetsOnSwipe

public void setShowInsetsOnSwipe(boolean show)

Function used to hide/show status and navigation bars (insets) when swiping from top or bottom of screen after insets are hidden using native Android API's. This function is only supported in GMS and android home mode.

Parameters:

show - - whether to show insets when swiping from top or bottom of screen

testPeripheralMode

public void testPeripheralMode()

Function used to launch test peripheral mode. testPeripheralMode() was present in EloSecure since Android 10. However, this was added in AIDL in MR-22(Value Android 12) as part of replacing the EloAPIService(IntentService) calls from Elohub -> EloSecure with AIDL calls from Elohub -> EloViewHomeSDK. This won't be available for call from lower MRs/SMRs.

copyFile

public boolean copyFile(java.lang.String source,
                        java.lang.String destination)

Function used to copy file from source path to destination path.

Parameters:

source - - Source path FROM where file is to be copied

destination - - Destination path TO where file is to be copied

writeFile

public boolean writeFile(java.lang.String destination,
                         java.lang.String data,
                         boolean readable,
                         boolean append,
                         boolean overwrite)

Function used to create file at a destination path with given data.

Parameters:

destination - - Destination path where file is to be created

data - - Data that is to be written to the file

readable - - To specify whether file is readable

append - - To specify whether we should append to file

overwrite - - To specify whether we should overwrite the file

verifyFileSignature

public java.lang.String verifyFileSignature(byte[] zipFileByteArray)

This method is used to Verify File Integrity from zip file bytes. EloPayService receives this zip file bytes. Then, it verifies the signature integrity of each file bytes of zip file.

Parameters:

zipFileByteArray - byte array of the zip file

Returns:

A JSON string containing information about the processed file: - "fileName": Name of the saved file - "SignatureMatch": Boolean indicating if the signature matched - "errorMessage": Error details if verification failed - "SHA256": SHA-256 hash of the original file - "MD5originalfile": MD5 hash of the original file

writeSignedFileToStorage

public java.lang.String writeSignedFileToStorage(byte[] zipFileByteArray)

This API will verify the zip file bytes and copy the file to the /data/CastlesFile/protected folder. After verifying the signature integrity, if it is passed, the file bytes are copied to the /data/CastlesFile/protected folder.

Parameters:

zipFileByteArray - byte array of the zip file

Returns:

A JSON string containing information about the processed file: - "fileName": Name of the saved file - "SignatureMatch": Boolean indicating if the signature matched - "errorMessage": Error details if verification failed - "SHA256": SHA-256 hash of the original file - "MD5originalfile": MD5 hash of the original file

enableSecureWhiteListMode

public java.lang.String enableSecureWhiteListMode()

This API will enable BIN whitelisting mode on the payment device. For successful operation: "WhiteListMode Enabled successfully" For fail operation: "WhiteListMode Enable Failed"

getSecureWhitelistModeStatus

public boolean getSecureWhitelistModeStatus()

This API will result "TRUE" if BIN whitelisting is already enabled or will result "FALSE"

setExternalScreenOrientation

public boolean setExternalScreenOrientation(java.lang.String orientation)

This method is used to set External Screen Orientation

Parameters:

orientation - value should be "0", "90", "180", or "270"

Returns:

boolean true on successful setOrientation , false on fail

getExternalScreenOrientation

public java.lang.String getExternalScreenOrientation()

This method is used to get external Screen Orientation details.

Returns:

external screen orientation.

setBrightness

public void setBrightness(int value)

This method is used to set the Brightness of the device

Parameters:

value - - 0-100

getBrightness

public int getBrightness()

This method is used to set the Brightness of the device