ThemesApi 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

ThemesApi(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

getGlobalTheme() → Future<Theme>

Returns the globally assigned theme.

getSpaceTheme(String spaceKey) → Future<Theme>

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.

getTheme(String themeKey) → Future<Theme>

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

getThemes({int? start, int? limit}) → Future<ThemeArray>

Returns all admin-driven themes, not including the default theme. Note that this API only applies to themes set for an entire space or site by the admin. User-driven theming controls (Light, Dark, and match browser) are an unrelated feature. Admin-driven themes will override user-driven themes.

noSuchMethod(Invocation invocation) → dynamic

Invoked when a nonexistent method or property is accessed.

inherited

resetSpaceTheme(String spaceKey) → Future<void>

Resets the space theme. This means that the space will inherit the global look and feel settings

setSpaceTheme({required String spaceKey, required ThemeUpdate body}) → Future<Theme>

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.

toString() → String

A string representation of this object.

inherited

Operators

operator ==(Object other) → bool

The equality operator.

inherited