Era.Common.DataDefinition.Security.ConsoleUserState

Description

Holds webconsole user state.

Properties

Name	JsonSchemaType	Description
consoleTimeZoneDayLightSaving	boolean	If true, the day light saving offset is added to consoleTimeZoneOffsetMinutes. In that case, consoleTimeZoneOffsetMinutes has to be set, otherwise consoleTimeZoneDayLightSaving should be ignored.
consoleTimeZoneOffsetMinutes	integer	The console displays all times (if not stated otherwise) with this offset. Browser's local time if not set. The offset is positive for east, negative for west.
locale	string	TODO not used, remove.
rememberedUIState	array of references to Era.Common.DataDefinition.Security.ConsoleUserState_KeyValuePair	Used by individual console components to store their state.

Dual message (request/response)

No dual message.

Referenced in messages

Era.Common.NetworkMessage.ConsoleApi.Security.RpcGetUserStateResponse
Era.Common.NetworkMessage.ConsoleApi.Security.RpcSetUserStateRequest

JsonSchema

{
    "title": "Era.Common.DataDefinition.Security.ConsoleUserState",
    "type": "object",
    "$schema": "http://json-schema.org/draft-04/schema#",
    "additionalProperties": false,
    "required": [
        "Era.Common.DataDefinition.Security.ConsoleUserState"
    ],
    "properties": {
        "Era.Common.DataDefinition.Security.ConsoleUserState": {
            "$ref": "#/definitions/ConsoleUserState"
        }
    },
    "definitions": {
        "ConsoleUserState": {
            "additionalProperties": false,
            "required": [
                "locale"
            ],
            "type": "object",
            "properties": {
                "consoleTimeZoneDayLightSaving": {
                    "type": "boolean"
                },
                "consoleTimeZoneOffsetMinutes": {
                    "type": "integer"
                },
                "locale": {
                    "type": "string"
                },
                "rememberedUIState": {
                    "type": "array",
                    "items": [
                        {
                            "$ref": "Era.Common.DataDefinition.Security.ConsoleUserState_KeyValuePair#/definitions/ConsoleUserState_KeyValuePair"
                        }
                    ]
                }
            }
        }
    }
}