Package io.meeds.commons.digest.plugin

Interface DigestCategoryProvider

All Known Implementing Classes:
DigestCategoryPlugin
public interface DigestCategoryProvider
Each addon contributes the digest categories it owns by declaring a bean of this type. The registered providers are the single source of truth for the categories the user can choose, and for the notification types each category covers. When an addon is not installed, its category simply does not exist.

  • Method Details

    • getId

      String getId()
      Returns:
      the category identifier, stored in the user settings and in the waiting digest items, for example "spaces"

    • getLabelKey

      String getLabelKey()
      Returns:
      the resource bundle key of the category label, displayed to the user

    • getOrder

      int getOrder()
      Returns:
      the display order of the category, in the settings panel and in the digest email

    • getPluginIds

      List<String> getPluginIds()
      Returns:
      the identifiers of the notification plugins this category covers, for example SpaceInvitationPlugin