wow-view-store-api/me.ahoo.wow.viewstore.api.preferences

Package-level declarations

Types

@Summary(value = "Set the view preferences of a definition")

@CommandRoute(enabled = false)

data class SetViewPreferences(val definitionId: String, val order: List<String> = emptyList(), val defaultInstanceId: String? = null, val autoRun: Boolean? = null, val lastTabs: Map<String, String>? = null)

Sets one owner's preferences for one definition. The preferences' id is derived on the server from the owner, the application and the definition, so this command has no generated route: the view store's preferences route dispatches it. The expected version 0 is "never written".

ViewPreferencesInput

data class ViewPreferencesInput(val order: List<String> = emptyList(), val defaultInstanceId: String? = null, val autoRun: Boolean? = null, val lastTabs: Map<String, String>? = null)

The body of the preferences route's PUT: the definition is the path's, the owner and the application the request's.

ViewPreferencesSet

data class ViewPreferencesSet(val definitionId: String, val appId: String, val order: List<String>, val defaultInstanceId: String?, val autoRun: Boolean?, val lastTabs: Map<String, String>?)

ViewPreferencesView

data class ViewPreferencesView(val definitionId: String, val order: List<String> = emptyList(), val defaultInstanceId: String? = null, val autoRun: Boolean? = null, val lastTabs: Map<String, String>? = null, val version: Int = 0)

One owner's preferences for one definition, as the preferences route answers them. version is the revision: 0 for preferences never written.