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 java.lang.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
All Methods Static Methods Instance Methods Concrete Methods Modifier and Type Method Description static SetUserAlertingConfigsRequest
from(JsonrpcRequest request)
CreateSetUserAlertingConfigsRequest
from a templateJsonrpcRequest
.java.lang.String
getEdgeId()
Get the Edge-ID.com.google.gson.JsonObject
getParams()
Gets the paramsJsonObject
of theJsonrpcRequest
.java.util.List<AlertingSetting>
getUserSettings()
Get list ofUserAlertingSetting
.-
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
-
-
-
-
Field Detail
-
METHOD
public static final java.lang.String METHOD
- See Also:
- Constant Field Values
-
-
Method Detail
-
from
public static SetUserAlertingConfigsRequest from(JsonrpcRequest request) throws OpenemsError.OpenemsNamedException
CreateSetUserAlertingConfigsRequest
from a templateJsonrpcRequest
.- Parameters:
request
- the templateJsonrpcRequest
- Returns:
- the
SetUserAlertingConfigsRequest
- Throws:
OpenemsError.OpenemsNamedException
- on parse error
-
getEdgeId
public java.lang.String getEdgeId()
Get the Edge-ID.- Returns:
- the Edge-ID
-
getUserSettings
public java.util.List<AlertingSetting> getUserSettings()
Get list ofUserAlertingSetting
.- Returns:
- list of
UserAlertingSetting
-
getParams
public com.google.gson.JsonObject getParams()
Description copied from class:AbstractJsonrpcRequest
Gets the paramsJsonObject
of theJsonrpcRequest
.- Specified by:
getParams
in classAbstractJsonrpcRequest
- Returns:
- the params as
JsonObject
-
-