Samsung KNOX Customization SDK - SEAP · Knox Customization SDK Release Notes 2 2.7.1 Changes Due...

Samsung KNOX Customization SDK

Release Notes

Version 2.7.1 April 25, 2017

Copyright Notice

Copyright © 2015-2017 Samsung Electronics Co. Ltd. All rights reserved. Samsung is a registered trademark of

Samsung Electronics Co. Ltd. Specifications and designs are subject to change without notice. Non-metric

weights and measurements are approximate. All data were deemed correct at time of creation. Samsung is not

liable for errors or omissions. Android and Google Play are trademarks of Google Inc. ARM and TrustZone are

registered trademarks of ARM Ltd. or its subsidiaries. All brand, product, service names and logos are

trademarks and/or registered trademarks of their respective owners and are hereby recognized and

acknowledged.

Document History

Date Changes

April 28, 2014

First version of document.

July 11, 2014

Updated document to include changes related to v2.0.

March 20, 2015


August 31, 2015

Updated document to include architectural improvements and new features in v2.5.

November 10, 2015


December 23, 2015

Updated document to include changes related to v2.6 latest fixes.

July 5, 2016


April 23, 2017 Updated document to include changes related to Xcover APIs.

Resources

• Learning Materials − seap.samsung.com/developer/sdk/knox-customization-android

• Developer Forum − https://seap.samsung.com/forum/category?forum=769

• Support − samsungknox.com/support

https://seap.samsung.com/developer/sdk/knox-customization-android

https://seap.samsung.com/forum/category?forum=769

http://samsungknox.com/support

Contents

2.7.1 Xcover APIs Addition ............................................................................................................................ 1

Settings Manager ...................................................................................................................................... 1

2.7.1 Changes ................................................................................................................................................ 2

2.7 Features .................................................................................................................................................. 3


System Manager ....................................................................................................................................... 3

2.6 Features .................................................................................................................................................. 4


System Manager ....................................................................................................................................... 4

2.5 Features .................................................................................................................................................. 6


System Manager ....................................................................................................................................... 8

ProKiosk Mode ........................................................................................................................................ 10

Deprecated .................................................................................................................................................. 12

Known Issues ............................................................................................................................................... 13

Preface

About this guide

This guide describes new features in the latest version of the Samsung KNOX Customization SDK

Related resources

• Samsung KNOX Customization SDK Developer Guide — Describes how to install the

KNOX Customization SDK and start developing an app using the SDK.

• Samsung KNOX Customization SDK API Reference — Describes the SDK’s API methods,

parameters, return values, and error codes. Includes sample code showing how to call

API methods.

Audience

This guide is for app developers such as Systems Integrators, who want to use the Samsung

KNOX Customization SDK to customize solutions for enterprise partners.

The guide assumes that you are experienced with Android programming. It does not discuss

how to build and deploy Android apps.

Notational conventions

This guide uses the following notation conventions.

• Boldface emphasizes words in text such as screen or window names.

• Italic identifies new words, emphasizes phrases, and identifies document names.

• Monospace represents information as it appears on a display or in command syntax.

https://seap.samsung.com/developer/sdk/knox-customization-android/developer-guides

https://seap.samsung.com/developer/sdk/knox-customization-android/api-references

Knox Customization SDK Release Notes 1

2.7.1 Xcover APIs Addition

To the existing KNOX Customization SDK version 2.7.1, the following new APIs are added specifically for

Xcover 4 device.

Settings Manager

Feature New API methods Description

Xcover Key setXCoverKeyApp Configure an app to launch on long/short press

of the Xcover key.

getXCoverKeyApp Returns the app set to launch on long/short

press of Xcover key.


2.7.1 Changes

Due operating system and Samsung device UI changes, the following methods and constants have been

deprecated, and will not work on devices running Android Nougat or above:

KnoxCustomManager.getSealedMultiWindowFixedState() KnoxCustomManager.setSealedMultiWindowFixedState()

ProKioskManager.getMultiWindowFixedState() ProKioskManager.setMultiWindowFixedState()

KnoxCustomManager.setLockscreenWallpaper() SystemManager.setLockscreenWallpaper()

CustomDeviceManager.LOCK_SCREEN_ADDITIONAL_INFO

(formerly used by SystemManager.setLockscreenHiddenItems())

CustomDeviceManager.CALL_SCREEN_INCALL_MENU (formerly used by SystemManager.setCallScreenDisabledItems())

ProKioskManager.setPowerDialogItems()

CustomDeviceManager.POWER_DIALOG_AIRPLANEMODE

KnoxCustomManager.setCustomOperatorName()

CustomDeviceManager.NOTIFICATIONS_SAFE_VOLUME (formerly used by ProKioskManager.setHideNotificationMessages())

Note: Some deprecated methods have no replacements; see the Knox Customization SDK API Reference

for complete method descriptions.

https://seap.samsung.com/sdk/knox-customization-android/api-references

https://seap.samsung.com/sdk/knox-customization-android/api-references


2.7 Features

Version 2.7 of the KNOX Customization SDK provides the following new features:

Settings Manager


Flight mode setFlightModeState Turn the flight mode on or off.

System Manager


Home screen addShortcutToHomeScreen

removeShortcutFromHomeScreen

addWidgetToHomeScreen

removeWidgetFromHomeScreen

removeKnoxCustomShortcutsFromH

omeScreen

Customize home screen items.

Lock screen setLockScreenShortcut

getLockScreenShortcut

Customize lock screen.

Auto Answer Incoming Call setAutoCallPickupState

getAutoCallPickupState

addAutoCallNumber

removeAutoCallNumber

getAutoCallNumberList

getAutoCallNumberDelay

getAutoCallNumberAnswerMode

Configure/manage auto answer

incoming call numbers.

Mac Address getMacAddress Mac address.

Power off powerOff Powers off the device.

USB Type setUsbConnectionType

getUsbConnectionType

Configure USB connection type.


2.6 Features

Version 2.6 of the KNOX Customization SDK provides the following new features:

Settings Manager


Power Saving mode setPowerSavingMode A new mode is added into this API.

Use POWER_SAVING_ULTRA_OFF mode to

turn off the Ultra Power Saving mode.

System Manager


Animations clearAnimation Clear the boot or shutdown

animation, which was set

using set animation APIs.

Accessibility Settings setAccessibilitySettingsItems

getAccessibilitySettingsItems

Control various accessibility

settings.

Auto boot on power setForceAutoStartUpState

getForceAutoStartUpState

Automatically boot the device

when power is applied.

Control system sounds setSystemSoundsEnabledState

getSystemSoundsEnabledState

Allow control over system

sounds. Useful for impaired

users since haptic feedback

and touch sounds could be

enabled when required.

Control vibration intensity setVibrationIntensity

getVibrationIntensity

Set the vibration intensity

differently for the different

vibration modes.

DTMF tones sendDtmfTone Send DTMF tones over a

voice call.

Home screen addShortcutToHomeScreen

removeShortcutFromHomeScreen

addWidgetToHomeScreen

removeWidgetFromHomeScreen

getParentScreen

Allows home screen to be

managed.

Mobile hotspot setWifiHotspotEnabledState

getWifiHotspotEnabledState

Set the device as a mobile

hotspot.

Network type setMobileNetworkType

getMobileNetworkType

Allow to set specified network

type.


Quick panel items control setQuickPanelEditMode

getQuickPanelEditMode

setQuickPanelItems

getQuickPanelItems

setQuickPanelButtons

getQuickPanelButtons

Add or remove items from

the quick panel on the status

bar. Also allow the Edit

button to be removed.

Status bar setStatusBarNotificationsState

getStatusBarNotificationsState

Allows show or hide the

notifications and ability to

expand the status bar.

Settings setFlightModeState Switches flight mode on and

off.

System wide ProKiosk functions setPowerDialogCustomItemsState

getPowerDialogCustomItemsState

setPowerDialogCustomItems

getPowerDialogCustomItems

setStatusBarMode

getStatusBarMode

These APIs were part of

ProKiosk mode & can take

effect only when device is in

ProKiosk state. Now, there

APIs can be used system

wide, outside ProKiosk state.


2.5 Features

Architectural improvements

There were several enhancements to the SDK to improve API names, groups, permission

control, and future scalability. If you have developed apps for earlier versions of the SDK,

please review these changes. Although the latest v2.5 SDK provides backwards compatibility

with earlier apps, you should update your existing apps to take advantage of all the new and

improved features in the latest and future SDKs.

The improvements are as follows:

• ProKiosk Mode — This is the new name for Sealed Mode. New APIs and values have

been created that use ProKiosk in place of Sealed. For example, the API method

setProKioskState replaces setSealedState, and the permission

CUSTOM_PROKIOSKMODE replaces CUSTOM_SEALEDMODE.

• cdm.jar — This library replaces kcm.jar.

• CustomDeviceManager — This class replaces KnoxCustomManager.

• ProKioskManager, SettingsManager, SystemManager — The

KnoxCustomManger class provided all the API methods in earlier versions of the SDK.

The APIs have now been split between these three classes to provide better

classification and permission control.

With v2.5, here is how to get a custom device instance and enable kiosk mode:

CustomDeviceManager cdm =

CustomDeviceManager.getInstance(); ProKioskManager

pkm = cdm.getProKioskManager();

result = pkm.setProKioskState(true, mPassCode);

This replaces the process used in v2.4.1 and earlier:

KnoxCustomManager kcm = KnoxCustomManager.getInstance();

result = kcm.setSealedState(true, mPassCode);

As you can see, there is now an additional step to get an instance of an object

(ProKioskManager, SettingsManager, or SystemManager) that now manages an API

method. You get the object first, then use it to call all API methods belonging to it.

To see which object an API method belongs to, simply search for the method in the API

Reference:




Version 2.5 of the KNOX Customization SDK provided the following API methods:

Settings Manager

setDeveloperOptionsHidden

setSettingsHiddenState

getSettingsHiddenState

setBluetoothVisibilityTimeout

getBluetoothVisibilityTimeout

setMobileDataRoamingState

setWifiConnectionMonitorState

getWifiConnectionMonitorState

setWifiNetworkNotificationState

setPackageVerifierState

getPackageVerifierState

setBackupRestoreState

getBackupRestoreState

setMotionControlState

getMotionControlState

setStayAwakeState

setWifiState

setPowerSavingMode

getPowerSavingMode

setChargingLEDState

getChargingLEDState

setScreenWakeupOnPowerState

getScreenWakeupOnPowerState

setLTESettingState

getLTESettingState

setAirGestureOptionState

getAirGestureOptionState

setWifiFrequencyBand

getWifiFrequencyBand


System Manager

checkEnterprisePermission

getSerialNumber

removeLockScreen

setAudioVolume

setAutoRotationState

getAutoRotationState

setCpuPowerSavingState

getCpuPowerSavingState

setMultiWindowState

setScreenPowerSavingState

getScreenPowerSavingState

setScreenTimeout

getScreenTimeout

setSystemRingtone

setUserInactivityTimeout

getUserInactivityTimeout

dialEmergencyNumber

setSystemSoundsSilent

setExtendedCallInfoState

getExtendedCallInfoState

setCheckCoverPopupState

getCheckCoverPopupState

setRecentLongPressActivity

getRecentLongPressActivity

setRecentLongPressMode

getRecentLongPressMode

setCallScreenDisabledItems

getCallScreenDisabledItems

setLockscreenWallpaper

setInfraredState

getInfraredState

setSensorDisabled

getSensorDisabled

setCustomOperatorName

getCustomOperatorName

setVolumePanelEnabledState

getVolumePanelEnabledState

setVolumeControlStream

getVolumeControlStream

setStatusBarText getStatusBarText


getStatusBarTextStyle


ProKiosk Mode

setExitUI

getExitUI

setHardKeyIntentState

getHardKeyIntentState

setHideNotificationMessages

getHideNotificationMessages

setHomeActivity getHomeActivity

setInputMethodRestrictionState

getInputMethodRestrictionState

setMultiWindowFixedState

getMultiWindowFixedState

setPassCode

setPowerDialogCustomItemsState

getPowerDialogCustomItemsState

setPowerDialogCustomItems

getPowerDialogCustomItems

setPowerDialogItems

getPowerDialogItems

setPowerDialogOptionMode

getPowerDialogOptionMode

setProKioskState

getProKioskState

setProKioskString

getProKioskString

setStatusBarClockState

getStatusBarClockState

setStatusBarIconsState

getStatusBarIconsState

setStatusBarMode

getStatusBarMode

setUsbMassStorageState

getUsbMassStorageState

setUsbNetAddresses

getUsbNetAddress

setUsbNetState

getUsbNetState

setVolumeKeyAppState

getVolumeKeyAppState

setVolumeKeyAppsList

getVolumeKeyAppsList


setSettingsEnabledItems


Deprecated

Feature Interface Description

Boot Animation setBootAnimation This method is deprecated since Version 2.6

use setBootingAnimation.

Shutdown Animation setShutdownAnimation This method is deprecated since Version 2.6

usesetShuttingDownAnimation

Knox Custom Manager KnoxCustomManager This class is deprecated Since version 2.5, If

your device supports version 2.5 or above,

please use the CustomDeviceManager class


Known Issues

There are no known issues.

Samsung KNOX Customization SDK - SEAP · Knox Customization SDK Release Notes 2 2.7.1 Changes Due...

Documents

Transcript of Samsung KNOX Customization SDK - SEAP · Knox Customization SDK Release Notes 2 2.7.1 Changes Due...