PersistentSettings

class PersistentSettings : PersistentStateComponent<Element> (source)

The persistent Settings instance, stored as an Element to allow custom conversion for backwards compatibility.

See also

Preferred method of accessing the persistent settings instance.

Constructors

Link copied to clipboard
constructor()

Types

Link copied to clipboard
object Companion

Holds constants.

Properties

Link copied to clipboard

The Settings that should be persisted.

Functions

Link copied to clipboard
open override fun getState(): Element

Returns the settings as an Element.

Link copied to clipboard
open override fun loadState(element: Element)

Deserializes element into a Settings instance, which is then stored in settings.

Link copied to clipboard
private fun upgrade(element: Element): Element

Silently upgrades the format of the settings contained in element to the format of the latest version.