Click or drag to resize

Com.Datalogic.Device.Configuration Namespace

Classes
Class Description
Public class AutoScanTriggerRange
Public class BTPairingPolicy
Enum BTPairingPolicy defines the policies for Bluetooth pairing through the property PropertyID.BT_PAIRING_POLICY.
Public class BatteryChargingProfilePersistencePolicy
Enum BatteryChargingProfilePersistencePolicy defines the policies for applying the battery charging profile used by the property PropertyID.POWER_BATTERY_CHARGING_PROFILE_PERSISTENCE_POLICY.
Public class BlobProperty
BlobProperty implements the property that allows to manage any class through the ConfigurationManager. The only constraint is that the base type for a BlobProperty must extends the abstract class SerializableBlob.
Public class BluetoothSilentPairingWhitelisting
BluetoothSilentPairingWhitelisting implements the class that manages the silent pairing devices whitelisting. The class is managed by the ConfigurationManager BlobProperty PropertyID.BT_SILENT_PAIRING_WHITELISTING.
Public class BluetoothSilentPairingWhitelisting+IdentifierType
Public class BooleanProperty
BooleanProperty is the class that implements the property of type Boolean.
Public class CaptivePortalPolicy
Enum CaptivePortalPolicy defines the behaviour of the device in case of connecting to a public Wi-Fi with a captive portal interface. In particular, selecting the desired mode, the user can be prompted to authenticate, to be allowed or disallowed to connect to networks which requiring authentication through a captive portal.
Public class CharacterProperty
CharacterProperty is the class that implements the property of type Character.
Public class ChargingSourcesFlags
The ChargingSourcesFlags defines device charging source.
Public class ClipboardPolicy
The ClipboardPolicy enumeration defines the features which can be accessible to the user through the Clipboard.
Public class ConfigException
Public class ConfigurationChangeEventArgs
Public class ConfigurationManager
Public class DatalogicScreensaver
DatalogicScreensaver implements the BlobProperty that allows to manage Screensaver configuration if `Datalogic Screensaver` app is used to show screensaver on the device.
Public class DatalogicScreensaver+Builder
Public class DesktopModePolicy
Enum DesktopModePolicy defines the desktop mode settings for screen sharing. These are the allowed values for the property PropertyID.DESKTOP_MODE_POLICY
Public class DeviceNameSuffix
Enum DeviceNameSuffix defines the possible suffixes for setting the property PropertyID.DEVICE_NAME_SUFFIX. This value is added to the property PropertyID.DEVICE_NAME_BASE to build a unique device name.
Public class DoNotDisturbPolicy
Enum DoNotDisturbPolicy defines the policy for Do Not Disturb. It's used by property PropertyID.DO_NOT_DISTURB_POLICY.
Public class DualSimPreferredCallsAndSms
Public class DualSimPreferredData
Public class DualSimStatus
Public class EnterpriseBatterySaverActivationItems
EnterpriseBatterySaverActivationItems implements the BlobProperty that allows to manage the activation items for the Enterprise Battery Saver.
The class is managed by the ConfigurationManager Blob Property PropertyID.POWER_ENTERPRISE_BATTERY_SAVER_ACTIVATION_ITEMS.
Public class EnterpriseBatterySaverActivationItems+ActivationItem
Public class EnterpriseBatterySaverActivationItems+ActivationItem+Builder
Public class EnterpriseBatterySaverActivationItems+ActivationItem+Type
Public class EnterpriseBatterySaverActivationItems+Builder
Public class EnterpriseBatterySaverProfiles
EnterpriseBatterySaverProfiles implements the BlobProperty that allows to manage the profiles for the Enterprise Battery Saver.
The class is managed by the ConfigurationManager Blob Property PropertyID.POWER_ENTERPRISE_BATTERY_SAVER_PROFILES.
Public class EnterpriseBatterySaverProfiles+Builder
Public class EnterpriseBatterySaverProfiles+Profile
Public class EnterpriseBatterySaverProfiles+Profile+Builder
Public class EnterpriseBatterySaverProfiles+Profile+Location
Public class EnumProperty
EnumProperty is the class that implements the property of type Enum.
Public class LoggerBufferSize
The LoggerBufferSize enumeration defines the possible Logger buffer sizes.
Public class MotionTriggerSensitivity
Public class MultipleChoiceProperty
MultipleChoiceProperty is the class that implements the property of type MultipleChoice. The single choices are defined by the class that can be retrieved calling getChoices(). The value of the property is a combination of single choices. The combinations of the single choices that are allowed values can be retrieved calling getAllowedValues().
Public class NotificationPanelPolicy
The NotificationPanelPolicy enumeration defines the notifications to be displayed on the Notification Panel.
Public class NumericProperty
NumericProperty is the class that implements the property of type Integer.
Public class OffChargingModePolicy
Public class PhysicalKeyboardPolicy
The PhysicalKeyboardPolicy enumeration defines the layouts for external physical keyboard.
Public class PocketModePolicy
Public class PowerState
PowerState is a class defining constants for different charge statuses and failure statuses of the device.
Public class PowerState+Charge
Public class PowerState+CriticalFailure
Public class PowerState+Failure
Public class ProfileManager
ProfileManager gives the developer the ability to create a profile and to load it explicitly or to associate it to a loading condition to be automatically loaded.
A profile is a set of Propertys with their value.
The utility of a profile is that we can collect in it the setting of the properties we need for a specific purpose and then we can load it explicitly calling loadProfile(java.lang.String) or automatically when an activity comes to foreground, defining a rule (addProfileRule(java.lang.StringBuffer, java.lang.String, java.lang.String, java.util.ArrayList<java.lang.String>)) that associates that profile with the activity.
A profile is identified by a symbolic name that must be unique on the device. When a profile is created it is assigned a PersistenceType that can be:
  1. Factory Reset Persistent, the file containing the profile will survive to a factory reset.
  2. Enterprise Reset Persistent, the file containing the profile will survive to an enterprise reset.
  3. Reboot Persistent, the file containing the profile will survive to a reboot.
A Factory Reset Persistent profile can only be preinstalled on the device by an Espresso OTA and cannot be deleted.
The creation of a profile is done in best effort with reference to the specified set of couples of property and value, that is when a profile is created all the properties that are read-only or which are set to values outside the range of their allowed values or which require a device reboot to be applied are ignored.
A profile is saved on the device in a json file with the following schema:
 {
  "$schema": "http://json-schema.org/draft-07/schema#",
  "title": "Profile Description Schema",
  "description": "Schema of a profile.",
  "type": "object",
  "version": "2.0.0",

  "definitions": {
      "properties": {
          "type": "array",
          "items": { "$ref": "#/definitions/property" }
      },

      "property": {
          "type": "object",
          "properties": {
              "id": {
                  "type": ["integer", "string"],
                  "description": "Unique integer identifier of the property. 
                                  The defining string can be used instead of the numeric value."
              },
              "value": {
                  "type": "string",
                  "description": "Value of the property. It is a string and 
                                  it will be parsed according to the specific type of the property. 
                                  Value for a CharacterProperty is the unicode format (i.e: \\uFFFF)."
              }
          },
          "required": ["id", "value"]
      },
  },

  "properties": {
      "version": {
          "type": "string",
          "description": "Version of the schema. If you use this the value must be 2.0.0."
      }        ,
      "description": {
          "type": "string",
          "description": "Short string describing the profile."
      },
      "properties": {
          "$ref": "#/definitions/properties",
          "description": "List of properties with their value."
      }
  }
 }
 

As said a profile can be load in two different mode:
  1. manually, calling method loadProfile(java.lang.String),
  2. automatically, calling the method addProfileRule(java.lang.StringBuffer, java.lang.String, java.lang.String, java.util.ArrayList<java.lang.String>) to define a rule that associates the profile to a set of activities. When one of the specified activities comes to the foreground the profile will be automatically loaded. The previous configuration will be restored when the activity will be no more in foreground. An activity can have only one profile associated.
Given their nature there can be only one profile automatically loaded at the time, because:
  1. there is the constraint on the definition of a rule to forbid for an activity to be associated to more than one profile, and
  2. there is only one activity in top foreground at a time.
The method loadProfile(java.lang.String) fails if there is already a profile manually loaded.
It is allowed to have at the same moment a manually loaded profile and an automatically loaded profile. When there is both a manually loaded profile and an automatically loaded profile the value of the properties belonging to both profiles are set to the value specified in the automatically loaded profile. This is true no matter the order of load of the two profiles was. The persistence type of a profile controls:
  1. the persistence to reboot or reset of the file saved on the device not the persistence of the applied profile configuration, and
  2. the persistence to reboot or reset of the rules that associate the profile to activities, if any. A rule that associates a profile with persistence REBOOT_PERSISTENT to an activity will be recreated after a normal reset but will be deleted by an enterprise reset. A rule that associates a profile with persistence ENTERPRISE_RESET_PERSISTENT to an activity will be recreated after a normal or enterprise reset but will be deleted by a factory reset.

The configuration applied by an automatically loaded profile is automatically unloaded when the associated activity is no more in foreground or the device restarts.
The configuration applied by a manually loaded profile is persistent to a reboot and must be explicitly unloaded.
To create a profile do the following steps:
  1. Obtain an instance of ProfileManager with ProfileManager(Context).
  2. Create an HashMap and add it the couples {PropertyID,value} to be set applying the profile.
  3. Create the profile calling createProfile(String,HashMap,String,PersistenceType).
 ProfileManager pm = new ProfileManager(this);
 HashMapinvalid input: '<'Integer,String> map = new HashMapinvalid input: '<'Integer,String>();
 map.put(PropertyID.CODE128_ENABLE, "true");  // BooleanProperty
 map.put(PropertyID.CODE128_LENGTH2, "10"); // NumericProperty
 map.put(PropertyID.CODE128_GS1_USER_ID, String.format ("\\u%04x", (int)'a')); // CharacterProperty
 map.put(PropertyID.CODE128_LENGTH_CONTROL, LengthControlMode.ONE_FIXED.toString()); // EnumProperty
 map.put(PropertyID.LABEL_PREFIX, "pippo"); // TextProperty
 pm.createProfile("profilo_128.json", 
                  map, 
                  "enable code128, disable datamatrix", 
                  PersistenceType.ENTERPRISE_RESET_PERSISTENT);
 
To add a rule to automatically load the profile profilo_128.json when the app with package com.datalogic.testprofilo1 comes to the foreground do the following steps:
  1. Obtain an instance of ProfileManager with ProfileManager(Context).
  2. Create a StringBuffer and initialize it with the preferred identifier to be used to register the rule.
  3. Create the rule calling addProfileRule(java.lang.StringBuffer, java.lang.String, java.lang.String, java.util.ArrayList<java.lang.String>).
 ProfileManager pm = new ProfileManager(this);
 StringBuffer rule1_name = new StringBuffer("rule_1");
 pm.addProfileRule(rule1_name,
                   "profilo_1.json", 
                   "com.datalogic.testprofilo1", 
                   new ArrayList());
 
To manually load the profile profilo_128.json do the following steps:
  1. Obtain an instance of ProfileManager with ProfileManager(Context).
  2. Load the profile calling loadProfile(java.lang.String).
 ProfileManager pm = new ProfileManager(this);
 pm.loadProfile("profilo_1.json");
 
To get the identifier of the profile manually loaded, if any, do the following steps:
  1. Obtain an instance of ProfileManager with ProfileManager(Context).
  2. Get the profile identifier calling getLoadedProfile().
 ProfileManager pm = new ProfileManager(this);
 String profile = pm.getLoadedProfile();
 
To unload the profile manually loaded do the following steps:
  1. Obtain an instance of ProfileManager with ProfileManager(Context).
  2. Unload the profile calling unloadProfile().
 ProfileManager pm = new ProfileManager(this);
 pm.unloadProfile();
 
To delete the profile profilo_128.json do the following steps:
  1. Obtain an instance of ProfileManager with ProfileManager(Context).
  2. Delete the profile calling deleteProfile(java.lang.String).
 ProfileManager pm = new ProfileManager(this);
 pm.deleteProfile("profilo_1.json");
 
To remove the rule "rule_1" do the following steps:
  1. Obtain an instance of ProfileManager with ProfileManager(Context).
  2. Remove the rule calling removeProfileRule(java.lang.String).
 ProfileManager pm = new ProfileManager(this);
 pm.removeProfileRule("rule_1");
 
To get the list of all the profiles saved on the device do the following steps:
  1. Obtain an instance of ProfileManager with ProfileManager(Context).
  2. Get the list calling getProfilesList().
 ProfileManager pm = new ProfileManager(this);
 ArrayList profileList = pm.getProfilesList();
 
To get the list of all the rules defined on the device do the following steps:
  1. Obtain an instance of ProfileManager with ProfileManager(Context).
  2. Get the list calling getProfileRulesList().
 ProfileManager pm = new ProfileManager(this);
 ArrayList profileRuleList = pm.getProfileRulesList();
 
Public class ProfileRuleType
ProfileRuleType is the class that implements the descriptor of the association of a profile to a set of activities. When one of the listed activities comes to the foreground the profile is automatically loaded. When the activity is no more in foreground the previous configuration will be restored.
Public class ProfileType
Public class Property
Property is the abstract class that represents a generic Property of type T.
Public class PropertyGroup
PropertyGroup contains properties and/or other property groups.
Public class PropertyGroupID
PropertyGroupID is the class that includes all the property group identifiers.
Public class PropertyID
PropertyID is the class that includes all the properties identifiers.
The Propertys are organized in a tree. The Propertys are the leaves while the intermediate nodes are the PropertyGroups.
A property is uniquely identified by its PropertyID.
A property group is uniquely identified by its PropertyGroupID.
In the following all the property group identifiers and all the property identiers are listed in a manner resembling the hierarchical tree of the corresponding PropertyGroups and Propertys.
Each property group can be collapsed/exanded clicking on the blue squared bullet preceding the identifier. The group contains:
Public class PropertyType
PropertyType is the enumerative class representing the Property types.
Public class QuickSettingsTiles
QuickSettingsTiles provides information about the available tiles in the Quick Settings panel. It offers methods to retrieve both system and custom tiles, as well as the correspondence between the ID and the name for the tiles currently available on the device.

In particular, Android offers two types of tiles in the Quick Settings panel: System and App tiles.
System tiles are built into the Android operating system and provide essential device functionalities. In contrast, App or Custom tiles offer quick access to functionalities provided by applications, such as Google Mobile Services (GMS). Therefore, they can be customized and added by installing third-party applications that provide this capability.

See PropertyID.QUICK_SETTINGS_PANEL_TILES for more info about tiles.

Public class ScreensaverAnimation
Enum representing the different types of screensaver animations used by `Datalogic Screensaver` application when when configured as the screensver manager.

This enum provides various animation styles that can be used for a screensaver.

Public class ScreensaverItem
ScreensaverItem represents an item in the screensavers list hosted by class DatalogicScreensaver and used by `Datalogic Screensaver` application when configured as the screensver manager.
Public class ScreensaverItem+Builder
Public class ScreensaverPolicy
Public class SerializableBlob
The base type for a BlobProperty must extends the abstract class SerializableBlob.
Public class StringArrayBlob
StringArrayBlob implements the SerializableBlob that manages a list of String.
Public class StringSetBlob
StringSetBlob implements the SerializableBlob that manages a collection of String.
Public class SupportedWtApplications
StringArrayBlob implements the class that manages the list of supported Walkie-Talkie applications to be used with the Push-to-Talk button. The class is managed by the ConfigurationManager BlobProperty PropertyID.KEYBOARD_PTT_SUPPORTED_WT_APPLICATIONS.
Public class TextProperty
TextProperty is the class that implements the property of type String.
Public class TouchMode
Enum TouchMode defines the allowed touch-screen sensitivity values for settings property PropertyID.TOUCH_MODE_SENSITIVITY. On new device models, starting from M30/M35, property PropertyID.TOUCH_MODE_SENSITIVITY is replaced by PropertyID.TOUCH_MODE.
Public class TouchModeFlags
The TouchModeFlags defines the base touch-screen sensitivities for settings property PropertyID.TOUCH_MODE. Based on the device model more that one can be set.
Public class UsbFunction
Public class UsbHostWhitelisting
UsbHostWhitelisting implements the BlobProperty that allows to manage USB host whitelisting.
The class is managed by the ConfigurationManager Blob Properties PropertyID.USB_HOST_WHITELISTING and PropertyID.USB_PREDEFINED_HOST_WHITELISTING.
Public class UsbWhitelistedDevice
Class UsbWhitelistedDevice defines an USB whitelisted device.
Public class VirtualRAMSwapPolicy
Enum VirtualRAMSwapPolicy defines the swap size for Virtual RAM feature through the property PropertyID.VIRTUAL_RAM_SWAP_POLICY.
Public class WhitelistingPersistence
Public class Wifi802Dot11Mode
Enum Wifi802Dot11Mode defines the allowed values for settings property PropertyID.WIFI_802_DOT_11_MODE
Public class WifiBandFlags
Public class WifiBandSelection
Public class WifiNoInternetExpected
The WifiNoInternetExpected enumeration defines the behaviour when the current connection doesn't have an Internet connection.
Public class WifiPowerSave
Public class WifiRoamingProfile
Enum WifiRoamingProfile defines the Roaming profiles that can be used for settings property PropertyID.WIFI_ROAMING_PROFILE
Public class WorkSchedule
Public class WorkSchedule+Builder
Public class WorkSchedule+WorkTimeInfo
Public class WorkSchedule+WorkTimeInfo+Builder
Interfaces