Summary: Methods | Inherited Methods | [Expand All]
Since: API level 6
public class

BootBanner

extends Object
java.lang.Object
   ↳ com.samsung.android.knox.lockscreen.BootBanner

Class Overview

This class provides APIs to customize banner message during device reboot.
An Administrator can enable/disable reboot banner by enabling reboot banner with text that needs to be displayed. (enableRebootBanner(boolean, String))

Since
API level 6
MDM 4.0

Summary

Public Methods
boolean enableRebootBanner(boolean isEnrolled, String bannerText)
API to show banner message after device reboot.
boolean enableRebootBanner(boolean isEnrolled)
API to show banner message after device reboot.
boolean isRebootBannerEnabled()
API to check whether reboot banner is enabled or not.
[Expand]
Inherited Methods
From class java.lang.Object

Public Methods

public boolean enableRebootBanner (boolean isEnrolled, String bannerText)

Since: API level 13

API to show banner message after device reboot.

Returns
  • true if success else false
Throws
SecurityException If caller does not have required permissions
Usage
An administrator can call this API to show banner message after device reboot. 
 EnterpriseDeviceManager edm = EnterpriseDeviceManager.getInstance(context);
 BootBanner banner = edm.getBootBanner();
  try {
      String text = "Sample Banner Text";
      banner.enableRebootBanner(true, text);
  }catch(SecurityException e) {
      Log.w(TAG,"SecurityException: "+e);
  }
Permission
The use of this API requires the caller to have the "com.samsung.android.knox.permission.KNOX_SECURITY" permission which has a protection level of signature.
Since
API level 13
MDM 5.2
Multiuser Environment
Global Scope
See Also

public boolean enableRebootBanner (boolean isEnrolled)

Since: API level 6

API to show banner message after device reboot.

Returns
  • true if success else false
Throws
SecurityException If caller does not have required permissions
Usage
An administrator can call this API to show banner message after device reboot. This is specifically implemented for STIG compliance requirement for DoD-US (Department of Defense). 
 EnterpriseDeviceManager edm = EnterpriseDeviceManager.getInstance(context);
 BootBanner banner = edm.getBootBanner();
  try {
     
      banner.enableRebootBanner(true);
  }catch(SecurityException e) {
      Log.w(TAG,"SecurityException: "+e);
  }
Permission
The use of this API requires the caller to have the "com.samsung.android.knox.permission.KNOX_SECURITY" permission which has a protection level of signature.
Since
API level 6
MDM 4.0
Multiuser Environment
Global Scope
See Also

public boolean isRebootBannerEnabled ()

Since: API level 6

API to check whether reboot banner is enabled or not.

Returns
  • true if enabled ,false if disabled
 EnterpriseDeviceManager edm = EnterpriseDeviceManager.getInstance(context);
 BootBanner banner = edm.getBootBanner();
  try {
     
      boolean status=banner.isRebootBannerEnabled();
  }catch(SecurityException e) {
      Log.w(TAG,"SecurityException: "+e);
  }
Since
API level 6
MDM 4.0
Multiuser Environment
Global Scope
See Also