Class SubscribeEdgesRequest
java.lang.Object
io.openems.common.jsonrpc.base.JsonrpcMessage
io.openems.common.jsonrpc.base.AbstractJsonrpcRequest
io.openems.common.jsonrpc.base.JsonrpcRequest
io.openems.common.jsonrpc.request.SubscribeEdgesRequest
Represents a JSON-RPC Request to subscribe to Edges.
This is used by UI to get regular updates on specific channels.
{ "jsonrpc": "2.0", "id": "UUID", "method": "subscribeEdges", "params": { "edges": string[] } }
-
Field Summary
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 TypeMethodDescriptionstatic SubscribeEdgesRequest
CreateSubscribeEdgesRequest
from a templateJsonrpcRequest
.getEdges()
Gets the set of Edges.com.google.gson.JsonObject
Gets the paramsJsonObject
of theJsonrpcRequest
.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 Details
-
METHOD
- See Also:
-
-
Method Details
-
from
public static SubscribeEdgesRequest from(JsonrpcRequest r) throws OpenemsError.OpenemsNamedException CreateSubscribeEdgesRequest
from a templateJsonrpcRequest
.- Parameters:
r
- the templateJsonrpcRequest
- Returns:
- the
SubscribeEdgesRequest
- Throws:
OpenemsError.OpenemsNamedException
- on parse error
-
getEdges
Gets the set of Edges.- Returns:
- the Edges
-
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
-