PredixMobilityConfiguration

Indicates the SDK will automatically listen for Application state events. Defaults to true. If false, the container application is expected to call PredixMobilityManager’s application state methods such as applicationWillTerminate, applicationDidBecomeActive, etc.

Specifies the default logging level to be used if no logging level configuration is found.

Specifies the default database name to use. This value is overridden by the user’s information upon login, if a database name key is found within the user’s information.

Default: pm

Specifies the authentication scheme to watch for during login. During authentication the user will login via a web page, this web page is then expected to redirect to a URL, in the format of ://

Specifies the authentication grant indicator hostname to watch for during login. During authentication the user will login via a web page, this web page is then expected to redirect to a URL, in the format of ://

Specifies the configuration key (as in a key/value pair) used to determine the logging level in either the info.plist or the settings bundle root.plist

Default: logging_level

Specifies where the logging level configuration key/value should be found.

Specifies the configuration key (as in a key/value pair) used to determine the Trace logging level logs all requests value is in either the info.plist or the settings bundle root.plist

Default: traceLogsReqeuests

Specifies where the Trace logging level logs all requests configuration key/value should be found.

Specifies the configuration key (as in a key/value pair) used to determine the server endpoint hostname in either the info.plist or the settings bundle root.plist.

Default: server_url

Specifies where the server endpoint hostname configuration key/value should be found.

Base server endpoint URL, or nil if LoadConfiguration has not yet been called.

The server endpoint path used to retrieve user session information during the login process.

The server endpoint path used to initialize the login process and display the login page.

The server endpoint path used to log the user out and remove the current user session.

The server endpoint path used to syncronize the local database.

The server endpoinr path used to upload monitor logs and alerts

The server endpoint path used to validate the user has a valid authenticated session.

The Http.StatusCode expected to be returned when calling the authorizationCheckURLPath, when the user has a valid authenticated session.

An array of Http.StatusCodes expected to be returned when calling the authorizationCheckURLPath, whether the user has an authenticated session or not. Any values returned from the authorizationCheckURLPath call other than these codes are interpreted as an error condition where the endpoint server is unavailable.

The key in the response JSON from the userSessionURLPath call that specifies the user name value. The value this key is associated with is expected to be a string.

Default: name

The key in the response JSON from the userSessionURLPath call that specifies the database name value. The value this key is associated with is expected to be a string. If this property is nil, or not found in the user session information then defaultDatabaseName value is used for the database name.

Default:db

Specifies the configuration key used to determine the PM app name to load in either the info.plist or the settings bundle root.plist This value is the name field in the app.json document loaded into the database with the PM cli define command.

Default: pmapp_name

Specifies where the PM app name configuration key/value should be found.

Specifies the configuration key used to determine the PM app version to load in either the info.plist or the settings bundle root.plist This value is the version field in the app.json document loaded into the database with the PM cli define command.

Default: pmapp_version

Specifies where the PM app version configuration key/value should be found.

Default: ConfigurationLocation.infoplist

The key in the PM app document that determines the initial webapp to load into the container at startup.

Default: starter

The key in the PM app document that determines the offline authentication webapp to use during offline login.

Default: offline

The key in the PM app document that determines the available webapps array.

Default: dependencies

The hostname to be used for Predix Mobile SDK service calls.

Default: pmapi

The default error message used in the catastrophic error display that is shown to the user when no webapp can be loaded or the application cannot otherwise continue.

The Bundled HTML filename used for the catastrophic error display that is shown to the user when no webapp can be loaded or the application cannot otherwise continue. If this file is not found a native UI alert message will be used.

Default: SeriousError.html

A closure that, if supplied, is run during the boot/restart service call. This can be used to perform additional container work that should be performed when the system is restarting.

An array of services that should be registered during the boot process.

Specifies the SDK will trap and log unhandled errors before the container crashes.

Specifies the SDK will automatically import default values from the Settings bundle into standard UserDefaults

Default: true

Specifies the SDK will attempt to detect URL requests for placeholder images from http://placehold.it and issue a warning log entry when detected

Default: true

Specifies the SDK will require the device to have a passcode set to proceed during the Boot service startup process.

Default:* true

Specifies the key to use in NSUserDefaults to determine if the server endpoint has changed. When the server endpoint changes, as detected via this key, all user data is wiped from the device.

Specifies the default to indicate a watcher will log all networks requests for the app.

Default:* false

Optionally specifies maximum depth of a document’s revision tree (or, max length of its revision history.) Revisions older than this limit will be deleted when the database is compacted during when DB service close operation is called. Smaller values save space, at the expense of making document conflicts somewhat more likely. If unspecified it currently defaults to 20.

Specifies an app-specific data that should be included when the device registers for push notificiations.

the format of the document id to use when registering for push notifications.

the document type used for the push notification registratino document.

Optional settings used to tweak the behavior of push (client to server) data replication

Optional settings used to tweak the behavior of pull (server to client) data replication

While Online and Authenticated, if replication is encountering continuous errors, after this number of consecutive errors replication will be paused for a period of time as specified by PredixMobilityConfiguration.replicationFailureRetryRecoveryTime.

Changes to connectivity state will reset the error count.

After PredixMobilityConfiguration.replicationFailureRetryAttempts have been surpased, replication will pause for this time interval before resuming.

Changes to connectivity state will invalidate the timer.

An array of view definitions, consisting of a view name, version, and closure that maps the view. The methods appendDataViewDefinition(…) are a helper method to append new definitions to this array.

A dictionary of replication push filter definitions, whose key is the name of the filter, and value is a PushReplicationFilter closure that determines if the document should be pushed to the server during replication.

The name of a PushReplicationFilter, as setup in pushReplicationFilterDefinitions, to use when replication is initially setup

Dictionary of filter parameters to use when replication is initially setup

List of channels used to restrict data coming from the server when replication is initially setup

Optional keychain access group. If provided this group will be used for all keychain access.

Specifies the prefix to use for keychain storage keys.

Provides a short string of version information of the running app, the Predix Mobile SDK, and some of its dependent components.

Specifies that when the SDK detects the ApplicationDidBecomeActive application state, the SDK can start interacting with the UI immediately. If the consuming app wants finer control over when the UI is ready for SDK interaction, it can set this flag to false, and manually post the UIReadyNotification to inform the SDK when the UI is ready for interaction.

This closure allows the implementation of the non-web based serious error pages to be overridden.

In iOS the default implementation shows a UIAlertController with the error details.

In the macOS version of the SDK there is no default implementation.

File system URL under which the SDK uses for all application storage.

File system URL under which the SDK uses for all application storage for the current logged in user. Nil until after authentication completes.

Secondary database to use for hybrid UI data: webapp documents and pm app documents.

If nil the system will use a single database for all data.

If a directory named hybridUIDatabaseName.cblite2 containing a sql lite database exists in the application bundle, then this database will be used as an inital data source.

When a hybrid UI database is used, application loading will not wait for the main data database to sync before launching the hybrid ui webapp.

Example:

PredixMobilityManager.hybridUIDatabaseName = "hybridui"

Specifies the configuration key (as in a key/value pair) used to determine the name of the hybrid UI database in either the info.plist or the settings bundle root.plist

Specifies where the hybrid UI database name configuration key/value should be found.

Default: Info.plist

Works with hybridUIDatabaseName to allow the hybrid UI web elements to be updated dynamically.

Allowing replication of hybrid UI data allows for easy updates during development, or for creating an Enterprise app that supports dynamic updates.

Behaviors:

true: On application start, the database named in PredixMobilityConfiguration.hybridUIDatabaseName will be refreshed from the backend sync gateway. Application loading will wait until this database has synced, but will not wait for the main data database to sync.

false: No replication will be performed to update the hybridUIDatabaseName database. This database is expected to be included in the application bundle. Application loading will not wait for the main data database to sync.

Default: true

Specifies the configuration key (as in a key/value pair) used to determine state of the hybridUIAllowUpdates configuration in either the info.plist or the settings bundle root.plist

Specifies where the hybridUIAllowUpdates configuration key/value should be found.

Default: Info.plist

When enabled the client will monitor and trace conditions in database and on other features in the SDK. These monitor logs will be reported to the backend client monitor. Alert conditions detected by the client will be reported to the Predix NOC as an alert. Clients can also choose to send logs for their applications. Please visit the Mobile MonitorMonitor class for more inforamtion.

Default: false

By default monitor logs are only sent when a user logs in for the first time when enabled. Setting this flag to true will send monitor logs when the monitor is quite for a period of time.

Default: false

The time in seconds the monitor should wait to see if more monitor data comes in before sending the monitor logs to the server

NOTE: This configuration is only valid if clientMonitoringEnabled and clientMonitorSendsLogsContinuously is enabled

Default: 10 seconds

TODO temporary var, remove me please!!!!!!

If the default AuthenticationManager setup is used, this flag allows the Offline webapp to use TouchId for authentication, in place of the offline password.

The time in seconds the monitor should wait to see if more alerts happen before sending the alert to the server

NOTE: This configuration is only valid if clientMonitoringEnabled is enabled

Default: 30 seconds

Tells the SDK to initialize, load configuration from settings, prepare the logging system, and prepare the SDK for startup. If not called by the time PredixMobilityManager.startApp is called, it will be called at that time.

Helper method takes a view name and version, and map function closure, creates a ViewDefinition and adds it to the dataViewDefinitions property.

Helper method takes a view name and version, and map function closure, and reduce function closure, creates a ViewDefinition and adds it to the dataViewDefinitions property.

Adds a ViewDefinition to the dataViewDefinitions property

Adds a filter for Push replication, consisting of a filter name, and a closure called to determine if a given document should be sent to the server.

Returns a dictionary containing version information of the app, the SDK, and dependent components, as well as some basic environmental information for the current device.

Removes all data associated with the app, including the local database and keychain entries.