Class Themes

Constructors

constructor

Properties

client

Methods

getGlobalTheme getSpaceTheme getTheme getThemes resetSpaceTheme setSpaceTheme

Constructors

constructor

Properties

Private client

client: Client

Methods

getGlobalTheme

getSpaceTheme

  • getSpaceTheme<T>(parameters, callback): 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

    Parameters

    Returns Promise<void>

  • getSpaceTheme<T>(parameters, callback?): 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

    Parameters

    Returns Promise<T>

getTheme

  • getTheme<T>(parameters, callback): Promise<void>

  • Returns a theme. This includes information about the theme name, description, and icon.

    Permissions required: None

    Type Parameters

    Parameters

    Returns Promise<void>

  • getTheme<T>(parameters, callback?): Promise<T>

  • Returns a theme. This includes information about the theme name, description, and icon.

    Permissions required: None

    Type Parameters

    Parameters

    • parameters: GetTheme
    • Optional callback: undefined

    Returns Promise<T>

getThemes

  • getThemes<T>(parameters, callback): Promise<void>

  • Returns all themes, not including the default theme.

    Permissions required: None

    Type Parameters

    Parameters

    Returns Promise<void>

  • getThemes<T>(parameters?, callback?): Promise<T>

  • Returns all themes, not including the default theme.

    Permissions required: None

    Type Parameters

    Parameters

    • Optional parameters: GetThemes
    • Optional callback: undefined

    Returns Promise<T>

resetSpaceTheme

  • resetSpaceTheme<T>(parameters, callback): 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

    Returns Promise<void>

  • resetSpaceTheme<T>(parameters, callback?): 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

    Returns Promise<T>

setSpaceTheme

  • setSpaceTheme<T>(parameters, callback): 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

    Parameters

    Returns Promise<void>

  • setSpaceTheme<T>(parameters, callback?): 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

    Parameters

    Returns Promise<T>

Settings

Member Visibility

Theme

On This Page

constructorclientgetGlobalThemegetSpaceThemegetThemegetThemesresetSpaceThemesetSpaceTheme

Generated using TypeDoc v0.25.12