Package io.meeds.social.navigation.plugin

Interface SidebarPlugin

public interface SidebarPlugin

A class to allow managing Sidebar item types

Field Summary

Fields

Modifier and Type	Field	Description
static final SidebarItem	SIDEBAR_SEPARATOR

Method Summary

Modifier and Type	Method	Description
default List<SidebarItem>	getDefaultItems()
default SidebarItemType	getType()
default boolean	itemExists(SidebarItem item, String username)
default SidebarItem	resolveProperties(SidebarItem item, String username, Locale locale)	Resolves Item Name and Icon when storage is maintained

Field Details

SIDEBAR_SEPARATOR

static final SidebarItem SIDEBAR_SEPARATOR

Method Details

getType

default SidebarItemType getType()

Returns:

SidebarItemType managed by the implementing plugin

resolveProperties

default SidebarItem resolveProperties(SidebarItem item,
 String username,
 Locale locale)

Resolves Item Name and Icon when storage is maintained

Parameters:

item -

username -

locale -

getDefaultItems

default List<SidebarItem> getDefaultItems()

Returns:

List of SidebarItem to inject on startup

itemExists

default boolean itemExists(SidebarItem item,
 String username)

Parameters:

item - SidebarItem

username - User name

Returns:

true if the item exists and the user has access to it, else false