de.espirit.firstspirit.client.plugin
Interface ClientPlugin

All Known Subinterfaces:

JavaClientPlugin

public interface ClientPlugin

Base interface for client plugins. Use inheritor interfaces via public hotspot to integrate client plugins.

Attention: This part of the API isn't released yet and may change during the ramp up time. It will be released with 4.2 Release 4.

Since:

4.2.416

Method Summary

<A extends ClientPluginAction<?>> List<A>	getActions(ClientPluginScope<A> scope) Returns a list of client plugin actions provided by this plugin for the given scope.
void	init(BaseContext context) Initialization called during initial application(client) start up.
void	tearDown() Called before application(client) tear down.

Method Detail

init

void init(BaseContext context)

Initialization called during initial application(client) start up.

Parameters:

context - the initial context

Since:

4.2.416

tearDown

void tearDown()

Called before application(client) tear down. Clean up resources.

Since:

4.2.416

getActions

@NotNull
<A extends ClientPluginAction<?>> List<A> getActions(ClientPluginScope<A> scope)

Returns a list of client plugin actions provided by this plugin for the given scope. Returns an empty list if the plugin doesn't provide any actions for the requested scope.

Parameters:

scope - the scope to get the client plugin actions for

Returns:

list of client plugin actions for the requested scope

Since:

4.2.434