Package io.openems.backend.common.jsonrpc.request

Class SetUserAlertingConfigsRequest

java.lang.Object

io.openems.common.jsonrpc.base.JsonrpcMessage

io.openems.common.jsonrpc.base.AbstractJsonrpcRequest

io.openems.common.jsonrpc.base.JsonrpcRequest

io.openems.backend.common.jsonrpc.request.SetUserAlertingConfigsRequest

public class SetUserAlertingConfigsRequest
extends JsonrpcRequest

Represents a JSON-RPC Request for 'getEdgeConfig'.

 {
   "jsonrpc": "2.0",
   "id": "UUID",
   "method": "setUserAlertingConfigs",
   "params": {
     "edgeId": string,
      "userSettings": [
          {
           userId: string,
           delayTime": number
          }
      ]
   }
 

Field Summary

Fields

Modifier and Type	Field	Description
static final String	METHOD

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

DEFAULT_TIMEOUT_SECONDS, id, NO_TIMEOUT, timeoutOpt

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

JSONRPC_VERSION

Method Summary

Modifier and Type	Method	Description
static SetUserAlertingConfigsRequest	from(JsonrpcRequest request)	Create SetUserAlertingConfigsRequest from a template JsonrpcRequest.
String	getEdgeId()	Get the Edge-ID.
com.google.gson.JsonObject	getParams()	Gets the params JsonObject of the JsonrpcRequest.
List<AlertingSetting>	getUserSettings()	Get list of UserAlertingSetting.

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

getId, getTimeout, toJsonObject

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

getFullyQualifiedMethod, getMethod

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

from, from, toString

Methods inherited from class java.lang.Object

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

Field Details

METHOD

public static final String METHOD

See Also:

• Constant Field Values

Method Details

from

public static SetUserAlertingConfigsRequest from(JsonrpcRequest request)
                                          throws OpenemsError.OpenemsNamedException

Create SetUserAlertingConfigsRequest from a template JsonrpcRequest.

Parameters:

request - the template JsonrpcRequest

Returns:

the SetUserAlertingConfigsRequest

Throws:

OpenemsError.OpenemsNamedException - on parse error

getEdgeId

public String getEdgeId()

Get the Edge-ID.

Returns:

the Edge-ID

getUserSettings

public List<AlertingSetting> getUserSettings()

Get list of UserAlertingSetting.

Returns:

list of UserAlertingSetting

getParams

public com.google.gson.JsonObject getParams()

Description copied from class: AbstractJsonrpcRequest

Gets the params JsonObject of the JsonrpcRequest.

Specified by:

getParams in class AbstractJsonrpcRequest

Returns:

the params as JsonObject