Class Themes

Index

Constructors

constructor

Methods

getGlobalTheme getSpaceTheme getTheme getThemes resetSpaceTheme setSpaceTheme

Constructors

constructor

new Themes(client: Client): Themes
Parameters
- client: Client
Returns Themes
- Defined in src/api/themes.ts:8

Methods

getGlobalTheme

getGlobalTheme<T = Theme>(callback: Callback<T>): Promise<void>
Returns the globally assigned theme.

Permissions required: None
Type Parameters
- T = Theme
Parameters
- callback: Callback<T>
Returns Promise<void>
- Defined in src/api/themes.ts:43
getGlobalTheme<T = Theme>(callback?: undefined): Promise<T>
Returns the globally assigned theme.

Permissions required: None
Type Parameters
- T = Theme
Parameters
- Optionalcallback: undefined
Returns Promise<T>
- Defined in src/api/themes.ts:49

getSpaceTheme

getSpaceTheme<T = Theme>(
parameters: GetSpaceTheme,
callback: Callback<T>,
): Promise<void>
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.
Type Parameters
- T = Theme
Parameters
- parameters: GetSpaceTheme
- callback: Callback<T>
Returns Promise<void>
- Defined in src/api/themes.ts:86
getSpaceTheme<T = Theme>(
parameters: GetSpaceTheme,
callback?: undefined,
): Promise<T>
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.
Type Parameters
- T = Theme
Parameters
- parameters: GetSpaceTheme
- Optionalcallback: undefined
Returns Promise<T>
- Defined in src/api/themes.ts:93

getTheme

getTheme<T = Theme>(parameters: GetTheme, callback: Callback<T>): Promise<void>
Returns a theme. This includes information about the theme name, description, and icon.

Permissions required: None
Type Parameters
- T = Theme
Parameters
- parameters: GetTheme
- callback: Callback<T>
Returns Promise<void>
- Defined in src/api/themes.ts:64
getTheme<T = Theme>(parameters: GetTheme, callback?: undefined): Promise<T>
Returns a theme. This includes information about the theme name, description, and icon.

Permissions required: None
Type Parameters
- T = Theme
Parameters
- parameters: GetTheme
- Optionalcallback: undefined
Returns Promise<T>
- Defined in src/api/themes.ts:70

getThemes

getThemes<T = ThemeArray>(
parameters: undefined | GetThemes,
callback: Callback<T>,
): Promise<void>
Returns all themes, not including the default theme.

Permissions required: None
Type Parameters
- T = ThemeArray
Parameters
- parameters: undefined | GetThemes
- callback: Callback<T>
Returns Promise<void>
- Defined in src/api/themes.ts:15
getThemes<T = ThemeArray>(
parameters?: GetThemes,
callback?: undefined,
): Promise<T>
Returns all themes, not including the default theme.

Permissions required: None
Type Parameters
- T = ThemeArray
Parameters
- Optionalparameters: GetThemes
- Optionalcallback: undefined
Returns Promise<T>
- Defined in src/api/themes.ts:24

resetSpaceTheme

resetSpaceTheme<T = void>(
parameters: ResetSpaceTheme,
callback: Callback<T>,
): 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.
Type Parameters
- T = void
Parameters
- parameters: ResetSpaceTheme
- callback: Callback<T>
Returns Promise<void>
- Defined in src/api/themes.ts:140
resetSpaceTheme<T = void>(
parameters: ResetSpaceTheme,
callback?: undefined,
): Promise<T>
Resets the space theme. This means that the space will inherit the global look and feel settings

Permissions required: 'Admin' permission for the space.
Type Parameters
- T = void
Parameters
- parameters: ResetSpaceTheme
- Optionalcallback: undefined
Returns Promise<T>
- Defined in src/api/themes.ts:146

setSpaceTheme

setSpaceTheme<T = Theme>(
parameters: SetSpaceTheme,
callback: Callback<T>,
): Promise<void>
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.
Type Parameters
- T = Theme
Parameters
- parameters: SetSpaceTheme
- callback: Callback<T>
Returns Promise<void>
- Defined in src/api/themes.ts:112
setSpaceTheme<T = Theme>(
parameters: SetSpaceTheme,
callback?: undefined,
): Promise<T>
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.
Type Parameters
- T = Theme
Parameters
- parameters: SetSpaceTheme
- Optionalcallback: undefined
Returns Promise<T>
- Defined in src/api/themes.ts:119

Class Themes

Index

Constructors

Methods

Constructors

constructor

Parameters

Returns Themes

Methods

getGlobalTheme

Type Parameters

Parameters

Returns Promise<void>

Type Parameters

Parameters

Returns Promise<T>

getSpaceTheme

Type Parameters

Parameters

Returns Promise<void>

Type Parameters

Parameters

Returns Promise<T>

getTheme

Type Parameters

Parameters

Returns Promise<void>

Type Parameters

Parameters

Returns Promise<T>

getThemes

Type Parameters

Parameters

Returns Promise<void>

Type Parameters

Parameters

Returns Promise<T>

resetSpaceTheme

Type Parameters

Parameters

Returns Promise<void>

Type Parameters

Parameters

Returns Promise<T>

setSpaceTheme

Type Parameters

Parameters

Returns Promise<void>

Type Parameters

Parameters

Returns Promise<T>

Settings

On This Page