Class Settings

Index

Constructors

Methods

getLookAndFeelSettings getSystemInfo resetLookAndFeelSettings setLookAndFeelSettings updateLookAndFeel updateLookAndFeelSettings

Constructors

constructor

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

Methods

getLookAndFeelSettings

getLookAndFeelSettings<T = LookAndFeelSettings>(
parameters: undefined | GetLookAndFeelSettings,
callback: Callback<T>,
): 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
- T = LookAndFeelSettings
Parameters
- parameters: undefined | GetLookAndFeelSettings
- callback: Callback<T>
Returns Promise<void>
- Defined in src/api/settings.ts:19
getLookAndFeelSettings<T = LookAndFeelSettings>(
parameters?: GetLookAndFeelSettings,
callback?: undefined,
): 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
- T = LookAndFeelSettings
Parameters
- Optionalparameters: GetLookAndFeelSettings
- Optionalcallback: undefined
Returns Promise<T>
- Defined in src/api/settings.ts:32

getSystemInfo

getSystemInfo<T = SystemInfoEntity>(callback: Callback<T>): 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
- T = SystemInfoEntity
Parameters
- callback: Callback<T>
Returns Promise<void>
- Defined in src/api/settings.ts:219
getSystemInfo<T = SystemInfoEntity>(callback?: undefined): 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
- T = SystemInfoEntity
Parameters
- Optionalcallback: undefined
Returns Promise<T>
- Defined in src/api/settings.ts:226

resetLookAndFeelSettings

resetLookAndFeelSettings<T = void>(
parameters: undefined | ResetLookAndFeelSettings,
callback: Callback<T>,
): 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
- parameters: undefined | ResetLookAndFeelSettings
- callback: Callback<T>
Returns Promise<void>
- Defined in src/api/settings.ts:148
resetLookAndFeelSettings<T = void>(
parameters?: ResetLookAndFeelSettings,
callback?: undefined,
): 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
- Optionalparameters: ResetLookAndFeelSettings
- Optionalcallback: undefined
Returns Promise<T>
- Defined in src/api/settings.ts:159

setLookAndFeelSettings

setLookAndFeelSettings<T = unknown>(
parameters: undefined | SetLookAndFeelSettings,
callback: Callback<T>,
): 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
- parameters: undefined | SetLookAndFeelSettings
- callback: Callback<T>
Returns Promise<void>
- Defined in src/api/settings.ts:184
setLookAndFeelSettings<T = unknown>(
parameters?: SetLookAndFeelSettings,
callback?: undefined,
): 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
- Optionalparameters: SetLookAndFeelSettings
- Optionalcallback: undefined
Returns Promise<T>
- Defined in src/api/settings.ts:194

updateLookAndFeel

updateLookAndFeel<T = LookAndFeelSelection>(
parameters: undefined | UpdateLookAndFeel,
callback: Callback<T>,
): 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
- T = LookAndFeelSelection
Parameters
- parameters: undefined | UpdateLookAndFeel
- callback: Callback<T>
Returns Promise<void>
- Defined in src/api/settings.ts:58
updateLookAndFeel<T = LookAndFeelSelection>(
parameters?: UpdateLookAndFeel,
callback?: undefined,
): 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
- T = LookAndFeelSelection
Parameters
- Optionalparameters: UpdateLookAndFeel
- Optionalcallback: undefined
Returns Promise<T>
- Defined in src/api/settings.ts:69

updateLookAndFeelSettings

updateLookAndFeelSettings<T = LookAndFeel>(
parameters: undefined | UpdateLookAndFeelSettings,
callback: Callback<T>,
): 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
- T = LookAndFeel
Parameters
- parameters: undefined | UpdateLookAndFeelSettings
- callback: Callback<T>
Returns Promise<void>
- Defined in src/api/settings.ts:98
updateLookAndFeelSettings<T = LookAndFeel>(
parameters?: UpdateLookAndFeelSettings,
callback?: undefined,
): 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
- T = LookAndFeel
Parameters
- Optionalparameters: UpdateLookAndFeelSettings
- Optionalcallback: undefined
Returns Promise<T>
- Defined in src/api/settings.ts:111

Class Settings

Index

Constructors

Methods

Constructors

constructor

Parameters

Returns Settings

Methods

getLookAndFeelSettings

Type Parameters

Parameters

Returns Promise<void>

Type Parameters

Parameters

Returns Promise<T>

getSystemInfo

Type Parameters

Parameters

Returns Promise<void>

Type Parameters

Parameters

Returns Promise<T>

resetLookAndFeelSettings

Type Parameters

Parameters

Returns Promise<void>

Type Parameters

Parameters

Returns Promise<T>

setLookAndFeelSettings

Type Parameters

Parameters

Returns Promise<void>

Type Parameters

Parameters

Returns Promise<T>

updateLookAndFeel

Type Parameters

Parameters

Returns Promise<void>

Type Parameters

Parameters

Returns Promise<T>

updateLookAndFeelSettings

Type Parameters

Parameters

Returns Promise<void>

Type Parameters

Parameters

Returns Promise<T>

Settings

On This Page