Interface ConfluenceRestClientThemesApi

@Generated("io.github.primelib.primecodegen") public interface ConfluenceRestClientThemesApi
ConfluenceRestClientThemesApi

  • Method Details

    • GetSettingsThemeV1

      ThemeArray GetSettingsThemeV1(@Nullable @Nullable Integer start, @Nullable @Nullable Integer limit)
      GetSettingsThemeV1 Get themes Returns all themes, not including the default theme. **[Permissions](https://confluence.atlassian.com/x/_AozKw) required**: None
      Parameters:
      start - The starting index of the returned themes.
      limit - The maximum number of themes to return per page. Note, this may be restricted by fixed system limits.

    • GetSettingsThemeSelectedV1

      Theme GetSettingsThemeSelectedV1()
      GetSettingsThemeSelectedV1 Get global theme Returns the globally assigned theme. **[Permissions](https://confluence.atlassian.com/x/_AozKw) required**: None

    • GetSettingsThemeByThemeKeyV1

      Theme GetSettingsThemeByThemeKeyV1(@NotNull @NotNull String themeKey)
      GetSettingsThemeByThemeKeyV1 Get theme Returns a theme. This includes information about the theme name, description, and icon. **[Permissions](https://confluence.atlassian.com/x/_AozKw) required**: None
      Parameters:
      themeKey - The key of the theme to be returned.

    • GetSpaceBySpaceKeyThemeV1

      Theme GetSpaceBySpaceKeyThemeV1(@NotNull @NotNull String spaceKey)
      GetSpaceBySpaceKeyThemeV1 Get space theme Returns the theme selected for a space, if one is set. If no space theme is set, this means that the space is inheriting the global look and feel settings. **[Permissions required](https://confluence.atlassian.com/x/_AozKw)**: ‘View’ permission for the space.
      Parameters:
      spaceKey - The key of the space to be queried for its theme.

    • PutSpaceBySpaceKeyThemeV1

      Theme PutSpaceBySpaceKeyThemeV1(@NotNull @NotNull String spaceKey, @NotNull @NotNull ThemeUpdate payload)
      PutSpaceBySpaceKeyThemeV1 Set space theme Sets the theme for a space. Note, if you want to reset the space theme to the default Confluence theme, use the 'Reset space theme' method instead of this method. **[Permissions](https://confluence.atlassian.com/x/_AozKw) required**: 'Admin' permission for the space.
      Parameters:
      spaceKey - The key of the space to set the theme for.
      payload -

    • DeleteSpaceBySpaceKeyThemeV1

      void DeleteSpaceBySpaceKeyThemeV1(@NotNull @NotNull String spaceKey)
      DeleteSpaceBySpaceKeyThemeV1 Reset space theme Resets the space theme. This means that the space will inherit the global look and feel settings **[Permissions](https://confluence.atlassian.com/x/_AozKw) required**: 'Admin' permission for the space.
      Parameters:
      spaceKey - The key of the space to reset the theme for.