Package io.openems.common.jsonrpc.request

Class AppCenterAddUnregisterKeyHistoryRequest

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

public class AppCenterAddUnregisterKeyHistoryRequest
extends JsonrpcRequest

Represents a JSON-RPC Request to unregister a registered key.

NOTE: in order to get this request handled by the backend the request needs to be wrapped in a AppCenterRequest.

This is used by UI.

 {
   "jsonrpc": "2.0",
   "id": "UUID",
   "method": "addUnregisterKeyHistory",
   "params": {
     "key": String,
     "appId": String
   }
 }
 

Field Summary

Fields

Modifier and Type	Field	Description
final String	appId
final String	key
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 final AppCenterAddUnregisterKeyHistoryRequest	from(JsonrpcRequest r)	Creates a AppCenterAddUnregisterKeyHistoryRequest from a JsonrpcRequest.
com.google.gson.JsonObject	getParams()	Gets the params JsonObject of the JsonrpcRequest.

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

key

public final String key

appId

public final String appId

Method Details

from

public static final AppCenterAddUnregisterKeyHistoryRequest from(JsonrpcRequest r)
                                                          throws OpenemsError.OpenemsNamedException

Creates a AppCenterAddUnregisterKeyHistoryRequest from a JsonrpcRequest.

Parameters:

r - the JsonrpcRequest

Returns:

a AppCenterAddUnregisterKeyHistoryRequest

Throws:

OpenemsError.OpenemsNamedException - on 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