Package io.openems.backend.common.metadata

Interface AppCenterMetadata

All Known Subinterfaces:

AppCenterMetadata.EdgeData, AppCenterMetadata.UiData

All Known Implementing Classes:

MetadataOdoo

@ProviderType
public interface AppCenterMetadata

Nested Class Summary

Nested Classes

Modifier and Type	Interface	Description
static interface	AppCenterMetadata.EdgeData
static interface	AppCenterMetadata.UiData

Method Summary

Modifier and Type	Method	Description
com.google.gson.JsonArray	sendGetPossibleApps(String key, String edgeId)	Sends a request to get all apps that can be installed with the given key.
com.google.gson.JsonObject	sendIsKeyApplicable(String key, String edgeId, String appId)	Sends a request if the key can be applied to the given edge and app id.

Method Details

sendIsKeyApplicable

com.google.gson.JsonObject sendIsKeyApplicable(String key,
 String edgeId,
 String appId)
                                        throws OpenemsError.OpenemsNamedException

Sends a request if the key can be applied to the given edge and app id.

Parameters:

key - the key to be validated

edgeId - the edge the app gets installed

appId - the app that gets installed

Returns:

the result as a JsonObject

Throws:

OpenemsError.OpenemsNamedException - on error

sendGetPossibleApps

com.google.gson.JsonArray sendGetPossibleApps(String key,
 String edgeId)
                                       throws OpenemsError.OpenemsNamedException

Sends a request to get all apps that can be installed with the given key.

Parameters:

key - the apps of the key

edgeId - the apps on which edge

Returns:

the bundles and their apps

Throws:

OpenemsError.OpenemsNamedException - on error