Class Settings

Constructors

constructor

Properties

client

Methods

getContentStateSettings getLookAndFeelSettings getSystemInfo resetLookAndFeelSettings setLookAndFeelSettings updateLookAndFeel updateLookAndFeelSettings

Constructors

constructor

Properties

Private client

client: Client

Methods

getContentStateSettings

getLookAndFeelSettings

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

  • Returns the look and feel settings for the site or a single space. This includes attributes such as the color scheme, padding, and border radius.

    The look and feel settings for a space can be inherited from the global look and feel settings or provided by a theme.

    Permissions required: None

    Type Parameters

    Parameters

    Returns Promise<void>

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

  • Returns the look and feel settings for the site or a single space. This includes attributes such as the color scheme, padding, and border radius.

    The look and feel settings for a space can be inherited from the global look and feel settings or provided by a theme.

    Permissions required: None

    Type Parameters

    Parameters

    Returns Promise<T>

getSystemInfo

  • getSystemInfo<T>(callback): Promise<void>

  • Returns the system information for the Confluence Cloud tenant. This information is used by Atlassian.

    Permissions required: Permission to access the Confluence site ('Can use' global permission).

    Type Parameters

    Parameters

    Returns Promise<void>

  • getSystemInfo<T>(callback?): Promise<T>

  • Returns the system information for the Confluence Cloud tenant. This information is used by Atlassian.

    Permissions required: Permission to access the Confluence site ('Can use' global permission).

    Type Parameters

    Parameters

    • Optional callback: undefined

    Returns Promise<T>

resetLookAndFeelSettings

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

  • Resets the custom look and feel settings for the site or a single space. This changes the values of the custom settings to be the same as the default settings. It does not change which settings (default or custom) are selected. Note, the default space settings are inherited from the current global settings.

    Permissions required: 'Admin' permission for the space.

    Type Parameters

    • T = void

    Parameters

    Returns Promise<void>

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

  • Resets the custom look and feel settings for the site or a single space. This changes the values of the custom settings to be the same as the default settings. It does not change which settings (default or custom) are selected. Note, the default space settings are inherited from the current global settings.

    Permissions required: 'Admin' permission for the space.

    Type Parameters

    • T = void

    Parameters

    Returns Promise<T>

setLookAndFeelSettings

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

  • Sets the look and feel settings to either the default settings or the custom settings, for the site or a single space. Note, the default space settings are inherited from the current global settings.

    Permissions required: 'Admin' permission for the space.

    Type Parameters

    • T = unknown

    Parameters

    Returns Promise<void>

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

  • Sets the look and feel settings to either the default settings or the custom settings, for the site or a single space. Note, the default space settings are inherited from the current global settings.

    Permissions required: 'Admin' permission for the space.

    Type Parameters

    • T = unknown

    Parameters

    Returns Promise<T>

updateLookAndFeel

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

  • Sets the look and feel settings to the default (global) settings, the custom settings, or the current theme's settings for a space. The custom and theme settings can only be selected if there is already a theme set for a space. Note, the default space settings are inherited from the current global settings.

    Permissions required: 'Admin' permission for the space.

    Type Parameters

    Parameters

    Returns Promise<void>

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

  • Sets the look and feel settings to the default (global) settings, the custom settings, or the current theme's settings for a space. The custom and theme settings can only be selected if there is already a theme set for a space. Note, the default space settings are inherited from the current global settings.

    Permissions required: 'Admin' permission for the space.

    Type Parameters

    Parameters

    Returns Promise<T>

updateLookAndFeelSettings

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

  • Updates the look and feel settings for the site or for a single space. If custom settings exist, they are updated. If no custom settings exist, then a set of custom settings is created.

    Note, if a theme is selected for a space, the space look and feel settings are provided by the theme and cannot be overridden.

    Permissions required: 'Admin' permission for the space.

    Type Parameters

    Parameters

    Returns Promise<void>

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

  • Updates the look and feel settings for the site or for a single space. If custom settings exist, they are updated. If no custom settings exist, then a set of custom settings is created.

    Note, if a theme is selected for a space, the space look and feel settings are provided by the theme and cannot be overridden.

    Permissions required: 'Admin' permission for the space.

    Type Parameters

    Parameters

    Returns Promise<T>

Settings

Member Visibility

Theme

On This Page

constructorclientgetContentStateSettingsgetLookAndFeelSettingsgetSystemInforesetLookAndFeelSettingssetLookAndFeelSettingsupdateLookAndFeelupdateLookAndFeelSettings

Generated using TypeDoc v0.25.12