avail/avail.anvil.settings/Settings

Settings

sealed class Settings : JSONFriendly

The abstract parent type of all user-editable Anvil settings.

NOTE All implementations of Settings are expected to use their companion objects act as its associated SettingsType by having the companion object extend SettingsType.

Author

Richard Arriaga

Inheritors

ShortcutSettings

Types

Companion

object Companion

Properties

jsonFormattedString

open val jsonFormattedString: String

jsonPrettyPrintedFormattedString

open val jsonPrettyPrintedFormattedString: String

type

val type: SettingsType<*>

The associated SettingsType. This is expected to be the companion object of the implemented subtype.

writeSettingsAction

abstract val writeSettingsAction: JSONWriter.() -> Unit

The JSONWriter action that writes the data contained in these Settings to the JSONWriter.

Functions

saveToDisk

fun saveToDisk(file: File)

Save this ShortcutSettings to the provided file.

writeTo

override fun writeTo(writer: JSONWriter)