Class GetApps
java.lang.Object
io.openems.edge.core.appmanager.jsonrpc.GetApps
- All Implemented Interfaces:
EndpointRequestType<GetApps.Request,
GetApps.Response>
public class GetApps
extends Object
implements EndpointRequestType<GetApps.Request,GetApps.Response>
Gets the available
OpenemsApp
s.
Request:
{ "jsonrpc": "2.0", "id": "UUID", "method": "getApps", "params": {} }
Response:
{ "jsonrpc": "2.0", "id": "UUID", "result": { apps: [{ "categorys": [{ "name": string (OpenemsAppCategory enum), "readableName": string }], "cardinality": string (OpenemsAppUsage enum), "appId": string, "name": string, "status": { "status": string (OpenemsAppStatus enum), "errorCompatibleMessages": string[], "errorInstallableMessages": string[] }, "image": string (base64), "instanceIds": UUID[], }] } }
-
Nested Class Summary
Nested ClassesModifier and TypeClassDescriptionstatic final record
static final record
-
Constructor Summary
Constructors -
Method Summary
Modifier and TypeMethodDescriptionGets the name of the request method.Gets theJsonSerializer
for the request.Gets theJsonSerializer
for the response.
-
Constructor Details
-
GetApps
public GetApps()
-
-
Method Details
-
getMethod
Description copied from interface:EndpointRequestType
Gets the name of the request method.- Specified by:
getMethod
in interfaceEndpointRequestType<GetApps.Request,
GetApps.Response> - Returns:
- the method name
-
getRequestSerializer
Description copied from interface:EndpointRequestType
Gets theJsonSerializer
for the request. Used to convert the received json into a java object.- Specified by:
getRequestSerializer
in interfaceEndpointRequestType<GetApps.Request,
GetApps.Response> - Returns:
- the request
JsonSerializer
-
getResponseSerializer
Description copied from interface:EndpointRequestType
Gets theJsonSerializer
for the response. Used to convert the response java object into a json string.- Specified by:
getResponseSerializer
in interfaceEndpointRequestType<GetApps.Request,
GetApps.Response> - Returns:
- the response
JsonSerializer
-