JsonrpcResponseSuccess (OpenEMS Javadoc)

java.lang.Object
- io.openems.common.jsonrpc.base.JsonrpcMessage
- - io.openems.common.jsonrpc.base.JsonrpcResponse
  - - io.openems.common.jsonrpc.base.JsonrpcResponseSuccess

Direct Known Subclasses:

AddAppInstance.Response, AddEdgeToUserResponse, AuthenticatedRpcResponse, AuthenticateResponse, Base64PayloadResponse, DeleteAppInstance.Response, EdgeRpcResponse, ExecuteSimulationResponse, ExecuteSystemCommandResponse, GenericJsonrpcResponseSuccess, Get24HoursPredictionResponse, GetApp.Response, GetAppAssistant.Response, GetAppDescriptor.Response, GetAppInstances.Response, GetApps.Response, GetDeviceResponse, GetEdgeConfigResponse, GetEdgesChannelsValuesResponse, GetEdgesStatusResponse, GetFieldNamesResponse, GetMetersResponse, GetModbusProtocolResponse, GetNetworkConfigResponse, GetSystemUpdateStateResponse, GetUserAlertingConfigsResponse, GetUserInformationResponse, QueryHistoricTimeseriesDataResponse, QueryHistoricTimeseriesEnergyPerPeriodResponse, QueryHistoricTimeseriesEnergyResponse, UpdateAppInstance.Response
```
public abstract class JsonrpcResponseSuccess
extends JsonrpcResponse
```
Represents a JSON-RPC Success Response.
```
 {
   "jsonrpc": "2.0",
   "id": "UUID",
   "result": {}
 }
 
```
See Also:

JSON-RPC specification

Field Summary
- Fields inherited from class io.openems.common.jsonrpc.base.JsonrpcMessage
  JSONRPC_VERSION

Constructor Summary

Constructors
Constructor Description

JsonrpcResponseSuccess(java.util.UUID id)

Method Summary

All Methods Static Methods Instance Methods Abstract Methods Concrete Methods
Modifier and Type	Method	Description
`static JsonrpcResponseSuccess`	`from(com.google.gson.JsonObject j)`	Parses the JSON-Object to a JSON-RPC Success Response.
`abstract com.google.gson.JsonObject`	`getResult()`	Gets the result of this `JsonrpcResponseSuccess`.
`com.google.gson.JsonObject`	`toJsonObject()`	Gets the `JsonObject` representation of this `JsonrpcMessage`.

Methods inherited from class io.openems.common.jsonrpc.base.JsonrpcResponse
from, getId

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

Methods inherited from class java.lang.Object
clone, equals, finalize, getClass, hashCode, notify, notifyAll, wait, wait, wait

- Constructor Detail
  - JsonrpcResponseSuccess
```
public JsonrpcResponseSuccess(java.util.UUID id)
```
- Method Detail
  - from
```
public static JsonrpcResponseSuccess from(com.google.gson.JsonObject j)
                                   throws OpenemsError.OpenemsNamedException
```
    Parses the JSON-Object to a JSON-RPC Success Response.
    
    Parameters:
    
    j - the JSON-Object
    
    Returns:
    
    the JSON-RPC Success Response
    
    Throws:
    
    OpenemsError.OpenemsNamedException - if it was not a Success Response
  - toJsonObject
```
public com.google.gson.JsonObject toJsonObject()
```
    Description copied from class: JsonrpcMessage
    
    Gets the JsonObject representation of this JsonrpcMessage.
    
    Overrides:
    
    toJsonObject in class JsonrpcResponse
    
    Returns:
    
    a JsonObject
  - getResult
```
public abstract com.google.gson.JsonObject getResult()
```
    Gets the result of this JsonrpcResponseSuccess.
    
    Returns:
    
    a JsonObject with the 'result' property of the response