Class adobeDPS-FolioActivityConfig
- Platforms:
- iOS, Windows
This class defines the configuration for the FolioActivityService event recording. It is
used when calling startRecording().
Accessible from adobeDPS.folioActivityService.FolioActivityConfig.
Constructor
adobeDPS-FolioActivityConfig(eventsFilter:Array, enableRecordingStatusUI:boolean)
[inner]
Create an instance of FolioActivityConfig.
Fields
Field | Defined By | |
---|---|---|
eventsFilter
: Array
The events filter in the form of an array of event names; if its value is defined then
only the events with the specified names in the filter will be recorded.
|
FolioActivityConfig
|
|
enableRecordingStatusUI
: boolean
If set to true, the user will be informed via a dialog about critical errors that may stop
the current recording of folio activity.
|
FolioActivityConfig
|
Class Detail
adobeDPS-FolioActivityConfig(eventsFilter:Array, enableRecordingStatusUI:boolean)
[inner]
Create an instance of FolioActivityConfig.
Parameters | ||
---|---|---|
eventsFilter | Array | The events filter in the form of an array of event names |
enableRecordingStatusUI | boolean | If true the user will be informed by a dialog about critical errors that may stop futher recordings of folio activity. |
Field Details
eventsFilter
: Array
The events filter in the form of an array of event names; if its value is defined then
only the events with the specified names in the filter will be recorded. It may be left
undefined to record all supported events.
enableRecordingStatusUI
: boolean
If set to true, the user will be informed via a dialog about critical errors that may stop
the current recording of folio activity. This is useful information because during context
browsing, JS application cannot receive such errors until the JS side of the service is
reinitialized; the dialog could help the user to understand that folio activity might not
be recorded if browsing continues.
©2012-2013 Adobe Systems, inc
Documentation generated by JsDoc Toolkit 2.4.0 on Mon Aug 31 2015 09:23:26 GMT-0700 (PDT)
Documentation generated by JsDoc Toolkit 2.4.0 on Mon Aug 31 2015 09:23:26 GMT-0700 (PDT)