Configure app

The Configure app screen displays the current configuration of the app.

Header

The app's embedded library version number is displayed. If the library version is less than the Appfigurate version, a warning icon is displayed. If the library version is equal to the Appfigurate version, then a green tick is displayed.

If the app being configured is a debug build (the APLConfiguration (iOS/watchOS) or nz.co.electricbolt.appfiguratelibrary.Configuration (Android) subclass method allowInvalidSignatures returned true), then the text Debug build - App allows invalid signature is displayed with a warning icon.

Signature is valid is displayed with a green tick if the correct private key was used to sign the configuration payload.

Configurable properties

The configurable properties in the app are displayed on screen and are editable.

Boolean properties are represented by a switch.

Integer properties are represented by a slider, text field, a list or a list with custom items.

Float and Double properties are represented by a slider, text field, a list or a list with custom items.

String properties are represented by a text field, a list or a list with custom items.

Property options

If the app is a release build, any encrypted strings are displayed with a key icon. If the app is a debug build, plain text strings are used instead, and the key icon is not displayed.

Any properties that require the app to be restarted after being changed are displayed with a restart icon.

List

Tapping on a configurable property that is a list, or a list with custom items shows the following screen:

The currently selected list item is displayed with a tick ✓. To select a new item, tap any item in the list; the list screen will be dismissed automatically. Long press an item to copy the value onto the iOS or Android clipboard.

Customizable list

If the list is customizable, then the Add custom item button is displayed. Tapping the button will display the following screen:

If there is text in the iOS or Android clipboard, then the clipboard contents are automatically pasted into the value field. The first numeric range is highlighted automatically.

Enter a name and value. The value must conform to the property's minimum and maximum values (if applicable) and regular expression (if applicable). If the value does not conform, the field will be displayed bold red, and the Add button will be disabled.

On the list screen, custom items are displayed below predefined items hardcoded in your app:

Applying configuration

When you are ready to apply the selected configuration to your app, tap the Apply ˅ toolbar button. Your app will be launched, and it's configuration updated.

Apply options

Long press the Apply ˅ toolbar button or drag from the right edge of the screen towards the left to open the Apply menu.

The Apply to this device menu item performs identically to tapping the Apply ˅ toolbar button.

The Apply invalid to this device menu item, generates a random private key, which is then used to sign the configuration payload. Your app will then be launched. If your app's APLConfiguration (iOS/watchOS) or nz.co.electricbolt.appfiguratelibrary.Configuration (Android) subclass allowInvalidSignatures method returns true, then the app's configuration will be updated. If the method returns false, then the configuration will not be updated. This can be useful in testing your apps release build to ensure it only accepts valid signatures.

The Reset this device menu item resets your app's configuration back to factory defaults (the values specified in your APLConfiguration (iOS/watchOS) or nz.co.electricbolt.appfiguratelibrary.Configuration (Android) subclass reset method).