DeviceSetting

DeviceSetting (
settingID : integer,
settingsCategory : string,
settingRange : string,
override : integer = 0,
rangeLock : integer,
deviceLock : integer,
superuserLock : integer,
settingName : string,
settingValue : string,
settingInheritance : string,
inheritedFrom : string,
changedDate : date,
)

The DeviceSetting type is used for returning lists of settings in getSettings (see getSettings).

The following values are returned:

Values

Name

Description

settingId

Type: integer

The internal identifier of the setting in DME.

settingsCategory

Type: string

The category of the current setting. A category could be "E-mail" (found in the E-mail and PIM group of settings). See also Appendix A: Device settings.

settingRange

Type: string

 

The valid range of settings. For instance, a valid range of the setting Days back in the E-mail category of settings could be 0-99.

override

Type: integer

Whether the current setting is overridden (1) or not (0). An overridden setting has a value that is different from default. See Override in Settings. Default value is 0.

deviceLock

Type: integer

Whether the device is locked to the current setting. See Lock in Settings.

superuserLock

Type: integer

Whether the current setting has been locked for superusers also. See Lock in Settings.

rangeLock

Type: integer

Whether the range (settingRange) of the current setting is locked. See Lock in Settings.

settingName

Type: string

The internal name of the setting in DME. Example: profile.email_sync_enable

settingValue

Type: string

The value of the setting. Example: 5 for profile.email_sync_days_back

settingInheritance

Type: string

From where does the setting derive: Default (default settings), Device (setting changed for the individual device), or any other value, which then signifies Group inheritance and consists of the type of the group (for instance Country).

inheritedFrom

Type: string

A specification of where the setting came from. If settingInheritance = Default, this will be DefaultSetting. If Device, this will be the deviceId of the device. If a group type, this will be the ID of the group.

changedDate

Type: date

The date on which the current setting was last changed.

For an explanation of each setting in DME, please see Appendix A: Device settings.

Next topic

LogEntry