Options
All
  • Public
  • Public/Protected
  • All
Menu

Interface IReaderPublicationStorageArea

Provides access to the localStorage or sessionStorage used by scripted content documents.

Hierarchy

  • IReaderPublicationStorageArea

Index

Methods

Methods

clear

  • clear(): void

  • Remove all items from this storage area.

    Returns void

getItem

  • getItem(key: string): string

  • Get the value for the specified key, or null if the key does not exist in this storage area.

    Parameters

    • key: string

    Returns string

getItems

  • getItems(): [string, string][]

  • Get all items in this storage area as an array of key-value pairs.

    Returns [string, string][]

getType

removeItem

  • removeItem(key: string): void

  • Remove the key from the storage if it exists.

    If there is no item associated with the key, this method does nothing.

    Parameters

    • key: string

    Returns void

setItem

  • setItem(key: string, value: string): void

  • Add the key to the storage, or update that key's value if it already exists.

    Parameters

    • key: string
    • value: string

    Returns void

setItems

  • setItems(items: [string, string][], emitStorageChangedEngineEvent: boolean): void

  • Adds or updates the items in this storage from the provided list of key-value pairs.

    The boolean option emitStorageChangedEngineEvent controls if publicationStorageChanged EngineEvents should be emitted for each item.

    Parameters

    • items: [string, string][]
    • emitStorageChangedEngineEvent: boolean

    Returns void

Generated using TypeDoc