Packages and classes
This topic lists all packages and classes contained in the Knox SDK.
Package Index
| Knox SDK | |
| com.samsung.android.knox |
Provides classes that enable device management capabilities at the system level, allowing enterprises to enforce enterprise specific policies by providing a finer-grained control over employee devices. |
| com.samsung.android.knox.accounts |
Provides classes to manage device, email, Exchange and LDAP accounts. |
| com.samsung.android.knox.application |
Provides classes to control application-related functions and restrictions. |
| com.samsung.android.knox.bluetooth |
Provides classes to manage the bluetooth settings. |
| com.samsung.android.knox.browser |
Provides classes to manage the Samsung browser settings. |
| com.samsung.android.knox.container |
Provides classes that are used for managing containers in a multiuser management environment. |
| com.samsung.android.knox.custom |
Provides classes and APIs to customize the device. |
| com.samsung.android.knox.datetime |
Provides classes to control the device's date and time. |
| com.samsung.android.knox.deviceinfo |
Provides classes to retrieve information of the device's inventory. |
| com.samsung.android.knox.devicesecurity |
Provides classes that control device security and password settings. |
| com.samsung.android.knox.dex | Provides classes to control the device's desktop mode. NOTE - This feature is only available in Knox 3.1 and above |
| com.samsung.android.knox.display |
Provides classes to customize the device's display. |
| com.samsung.android.knox.integrity |
Provides classes for verifying the integrity of a device. |
| com.samsung.android.knox.keystore |
Provides classes to manage certificates and keystores. |
| com.samsung.android.knox.kiosk |
Provides classes that enable kiosk mode features, allowing enterprises to customize the device look and feel and brand the device according to a specific enterprise's requirements. |
| com.samsung.android.knox.license |
Provides classes that enable the device administrator application to activiate Enterprise or Knox License on device. |
| com.samsung.android.knox.location |
Provides classes to manage location providers and geofences, allowing enterprises to enforce policies based on geographical location of a device. |
| com.samsung.android.knox.lockscreen |
Provides classes that enable lockscreen customization, allowing enterprises to make customizations on top of the lockscreen. |
| com.samsung.android.knox.log |
Provides classes that enable event logs to be used for forensic analysis of the device. |
| com.samsung.android.knox.multiuser |
Provides classes that enable managing multiple users on device. |
| com.samsung.android.knox.net |
Provides classes to manage device's network settings. |
| com.samsung.android.knox.net.apn |
Provides classes to manage Access Point Name (APN) settings. |
| com.samsung.android.knox.net.billing |
Provides classes that setup and control Enterprise Billing (split billing) on the Knox device. |
| com.samsung.android.knox.net.firewall |
Provides classes that enable management of firewall rules. |
| com.samsung.android.knox.net.nap |
Provides classes that enable registering third party applications as a network monitoring application which will collect network based meta-data on the device. |
| com.samsung.android.knox.net.vpn |
Provides classes to configure Android VPN settings and profiles. |
| com.samsung.android.knox.net.wifi |
Provides classes to manage Wi-Fi settings and profiles. |
| com.samsung.android.knox.nfc |
Provides classes to manage Near Field Communication (NFC) settings capabilities. |
| com.samsung.android.knox.remotecontrol |
Provides classes that enable remote control features, allowing enterprises to remotely inject key/motion events and capture/stream the device display. |
| com.samsung.android.knox.restriction |
Provides classes to restrict device functions. |
| com.samsung.android.knox.sdp |
Provides classes that allows to mark application data to sensitive and other utility functions. |
| com.samsung.android.knox.sdp.core |
Provides classes that allows to create custom SDP engine and manage the engine. |
| com.samsung.android.knox.seams |
Provides classes for SEAndroid Management. |
Class Index
| A | |
| Account | This class contains all the account information for a given email (Microsoft Exchange ActiveSync, IMAP, POP) account |
| AccountControlInfo | This generic class contains information about specific types of accounts that are designated for removal by a particular administrator. |
| AdvancedRestrictionPolicy | This class provides APIs to restrict advanced features. |
| ApnSettings | This class contains all the information for given APN settings. |
| ApnSettingsPolicy | This class provides APIs to create, update, and remove Access Point Name (APN) settings on the device. |
| AppControlInfo | This is a generic class that contains information on the Application policy values for a particular administrator. |
| AppIdentity | Generic class used for application package unique identity. |
| AppInfo | This class is used to store general application usage information. |
| AppInfoLastUsage | This class is used to store application package last usage information. |
| ApplicationPolicy | This class provides APIs to control application-related functions and restrictions. |
| AttestationPolicy | The Attestation agent service provides a front end to retrieve attestation data from the TrustZone. |
| AuditLog | This class provides APIs to log events to be used for forensic analysis of the device. |
| AuditLogRulesInfo | This class provides the configuration object that is used by AuditLog to perform selective data logging, using setAuditLogRules(AuditLogRulesInfo). |
| AuthConfig | This class is used to encapsulate proxy authentication information to be used while configuring a Global Proxy or a Wifi Profile with proxy. |
| AuthenticationConfig | This class contains all the configuration information related authenticating a user based on his/her enterprise identity. |
| AuthenticationConfig.AuthenticationRequestKeys | This class contains a set of string constants which serve as keys to provide the parameters needed to authenticate users. |
| B | |
| BasePasswordPolicy | This class provides wrapper APIs for DevicePolicyManager APIs, recommended to use only for container password policies. |
| BluetoothControlInfo | This generic class contains information about the Bluetooth policy values for a particular administrator. |
| BluetoothPolicy | This class provides APIs to control Bluetooth settings. |
| BluetoothPolicy.BluetoothProfile | This class provides Bluetooth profiles that can be managed by administrators. |
| BluetoothPolicy.BluetoothUUID | This class provides Bluetooth UUIDs that an administrator can manage. |
| BluetoothSecureModeConfig | This class describes each of the Bluetooth profiles which can be enabled or disabled in Bluetooth Secure Mode. |
| BluetoothSecureModePolicy | This class provides APIs to control Bluetooth Secure Mode Settings. |
| BluetoothSecureModeWhitelistConfig | This class defines a structure specifying the fields which are required to add a device to an allowlist in Bluetooth Secure Mode. |
| BootBanner | This class provides APIs to customize banner message during device reboot. |
| BrowserPolicy | This class provides APIs to control browser settings. |
| C | |
| CCMProfile | This class defines profile to setup Client Certificate Manager token. |
| CCMProfile.AccessControlMethod | Access Control Method to be enforced to control access to the allocated token. |
| CEPConstants | This class contains all required constant values which are used inside Certificate Enrollment service. |
| CertificateControlInfo | This generic class contains information on the certificate policy values of a particular administrator. |
| CertificateInfo | This class is used to send security information data across processes. |
| CertificatePolicy | This class provides APIs to control certificate security. |
| CertificateProfile | This class defines profile for controlling access to the certificate being installed. |
| CertificateProvisioning | This class provides APIs to manage certificates and keystores. |
| CircularGeofence | This class defines a circular geofence object. |
| ClientCertificateManager | This class provides APIs for managing certificates in TIMA Client Certificate Manager (CCM). |
| CMCProfile | Certificate Management over CMS (CMC) Profile to enroll certificate. |
| CMPProfile | Certificate Management Protocol(CMP) Profile to enroll certificate. |
| ContainerConfigurationPolicy | This class provides APIs to configure policies related to container. |
| ContainerModeConfigurationType | Interface for managing a Container only mode configuration type. |
| ControlInfo | This generic class contains information on the policy values of a particular administrator. |
| CreationParams | Interface for building parameters to the create the Container. |
| CSRProfile | This class defines profile to setup Certiticate Signing Request (CSR) template. |
| CSRProfile.CSRFormat | Certrificat Signing Request format |
| CSRProfile.KeyAlgorithm | Key Algorith Type |
| CSRProfile.ProfileType | Certificate enrollment protocol types |
| CustomDeviceManager | This class provides the public interface for device customization. |
| D | |
| DateTimePolicy | This class provides APIs to control the device date and time settings. |
| DefaultAppConfiguration | This class contains a combination, set by an administrator in the device, of a task type and the respective activity that should handle such task by default in the system. |
| DeviceAccountPolicy | This class provides APIs to control device accounts such as those supported by the native e-mail application and Google accounts. |
| DeviceInventory | This class provides APIs to retrieve information on the device inventory. |
| DeviceSecurityPolicy | This class provides APIs to control device security settings. |
| DexManager | This class provides APIs to control the desktop mode (Dex). NOTE - This feature is only available in Knox 3.1 and above |
| DomainFilterReport |
This class encapsulates a Domain Filter Report that will be manipulated by the firewall policies. |
| DomainFilterRule |
This class encapsulates a Domain Filter Rule that will be manipulated by the firewall policies. |
| E | |
| EmailAccount | This class contains all the account information for a given email account |
| EmailAccountPolicy | This class provides APIs to create and delete e-mail accounts and to control Internet Access Message Protocol (IMAP) or Post Office Protocol (POP) email account-related settings. |
| EmailPolicy | This class provides APIs to control email application-related settings. |
| EnrollmentProfile | Abstract class which defines a basic profile for certificate enrollment. |
| EnterpriseApn | This class is helper data structure to store Enterprise APN details like apn, mcc and mnc of a network operator. |
| EnterpriseBillingPolicy | This class provides APIs to set up and manage Enterprise Billing on KNOX devices. |
| EnterpriseBillingProfile | This class is helper data structure to store Enterprise Billing Profile details. |
| EnterpriseCertEnrollPolicy | This class provides certificate enrollment related APIs which can be used to provision certificates inside or outside the containers. |
| EnterpriseDeviceManager | Public interface for managing policies enforced on a device. |
| EnterpriseDeviceManager.KNOX_VERSION_CODES | Enumeration of the currently known SDK version codes. |
| EnterpriseKnoxManager | Public interface for managing premium policies enforced on a device. |
| EnterpriseLicenseManager | This class provides APIs to activate Enterprise license on device |
| ExchangeAccount | This class contains all the account information for a given email (EAS) account. |
| ExchangeAccountPolicy | This class provides APIs to configure Microsoft Exchange ActiveSync account-related settings and to create and delete Microsoft Exchange ActiveSync accounts. |
| F | |
| Firewall | This class provides APIs to configure firewall rules on device, providing the ability to implement security policies. |
| Firewall.AddressType | This constant should be used to indicate the address type of a rule. |
| Firewall.Direction | This constant should be used to indicate whether a rule is related to input (when device receives data from the Internet) or output (when device sends data to the Internet). |
| Firewall.NetworkInterface | This constant should be used to indicate whether a rule is related to connection through WI-FI or mobile data. |
| Firewall.PortLocation | This constant should be used to indicate whether the port in the rule is related to the device port or the server port that the device is communicating. |
| Firewall.Protocol | This constant should be used to indicate whether a rule is related to TCP or UDP protocol. |
| FirewallResponse | This class is an object class that will hold the information about the execution of an operation. |
| FirewallResponse.ErrorCode | These constants indicate the possible error code related to an operation. |
| FirewallResponse.Result | These constants indicate the possible results of an operation. |
| FirewallRule |
This class is used to encapsulate an IP rule that will be manipulated by the firewall. |
| FirewallRule.RuleType | This constant is used to indicate the type of the rule. |
| FirewallRule.Status | This constant is used to indicate the status of the rule, the status is related with the state of the rule in the iptables. |
| Font | This class provides APIs to customize device font. |
| G | |
| GenericVpnPolicy | The class provides APIs to configure SSL/IPSEC VPN profiles on the device. |
| Geofence | Base Geofence class used by PolygonalGeofence, CircularGeofence and LinearGeofence. |
| Geofencing | This class provides APIs to create, destroy and monitor geofences. |
| GlobalProxy | This class provides APIs to set and get the device global proxy. |
| H | |
| HostAuth | HostAuth class provides credential and server information about the associated email account. |
| K | |
| KioskMode | This class provides APIs to enable, disable, and define device behavior for kiosk mode. |
| KioskSetting | Class for predefined Kiosk settings. |
| KnoxConfigurationType | Interface for managing a container configuration type. |
| KnoxContainerManager | Public interface for managing containers. |
| KnoxEnterpriseLicenseManager | This class provides APIs to activate Knox Enterprise license on device. |
| L | |
| LatLongPoint | The class defines a latlong point object. |
| LDAPAccount | This class contains all the information for specifying Lightweight Directory Access Protocol (LDAP) account settings. |
| LDAPAccountPolicy | This class provides APIs to create, delete, and get Lightweight Directory Access Protocol (LDAP) account settings on the device. |
| LightweightConfigurationType | Interface for managing a light weight container configuration type. |
| LinearGeofence | This class defines a linear geofence object. |
| LocationPolicy | This class provides APIs to control the settings related to location services. |
| LockscreenOverlay | This class provides APIs to customize the device lock screen. |
| LockscreenOverlay.LSOEmergencyPhoneInfo | This class defines the Lock Screen Overlay Emergency Phone information and is given as an input parameter when configuring the lock screen enterprise emergency phone number. |
| LockscreenOverlay.LSOImage | This class defines the Lock Screen Overlay image and is given as an input parameter when configuring Lockscreen Overlay. |
| M | |
| MultiUserManager | This class provides APIs for managing multiple user capability on device. |
| N | |
| NetworkAnalytics | This class provides APIs for registration of configuration profiles for the process of collecting network activity meta-data on the device. |
| NetworkAnalyticsConstants | This class provides a set of constant values that supplement the network analytics platform operations. |
| NetworkAnalyticsConstants.ActivationState | Constants to represent the state of a configuration profile on the device. |
| NetworkAnalyticsConstants.BroadcastActions | Constants to represent the messages which are broadcasted to the NPA Clients by the framework regarding NPA Status. |
| NetworkAnalyticsConstants.DataPoints | Constants that help configure the set of data points that need to be collected on the device and help interpret the result from the framework. |
| NetworkAnalyticsConstants.ErrorValues | Constants that help interpret return values of API calls from the framework. |
| NetworkAnalyticsConstants.JSONConstants | Constants that help create and interpret configuration JSON strings. |
| NetworkStats | This class provides information about network data usage per application UID |
| NfcPolicy | This class provides APIs to Near Field Communication (NFC) Settings capability. |
| NtpInfo | NTP(Network Time Protocol) info class. |
| P | |
| PasswordPolicy | This class provides APIs to control settings related to the device password. |
| PermissionApplicationPrivateKey | This class contains information needed to allow an application to access private keys without prompting the user for such permission. |
| PhoneRestrictionPolicy | This class provides APIs to control telephony functionality settings. |
| PolygonalGeofence | This class defines a polygonal geofence object. |
| PowerItem | This class defines a custom items in the power dialog option. |
| Profile | This class contains information related to profile registered by the admin |
| ProKioskManager | This class provides APIs to control device in ProKiosk mode. |
| ProxyProperties | This class is used to encapsulate a proxy information to be used in the Global Proxy policy. |
| R | |
| RCPPolicy | This class provides APIs to manage data import/export to/from the container. |
| RemoteInjection | This class provides APIs to support remote injection of key, pointer, and trackball events into the device UI. |
| RestrictionPolicy | This class provides APIs to restrict device functions. |
| RestrictionPolicy.USBInterface | Enum of USB class Interface |
| RoamingPolicy | This class provides APIs to control the various settings related to device roaming. |
| S | |
| SCEPProfile | This class provides a concrete implementation of SCEP EnrollmentProfile. |
| SdpCreationParam | SdpEngine creation parameters. |
| SdpCreationParamBuilder | SdpCreationParam builder. |
| SdpDatabase | SdpDatabase provides convenient APIs to access a database and set its columns as sensitive. |
| SdpDomain | Defines the domain to applications for accessing SDP features. |
| SdpEngine | SdpEngine maintains cryptographic keys for sensitive data. |
| SdpEngineConstants | SdpEngineConstants is a set of constant variables related to SdpEngine creation and its operations. |
| SdpEngineConstants.Flags | Contains all the possible SdpEngine flags. |
| SdpEngineConstants.Intent | Contains the information about SDP intent. |
| SdpEngineConstants.State | Contains all the possible SdpEngine states. |
| SdpEngineConstants.Type | Contains all the possible SdpEngine types. |
| SdpEngineInfo | SdpEngineInfo instance is created by SDP framework. |
| SdpException | Thrown when an error associated to SDP occurs. |
| SdpFileSystem | SdpFileSystem provides convenient APIs for manipulating file(s) as sensitive. |
| SdpStateListener | Used by privileged application to intercept SdpEngine state changes. |
| SdpUtil | SDP utility class. |
| SEAMSPolicy | This class provides SEAMS (SE Android Management) APIs. |
| SettingsManager | This class provides APIs to allow secure system settings to be changed. |
| ShortcutItem | This class defines a custom items in the home screen shortcuts. |
| SimChangeInfo | This class contains information on SIM card changes. |
| SimInfo | This class contains information on the SIM card. |
| SPDControlPolicy | This class provides APIs to control Security policy updates on device. |
| StatusbarIconItem | This class defines a custom item for status bar icons. |
| StatusbarIconItem.AttributeColour | Class for attribute and corresponding color. |
| SystemManager | This class provides APIs to control system behavior for systems that can normally not be accessed. |
| T | |
| TimaKeystore | This class provides APIs for enabling and disabling the TIMA Keystore. |
| U | |
| UsbDeviceConfig | This class defines a structure specifying the fields describing a usb device. |
| V | |
| VpnAdminProfile | This class contains information required to set up an Android VPN profile on the device. |
| VpnErrorValues | The class provides the list of error codes which will be returned by API's in GenericVpnPolicy. |
| VpnPolicy | This class provides APIs to configure Android VPN settings, including creating, updating, and deleting VPN profiles. |
| W | |
| WidgetItem | This class defines a custom widget item in the home screen shortcuts. |
| WifiAdminProfile | This class contains information required to set up a Wi-Fi profile on the device. |
| WifiControlInfo | This generic class contains information on the Wi-Fi policy values for a particular administrator. |
| WifiPolicy | This class provides APIs to configure Wi-Fi related settings and manage Wi-Fi profiles. |
