Interface CustomPageSettingsManager

  • All Known Implementing Classes:
    DefaultCustomPageSettingsManager

    public interface CustomPageSettingsManager
    The CustomPageSettingsManager is used to retrieve and store custom page settings. Custom page settings are a feature migration of the features found in the Documentation Theme (ie page header/footers), which is to be deprecated soon.
    Since:
    5.9.0
    • Method Detail

      • retrieveSettings

        CustomPageSettings retrieveSettings​(String spaceKey)
        Parameters:
        spaceKey -
        Returns:
        CustomPageSettings
        Since:
        5.9.0
      • retrieveSettings

        CustomPageSettings retrieveSettings()
        Get the global settings for the Custom Page Settings
        Returns:
        CustomPageSettings
        Since:
        5.9.0
      • saveSettings

        void saveSettings​(String spaceKey,
                          CustomPageSettings settings)
        Parameters:
        spaceKey -
        settings -
        Since:
        5.9.0
      • saveSettings

        void saveSettings​(CustomPageSettings settings)
        Save the global settings for the Custom Page Settings
        Since:
        5.9.0