Class ThemesService

See

https://developer.atlassian.com/cloud/confluence/rest/v1/api-group-themes

Hierarchy

CommonHttpService
- ThemesService

Index

Constructors

constructor

Methods

getGlobalTheme getSpaceTheme getTheme getThemes resetSpaceTheme setSpaceTheme initialize

Constructors

constructor

new ThemesService(getClientInstance): ThemesService
Internal
Create a new instance of the service.
Parameters
- getClientInstance: (() => CommonHttpClient)
  - - (): CommonHttpClient
    - Returns CommonHttpClient
Returns ThemesService
Inherited from CommonHttpService.constructor

Methods

getGlobalTheme

getGlobalTheme(): Promise<Theme>
Returns the globally assigned theme.

Permissions required: None

Returns Promise<Theme>
Returned if the global theme is returned.

Path
GET /wiki/rest/api/settings/theme/selected @scopes-current manage:confluence-configuration @scopes-beta read:configuration:confluence

See
https://developer.atlassian.com/cloud/confluence/rest/v1/api-group-themes#api-wiki-rest-api-settings-theme-selected-get

getSpaceTheme

getSpaceTheme(params): Promise<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: ‘View’ permission for the space.
Parameters
- params: {
  spaceKey: string;
  }
  - spaceKey: string
    The key of the space to be queried for its theme.
Returns Promise<Theme>
Returned if the requested theme is returned.

Path
GET /wiki/rest/api/space/{spaceKey}/theme @scopes-current read:confluence-space.summary @scopes-beta read:space.setting:confluence

See
https://developer.atlassian.com/cloud/confluence/rest/v1/api-group-themes#api-wiki-rest-api-space-spacekey-theme-get

getTheme

getTheme(params): Promise<Theme>
Returns a theme. This includes information about the theme name, description, and icon.

Permissions required: None
Parameters
- params: {
  themeKey: string;
  }
  - themeKey: string
    The key of the theme to be returned.
Returns Promise<Theme>
Returned if the requested theme is returned.

Path
GET /wiki/rest/api/settings/theme/{themeKey} @scopes-current manage:confluence-configuration @scopes-beta read:configuration:confluence

See
https://developer.atlassian.com/cloud/confluence/rest/v1/api-group-themes#api-wiki-rest-api-settings-theme-themekey-get

getThemes

getThemes(params?): Promise<ThemeArray>
Returns all themes, not including the default theme.

Permissions required: None
Parameters
- params: {
  limit?: number;
  start?: number;
  } = {}
  - Optionallimit?: number
    The maximum number of themes to return per page. Note, this may be restricted by fixed system limits.
  - Optionalstart?: number
    The starting index of the returned themes.
Returns Promise<ThemeArray>
Returned if the requested themes are returned.

Path
GET /wiki/rest/api/settings/theme @scopes-current manage:confluence-configuration @scopes-beta read:configuration:confluence

See
https://developer.atlassian.com/cloud/confluence/rest/v1/api-group-themes#api-wiki-rest-api-settings-theme-get

resetSpaceTheme

resetSpaceTheme(params): Promise<void>
Resets the space theme. This means that the space will inherit the global look and feel settings

Permissions required: 'Admin' permission for the space.
Parameters
- params: {
  spaceKey: string;
  }
  - spaceKey: string
    The key of the space to reset the theme for.
Returns Promise<void>
Path
DELETE /wiki/rest/api/space/{spaceKey}/theme @scopes-current write:confluence-space @scopes-beta write:space.setting:confluence

See
https://developer.atlassian.com/cloud/confluence/rest/v1/api-group-themes#api-wiki-rest-api-space-spacekey-theme-delete

setSpaceTheme

setSpaceTheme(params): Promise<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 required: 'Admin' permission for the space.
Parameters
- params: {
  spaceKey: string;
  themeUpdate: ThemeUpdate;
  }
  - spaceKey: string
    The key of the space to set the theme for.
  - themeUpdate: ThemeUpdate
Returns Promise<Theme>
Returned if the theme was set for the space.

Path
PUT /wiki/rest/api/space/{spaceKey}/theme @scopes-current write:confluence-space @scopes-beta read:space.setting:confluence, write:space.setting:confluence

See
https://developer.atlassian.com/cloud/confluence/rest/v1/api-group-themes#api-wiki-rest-api-space-spacekey-theme-put

`Protected` `Static`initialize

initialize(): void
Method to initialize the class. Normally used to set up validation rules.

Returns void
Overrides CommonHttpService.initialize

Class ThemesService

See

Hierarchy

Index

Constructors

Methods

Constructors

constructor

Parameters

Returns CommonHttpClient

Returns ThemesService

Methods

getGlobalTheme

Returns Promise<Theme>

Path

See

getSpaceTheme

Parameters

spaceKey: string

Returns Promise<Theme>

Path

See

getTheme

Parameters

themeKey: string

Returns Promise<Theme>

Path

See

getThemes

Parameters

Optionallimit?: number

Optionalstart?: number

Returns Promise<ThemeArray>

Path

See

resetSpaceTheme

Parameters

spaceKey: string

Returns Promise<void>

Path

See

setSpaceTheme

Parameters

spaceKey: string

themeUpdate: ThemeUpdate

Returns Promise<Theme>

Path

See

Protected Staticinitialize

Returns void

Settings

On This Page

`Optional`limit?: number

`Optional`start?: number

`Protected` `Static`initialize