com.atlassian.confluence.content.service

Interface WelcomeMessageService

All Known Implementing Classes:

DefaultWelcomeMessageService

public interface WelcomeMessageService

A service to retrieve the welcome message

Since:

4.2

Field Summary

Fields

Modifier and Type	Field and Description
static String	WELCOME_MESSAGE_TEMPLATE_KEY
static String	WELCOME_MESSAGE_TEMPLATE_NAME

Method Summary

Modifier and Type	Method and Description
default io.atlassian.fugue.Pair<String,WebResourceDependenciesRecorder.RecordedResources>	getResourceForWelcomeMessage()
String	getWelcomeMessage()
com.atlassian.fugue.Pair<String,WebResourceDependenciesRecorder.RecordedResources>	getWelcomeMessageResource() Deprecated. since 7.0.1. Use getResourceForWelcomeMessage()
void	saveWelcomeMessage(String content) Save the give welcome message.

Field Detail

WELCOME_MESSAGE_TEMPLATE_NAME

static final String WELCOME_MESSAGE_TEMPLATE_NAME

See Also:

Constant Field Values

WELCOME_MESSAGE_TEMPLATE_KEY

static final String WELCOME_MESSAGE_TEMPLATE_KEY

See Also:

Constant Field Values

Method Detail

getWelcomeMessage

String getWelcomeMessage()

Returns:

the site welcome message, as an HTML string

getWelcomeMessageResource

@Deprecated
com.atlassian.fugue.Pair<String,WebResourceDependenciesRecorder.RecordedResources> getWelcomeMessageResource()

Deprecated. since 7.0.1. Use getResourceForWelcomeMessage()

getResourceForWelcomeMessage

default io.atlassian.fugue.Pair<String,WebResourceDependenciesRecorder.RecordedResources> getResourceForWelcomeMessage()

Since:

7.0.1

saveWelcomeMessage

void saveWelcomeMessage(String content)

Save the give welcome message. If null is passed in, it will be reset.

Parameters:

content - to save in xhtml storage format