Portable, point-in-time capture of an account's app configuration, used to detect and review configuration drift. Produced by AccountManager.createAccountConfigSnapshot, it holds one entry per app id, each containing the app's config items grouped by config item type (such as settings or enrolments). Two snapshots can be compared with AccountManager.diffConfigSnapshots to produce a ConfigDiff, and a snapshot can be persisted or exchanged as XML or JSON via AccountManager's save/load and toJson/fromJson methods, where the XML form is written under the accountConfigSnapshot element.

Group: Account Settings


Properties

PropertyReturnsDescription
configItemsMap<String,Map<String,List<ConfigItem>>>The captured configuration, keyed first by app id and then by config item type (such as settings or enrolments), with each type holding the list of ConfigItem values captured for that app and type.
createdDateDateThe date and time this snapshot was captured.
sourceAdminDomainStringThe admin domain of the account the snapshot was captured from, used to identify where it came from when comparing or reviewing snapshots.

Methods

newConfigItemBuilder(String id)

Returns: ConfigItemListBuilder

Starts building the list of config items for one app within this snapshot, grouped by config item type.

ParameterDescription
idthe app id the config items are being captured for

getConfigItems()

Returns: Map<String,Map<String,List<ConfigItem>>>

The captured configuration, keyed first by app id and then by config item type (such as settings or enrolments), with each type holding the list of ConfigItem values captured for that app and type.

getCreatedDate()

Returns: Date

The date and time this snapshot was captured.

getSourceAdminDomain()

Returns: String

The admin domain of the account the snapshot was captured from, used to identify where it came from when comparing or reviewing snapshots.

To get full access to the Kademi Hub existing customers can login here, or new customers can register here.