SettingsApi class

This document describes the REST API and resources provided by Confluence. The REST APIs are for developers who want to integrate Confluence into their application and for administrators who want to script interactions with the Confluence server.Confluence's REST APIs provide access to resources (data entities) via URI paths. To use a REST API, your application will make an HTTP request and parse the response. The response format is JSON. Your methods will be the standard HTTP methods like GET, PUT, POST and DELETE. Because the REST API is based on open standards, you can use any web development language to access the API.

Constructors

SettingsApi(ApiClient _client)

Properties

hashCode → int

The hash code for this object.

no setter, inherited

runtimeType → Type

A representation of the runtime type of the object.

no setter, inherited

Methods

getLookAndFeelSettings({String? spaceKey}) → Future<LookAndFeelSettings>

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.

getSystemInfo() → Future<SystemInfoEntity>

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

noSuchMethod(Invocation invocation) → dynamic

Invoked when a nonexistent method or property is accessed.

inherited

resetLookAndFeelSettings({String? spaceKey}) → Future<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.

setLookAndFeelSettings({String? spaceKey, required String body}) → Future<String>

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.

toString() → String

A string representation of this object.

inherited

updateLookAndFeel({required LookAndFeelSelection body}) → Future<LookAndFeelSelection>

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.

updateLookAndFeelSettings({String? spaceKey, required LookAndFeel body}) → Future<LookAndFeelWithLinks>

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.

Operators

operator ==(Object other) → bool

The equality operator.

inherited