Package io.github.primelib.confluence4j.rest.v1.client

Class ConfluenceRestClientThemesConsumerApi

java.lang.Object
io.github.primelib.confluence4j.rest.v1.client.ConfluenceRestClientThemesConsumerApi
@Generated("io.github.primelib.primecodegen") public class ConfluenceRestClientThemesConsumerApi extends Object
ConfluenceRestClientThemesConsumerApi

  • Constructor Details

  • Method Details

    • GetSettingsThemeV1

      public ThemeArray GetSettingsThemeV1(Consumer<GetSettingsThemeV1OperationSpec> spec)
      GetSettingsThemeV1 Get themes Returns all themes, not including the default theme. **[Permissions](https://confluence.atlassian.com/x/_AozKw) required**: None
      Parameters:
      spec - a consumer that creates the payload for this operation. Supports the following properties:
      • 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

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

    • GetSettingsThemeByThemeKeyV1

      public Theme GetSettingsThemeByThemeKeyV1(Consumer<GetSettingsThemeByThemeKeyV1OperationSpec> spec)
      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:
      spec - a consumer that creates the payload for this operation. Supports the following properties:
      • themeKey: The key of the theme to be returned.

    • GetSpaceBySpaceKeyThemeV1

      public Theme GetSpaceBySpaceKeyThemeV1(Consumer<GetSpaceBySpaceKeyThemeV1OperationSpec> spec)
      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:
      spec - a consumer that creates the payload for this operation. Supports the following properties:
      • spaceKey: The key of the space to be queried for its theme.

    • PutSpaceBySpaceKeyThemeV1

      public Theme PutSpaceBySpaceKeyThemeV1(Consumer<PutSpaceBySpaceKeyThemeV1OperationSpec> spec)
      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:
      spec - a consumer that creates the payload for this operation. Supports the following properties:
      • spaceKey: The key of the space to set the theme for.
      • payload:

    • DeleteSpaceBySpaceKeyThemeV1

      public void DeleteSpaceBySpaceKeyThemeV1(Consumer<DeleteSpaceBySpaceKeyThemeV1OperationSpec> spec)
      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:
      spec - a consumer that creates the payload for this operation. Supports the following properties:
      • spaceKey: The key of the space to reset the theme for.