com.atlassian.confluence.plugins.restapi.experimental.resources

Class ExperimentalLookAndFeelResource

java.lang.Object

com.atlassian.confluence.plugins.restapi.experimental.resources.ExperimentalLookAndFeelResource

@ExperimentalApi
public class ExperimentalLookAndFeelResource
extends Object

A REST resource for manipulating the global and space-level look and feel settings.

Constructor Summary

Constructors

Constructor and Description
ExperimentalLookAndFeelResource(LookAndFeelService lookAndFeelService)

Method Summary

Modifier and Type	Method and Description
LookAndFeelSettings	getLookAndFeelSettings(String spaceKey) Get the current LookAndFeelSettings of the whole site or space.
void	resetGlobalCustom(String spaceKey) Reset the look and feel to its default value.
LookAndFeelType	selectLookAndFeel(String spaceKey, LookAndFeelType lookAndFeelType) Select the current look and feel for space or global
LookAndFeel	updateSpaceCustom(String spaceKey, LookAndFeel lookAndFeel) Submit a customised scheme for space

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Constructor Detail

ExperimentalLookAndFeelResource

public ExperimentalLookAndFeelResource(LookAndFeelService lookAndFeelService)

Method Detail

getLookAndFeelSettings

public LookAndFeelSettings getLookAndFeelSettings(String spaceKey)

Get the current LookAndFeelSettings of the whole site or space. Response has Cache-Control header set for 10 minutes.

Parameters:

spaceKey - space key identify the space, null if requesting for global site look and feel

Returns:

LookAndFeelSettings always contain a global LookAndFeel, and a custom LookAndFeel field. When site has a global theme configured, an extra theme field field is returned. Custom field might contain the identical value as global if it was not customised.

updateSpaceCustom

public LookAndFeel updateSpaceCustom(String spaceKey,
                                     LookAndFeel lookAndFeel)

Submit a customised scheme for space

Parameters:

spaceKey - space key, null if customising a global look and feel.

lookAndFeel - Scheme should contains the full colors based on existing global values. No colour scheme value can be missing.

Returns:

LookAndFeel

resetGlobalCustom

public void resetGlobalCustom(String spaceKey)

Reset the look and feel to its default value.

Parameters:

spaceKey - space key, null if resetting global look and feel

selectLookAndFeel

public LookAndFeelType selectLookAndFeel(String spaceKey,
                                         LookAndFeelType lookAndFeelType)

Select the current look and feel for space or global

Parameters:

spaceKey - space key or null for global

lookAndFeelType - LookAndFeelType