Colibrio Reader Framework API - Cloud license
    Preparing search index...

    Interface IPublicationStorageChangedEngineEventData

    interface IPublicationStorageChangedEngineEventData {
        cancelable: boolean;
        defaultPrevented: boolean;
        immediatePropagationStopped: boolean;
        isTrusted: boolean;
        key: string;
        newValue: string;
        objectType: EngineEventDataObjectType;
        oldValue: string;
        propagationStopped: boolean;
        readerDocumentIndexInSpine: number;
        readerPublicationDefaultLocatorUrl: string;
        readerViewName: string;
        storageAreaType: ReaderPublicationStorageAreaType;
        type: keyof IEngineEventTypeMap;
    }

    Hierarchy (View Summary)

    Properties

    cancelable: boolean

    IF this event's default action is cancelable. See respective engine event for its definition of default action.

    defaultPrevented: boolean

    If this event's default action has been canceled/prevented by a call to preventDefault()

    immediatePropagationStopped: boolean

    True if stopImmediatePropagation() was called on this event.

    isTrusted: boolean

    If this event runs in a "trusted" context, i.e. the event callback is executed during a user-generated event such as "click" or "pointerdown".

    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: 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: EngineEventDataObjectType

    The type of engine event object this JSON structure represents.

    PUBLICATION_STORAGE_CHANGED_ENGINE_EVENT
    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.

    propagationStopped: boolean

    True if stopPropagation() was called on this event.

    readerDocumentIndexInSpine: number

    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: string

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

    readerViewName: string

    The name of the ReaderView this event is related to, if any.

    storageAreaType: ReaderPublicationStorageAreaType

    The type of the affected storage area.

    type: keyof IEngineEventTypeMap

    The type of event.

    Properties