Package ru.easydonate.easydonate4j.api.v3.data.model.plugin

Interface Plugin

All Known Implementing Classes:

AbstractPlugin, CustomMessagesPlugin, DiscordWidgetPlugin, LastPaymentsPlugin, SurchargePlugin, VKCommunityWidgetPlugin, VKMessagesWidgetPlugin, VKNewsPlugin, YandexMetrikaPlugin

public interface Plugin

The interface that represents a platform plugin for a shop.
Everyone plugin has own implementation of this interface.

Author:

soknight

Method Summary

Modifier and Type	Method	Description
@NotNull EasyDonateClient	getClient()	Get the API client instance that will be used for data requests.
@NotNull PluginType	getPluginType()	Get the type of this plugin.
@NotNull PluginSettings	getSettings()	Request the plugin settings from the remote API server.

Method Detail

getClient

@NotNull
@NotNull EasyDonateClient getClient()

Get the API client instance that will be used for data requests.

Returns:

The API client instance.

getPluginType

@NotNull
@NotNull PluginType getPluginType()

Get the type of this plugin.

Returns:

The plugin type.

See Also:

PluginType

getSettings

@NotNull
@NotNull PluginSettings getSettings()
                             throws HttpRequestException,
                                    HttpResponseException

Request the plugin settings from the remote API server.

Returns:

The actual plugin settings.

Throws:

HttpRequestException - when any errors with request sending has occured.

HttpResponseException - when any errors with response handling has occured.

See Also:

PluginSettings