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

Class AddEdgeToUserRequest

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.AddEdgeToUserRequest

public class AddEdgeToUserRequest
extends JsonrpcRequest

Adds a Edge to a User.

 {
   "jsonrpc": "2.0",
   "id": UUID,
   "method": "addEdgeToUser",
   "params": {
      "setupPassword": string
   }
 }
 

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

Constructor Summary

Constructors

Constructor	Description
AddEdgeToUserRequest(String setupPassword)

Method Summary

Modifier and Type	Method	Description
static AddEdgeToUserRequest	from(JsonrpcRequest r)	Create AddEdgeToUserRequest from a template JsonrpcRequest.
com.google.gson.JsonObject	getParams()	Gets the params JsonObject of the JsonrpcRequest.
String	getSetupPassword()

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

Constructor Details

AddEdgeToUserRequest

public AddEdgeToUserRequest(String setupPassword)

Method Details

from

public static AddEdgeToUserRequest from(JsonrpcRequest r)
                                 throws OpenemsError.OpenemsNamedException

Create AddEdgeToUserRequest from a template JsonrpcRequest.

Parameters:

r - the template JsonrpcRequest

Returns:

the AddEdgeToUserRequest

Throws:

OpenemsError.OpenemsNamedException - on parse error

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

getSetupPassword

public String getSetupPassword()