Class adobeDPS-FolioActivityRecording

Platforms:: iOS, Windows

This class encapsulates the state of a FolioActivityService recording.

Constructor

adobeDPS-FolioActivityRecording(recording:Object)

[inner] Create a FolioActivityRecording object.

Fields

	Field	Defined By
	stateCode : FolioActivityRecordingStates The state code.	FolioActivityRecording
	recordingId : String The current recording identifier.	FolioActivityRecording
	eventsCount : Number The number of events collected for the current recording so far.	FolioActivityRecording
	errors : Array A list of any errors generated on the native side since JavaScript service deactivation.	FolioActivityRecording
	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.	FolioActivityRecording
	enableRecordingStatusUI : boolean If true then a recording status indicator will be provided in the folio viewer UI.	FolioActivityRecording

Class Detail

adobeDPS-FolioActivityRecording(recording:Object)

[inner] Create a FolioActivityRecording object.
This is an internal constructor and shouldn't be called by regular users.

An array of these instances is stored in the adobeDPS-FolioActivityService recordings field. This array is in time order, with the latest, current recording at index 0.

The JavaScript context is destroyed when switching between the custom web view slot and the library or folio viewing slots, but these objects persist, along with the activity history itself, across the activation and deactivation of the service. The most current recording must be examined whenever the JavaScript application initializes itself in order to pick up from where it left off.

The stateCode field is set to one of the states defined by the adobeDPS-FolioActivityRecordingStates object.

Parameters
recording	Object	The folio activity recording. This class is not directly instantiated by the application. Accessible from adobeDPS.folioActivityRecording

Field Details

stateCode : FolioActivityRecordingStates

The state code. One of RECORDING_STARTED, RECORDING_STOPPED, or RECORDING_STOPPED_BY_ERROR.

recordingId : String

The current recording identifier. This is set by startRecording(). All events recorded will be associated with this recording identifer until a new one is supplied.

eventsCount : Number

The number of events collected for the current recording so far.

errors : Array

A list of any errors generated on the native side since JavaScript service deactivation. These can't be immediately relayed to the JavaScript application, so they are cached for examination by the application when the JavaScript context is re-established.

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 true then a recording status indicator will be provided in the folio viewer UI.

Adobe DPS - Library and Store SDK 2.32

Class adobeDPS-FolioActivityRecording

Constructor

Fields