Class adobeDPS-FolioActivityService

Extends:: adobeDPS-FolioActivityService -> adobeDPS-Service -> adobeDPS-Class
Platforms:: iOS, Windows

This class defines the service to monitor folio activity events.
Accessible from adobeDPS.folioActivityService

Constructor

adobeDPS-FolioActivityService()

[inner] Create an instance of the FolioActivityService.

Static Fields

	Field	Defined By
	adobeDPS-FolioActivityService.instance The singleton of the FolioActivityService.	FolioActivityService

Fields

	Field	Defined By
	supportedEventNames : Array The supported event names.	FolioActivityService
	supportedEventAttributes : Array The supported event attributes.	FolioActivityService
	currentRecordingId : String The current recording identfier.	FolioActivityService
	recordings : Array The array of active recordings in the form of adobeDPS-FolioActivityRecording objects.	FolioActivityService
	stateChangedSignal : Signal The signal used to indicate that the recording service state has changed.	FolioActivityService
	FolioActivityRecordingStates : Object The supported recording states as an enum object.	FolioActivityService
	FolioActivityErrorCodes : Object The supported error codes as an enum object.	FolioActivityService

Methods

	Method	Defined By
	startRecording(recordingId:String, config:FolioActivityConfig, successCB:Function, errorCB:Function) Initiates recording of user-generated folio events.	FolioActivityService
	stopRecording(successCB:Function, errorCB:Function) Function used to stop folio events recording for the current recording identifier.	FolioActivityService
	getEvents(recordingId:String, successCB:Function, errorCB:Function) Function used to retrieve the recorded events from the persistent storage for a given recording identifier.	FolioActivityService
	deleteEvents(recordingId:String, successCB:Function, errorCB:Function) Releases all activity history associated with the specified recording identifier from the persistent store.	FolioActivityService
	resetService(successCB:Function, errorCB:Function) Resets the state of FolioActivityService to initial conditions.	FolioActivityService
	toString() Gets the string representation of this instance.	Class

Class Detail

adobeDPS-FolioActivityService()

[inner] Create an instance of the FolioActivityService.
This is an internal constructor and shouldn't be called by regular users.

Static Field Details

adobeDPS-FolioActivityService.instance

The singleton of the FolioActivityService.

Platforms:: iOS, Windows

Field Details

supportedEventNames : Array

The supported event names. These are strings that can be used to filter for desired events by setting the eventsFilter field in adobeDPS-FolioActivityConfig.

The supported event names are:

Issue Download Started
Issue Download Completed
Issue Download Terminal Error
Issue Download Cancelled
Content View
Content Browse
AD View
Edit view
Overlay Started
Overlay Stopped
URL clicks
Social Content Share
End of article reached
Custom Event 1
Custom Event 2
Custom Event 3
Custom Event 4
Custom Event 5
Custom Event 6
Custom Event 7
Custom Event 8
Custom Event 9
Custom Event 10

supportedEventAttributes : Array

The supported event attributes. These are the keys (as strings) that will be present in the event objects return by getEvents(). If the attribute is not present then its value will be an empty string.

The supported event attributes are:

eventName
eventTime
appVersion
publicationId
issueId
stackId
screenId
contentTitle
overlayId
overlayType
networkStatus
deviceOrientation
issueName
adStackTitle
contentType
articleStackTitle
entitlementCategory
downloadError
downloadState
sharingMode
appStore
pushToken
viewerVersion
url
urlDestination
viewerType
findMethod
subscriberId
subscriberType
startupSource
engagementType
pushNotificationId
customVariable1
customVariable2
customVariable3
customVariable4
customVariable5
customVariable6
customVariable7
customVariable8
customVariable9
customVariable10

currentRecordingId : String

The current recording identfier. This is set to the recording in progress (started) or to the last known recording if it was stopped by app shutdown. It is always set to the last known recording identifier from the native side when the JavaScript service is initialized. The recording represented by this identifier is always part of the recordings array if the identifier is valid.

recordings : Array

The array of active recordings in the form of adobeDPS-FolioActivityRecording objects. This represents the history of recordings that still have events associated with them (eventsCount > 0). It contains previous non-empty recordings plus the current recording (started) in descending chronological order. Thus the first element in the array is the last recording (currently started or last stopped).

stateChangedSignal : Signal

The signal used to indicate that the recording service state has changed. The state changes in response to updates to any of the recording objects in the recordings field or currentRecordingId field.

This can be as a result of calling startRecording(), stopRecording(), deleteEvents(), and any errors they generate. An application may register a handler for this signal in order to track the state of the recording.

FolioActivityRecordingStates : Object

The supported recording states as an enum object.

FolioActivityErrorCodes : Object

The supported error codes as an enum object.

Method Details

startRecording(recordingId:String, config:FolioActivityConfig, successCB:Function, errorCB:Function)

Initiates recording of user-generated folio events. The specified recording identifier is associated with all subsequently generated events. The events and associated identifier are recorded in persistent non-encrypted storage.

If an event filter is not supplied in the config parameter or the events filter is an empty array, then all events are recorded; otherwise, only the event names in the filter are recorded.

Only one active recording is permitted. If startRecording() is called while a recording is in progress an error will be returned to the error handler with the code FolioActivityErrorCodes.RECORDING_ALREADY_STARTED.

The recordingId must be a valid non-empty JavaScript string of no more than 64 printable characters. The special characters \' \" \\ \n \r \t \b \f are not allowed in the recording identifier.

Parameters
recordingId	String	The recording identifier under which the events are stored.
config	FolioActivityConfig	The recording configuration. See adobeDPS-FolioActivityConfig
successCB	Function	The callback function that handles the success of the request. Callback Signature: successCB()
errorCB	Function	The callback function that handles the error when request fails. Callback Signature: errorCB({recordingId: String, error: Object})

Throws:: Error If the errorCB is invalid
Platforms:: iOS, Windows

stopRecording(successCB:Function, errorCB:Function)

Function used to stop folio events recording for the current recording identifier. If stopRecording() is called before any recording is started an error will be returned to the error handler with the code FolioActivityErrorCodes.RECORDING_NOT_STARTED.

Parameters
successCB	Function	The callback function that handles the success of the request. Callback Signature: successCB()
errorCB	Function	The callback function that handles the error when request fails. Callback Signature: errorCB({recordingId: String, error: Object})

Throws:: Error If the errorCB is invalid
Platforms:: iOS, Windows

getEvents(recordingId:String, successCB:Function, errorCB:Function)

Function used to retrieve the recorded events from the persistent storage for a given recording identifier. successCB() is called with an array of all currently recorded events that match the given recordingId.

This does not delete the events from the storage. In order to delete them from the storage deleteEvents() must be called.

The recordingId must be a valid non-empty JavaScript string of no more than 64 characters; otherwise an error is generated. The special characters \' \" \\ \n \r \t \b \f are not allowed in the recording identifier.

Parameters
recordingId	String	The recording identifier the events are requested for.
successCB	Function	The callback function that handles the success of the request. Callback Signature: successCB({recordingId: String, events: Array of {attribute: value}) where attribute takes values from the supportedEventAttributes array. The eventName and eventTime attributes are mandatory and will be always present; the eventTime attribute is represented as a string in ISO-8601 format with a 0 time zone offset (UTC). The value takes string values specific to the attribute. The values for eventName attribute are from the supportedEventNames array.
errorCB	Function	The callback function that handles the error when request fails. Callback Signature: errorCB({recordingId: String, error: Object})

Throws:: Error If the errorCB is invalid
Platforms:: iOS, Windows

deleteEvents(recordingId:String, successCB:Function, errorCB:Function)

Releases all activity history associated with the specified recording identifier from the persistent store. The recordingId string may be undefined or empty to completely delete the entire activity history for all recording identifiers, reducing the size of the activity history to zero.

Parameters
recordingId	String	The recording identifier the events are requested for.
successCB	Function	The callback function that handles the success of the request. Callback Signature: successCB(recordingId)
errorCB	Function	The callback function that handles the error if the request fails. Callback Signature: errorCB({recordingId: String, error: Object})

Throws:: Error If the errorCB is invalid
Platforms:: iOS, Windows

resetService(successCB:Function, errorCB:Function)

Resets the state of FolioActivityService to initial conditions. All persistent storage used by FolioActivityService – including the entire activity history, recording state, and error state – is deleted and reset to an empty state. Any recording in progress is stopped.

Calling this method should not normally be needed, but it may be useful during application development, or if storage I/O errors or other external problems affect the stability or integrity of the persistent storage.

Parameters
successCB	Function	The callback function that handles the success of the request. Callback Signature: successCB()
errorCB	Function	The callback function that handles the error if the request fails. Callback Signature: errorCB({recordingId: String, error: Object})

Throws:: Error If the errorCB is invalid
Platforms:: iOS, Windows

Adobe DPS - Library and Store SDK 2.32

Class adobeDPS-FolioActivityService

Constructor

Static Fields

Fields

Methods