Package io.openems.backend.common.jsonrpc.response

Class GetUserAlertingConfigsResponse

java.lang.Object

io.openems.common.jsonrpc.base.JsonrpcMessage

io.openems.common.jsonrpc.base.JsonrpcResponse

io.openems.common.jsonrpc.base.JsonrpcResponseSuccess

io.openems.backend.common.jsonrpc.response.GetUserAlertingConfigsResponse

public class GetUserAlertingConfigsResponse
extends JsonrpcResponseSuccess

Represents a JSON-RPC Response for 'getAlertingConfig'.

 {
   "jsonrpc": "2.0",
   "id": "UUID",
   "result": {
      "currentUserSettings": {
           "userLogin": "string",
           "faultEdgeDelay": "number",
           "offlineEdgeDelay": "number",
           "warningEdgeDelay": "number"
          }
      "otherUsersSettings?": [
          {
           "userLogin": "string",
           "faultEdgeDelay": "number",
           "offlineEdgeDelay": "number",
           "warningEdgeDelay": "number"
          }
      ]
   }
 }
 

Field Summary

Fields inherited from class io.openems.common.jsonrpc.base.JsonrpcMessage

JSONRPC_VERSION

Constructor Summary

Constructors

Constructor	Description
GetUserAlertingConfigsResponse(UUID id, UserAlertingSettings currentUserSettings, List<UserAlertingSettings> otherUsersSettings)

Method Summary

Modifier and Type	Method	Description
com.google.gson.JsonObject	getResult()	Gets the result of this JsonrpcResponseSuccess.

Methods inherited from class io.openems.common.jsonrpc.base.JsonrpcResponseSuccess

from, toJsonObject

Methods inherited from class io.openems.common.jsonrpc.base.JsonrpcResponse

from, getId

Methods inherited from class io.openems.common.jsonrpc.base.JsonrpcMessage

toString

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, wait, wait, wait

Constructor Details

GetUserAlertingConfigsResponse

public GetUserAlertingConfigsResponse(UUID id,
 UserAlertingSettings currentUserSettings,
 List<UserAlertingSettings> otherUsersSettings)

Method Details

getResult

public com.google.gson.JsonObject getResult()

Description copied from class: JsonrpcResponseSuccess

Gets the result of this JsonrpcResponseSuccess.

Specified by:

getResult in class JsonrpcResponseSuccess

Returns:

a JsonObject with the 'result' property of the response