Package discord4j.common.store.api.layout

Interface StoreLayout

All Known Implementing Classes:

LegacyStoreLayout, LocalStoreLayout

public interface StoreLayout

A StoreLayout defines how store actions should be handled according to their type. It enforces an implementation for a minimal set of actions required by Discord4J, and enables the declaration of custom action types.

Method Summary

Modifier and Type	Method	Description
default ActionMapper	getCustomActionMapper()	Defines a mapping for custom action types.
DataAccessor	getDataAccessor()	Returns a DataAccessor that defines action handlers for reading data from the store.
GatewayDataUpdater	getGatewayDataUpdater()	Returns a GatewayDataUpdater that defines action handlers for updates received from the Discord gateway.

Method Details

getDataAccessor

DataAccessor getDataAccessor()

Returns a DataAccessor that defines action handlers for reading data from the store.

Returns:

a DataAccessor

getGatewayDataUpdater

GatewayDataUpdater getGatewayDataUpdater()

Returns a GatewayDataUpdater that defines action handlers for updates received from the Discord gateway.

Returns:

a GatewayDataUpdater

getCustomActionMapper

default ActionMapper getCustomActionMapper()

Defines a mapping for custom action types. By default returns an empty ActionMapper, implementations may override this method to supply custom mappings.

Returns:

an ActionMapper