colibrio-reader-framework/com.colibrio.readingsystem.base/PublicationStorageChangedEngineEventData

PublicationStorageChangedEngineEventData

class PublicationStorageChangedEngineEventData(val objectType: EngineEventDataObjectType = EngineEventDataObjectType.PUBLICATION_STORAGE_CHANGED_ENGINE_EVENT, val type: EngineEventDataType, val key: String?, val newValue: String?, val oldValue: String?, val readerDocumentIndexInSpine: Int?, val readerPublicationDefaultLocatorUrl: String, val storageAreaType: ReaderPublicationStorageAreaType) : EngineEventData

Constructors

constructor(objectType: EngineEventDataObjectType = EngineEventDataObjectType.PUBLICATION_STORAGE_CHANGED_ENGINE_EVENT, type: EngineEventDataType, key: String?, newValue: String?, oldValue: String?, readerDocumentIndexInSpine: Int?, readerPublicationDefaultLocatorUrl: String, storageAreaType: ReaderPublicationStorageAreaType)

Types

Companion

object Companion

Properties

key

val key: String?

A string with the key for the storage item that was changed. The key attribute is null when the change is caused by the storage clear() method.

newValue

val newValue: String?

A string with the new value of the storage item that was changed. This value is null when the change has been invoked by storage clear() method, or the storage item has been removed from the storage.

objectType

val objectType: EngineEventDataObjectType

The type of engine event object this JSON structure represents.

oldValue

val oldValue: String?

A string with the original value of the storage item that was changed. This value is null when the storage item has been newly added and therefore doesn't have any previous value.

readerDocumentIndexInSpine

val readerDocumentIndexInSpine: Int?

Represents the index of the ReaderDocument in the publication's spine where the storage change originated. If this property is null, the storage change was initiated by the application via the IReaderPublicationStorageArea API.

readerPublicationDefaultLocatorUrl

val readerPublicationDefaultLocatorUrl: String

The default Locator URL of the ReaderPublication instance associated with the storage change.

storageAreaType

val storageAreaType: ReaderPublicationStorageAreaType

The type of the affected storage area.

type

val type: EngineEventDataType

The type of event.

Functions

serialize

open override fun serialize(generator: JsonGenerator)