com.adobe.cq.inbox.api.preferences.domain.view

Interface ViewConfiguration

@ProviderType
public interface ViewConfiguration

A view configuration applicable to workflow-users This is different from ViewPreferences, which are user specific view preferences

Method Summary

Modifier and Type	Method and Description
java.util.List<ViewConfigurationColumn>	getColumns() The column in the inbox
java.lang.String	getCustomBrandingText() Returns the custom branding text of inbox
java.net.URL	getCustomHelpUrl() Returns the url where a user should be directed to (from inbox) for help If not set, AEM's default help behavior will be in effect
java.lang.String	getCustomLogoPath() Return the JCR path of image to be used as the branding logo
boolean	isEndUserConfigurationEnabled() Returns if end user configuration is enabled by the inbox admin or not.
void	setCustomBrandingText(java.lang.String text) Set the custom branding text.
void	setCustomHelpUrl(java.net.URL url) Set the custom help link url
void	setCustomLogoPath(java.lang.String path) Set the JCR path of image to be used as the branding logo
void	setIsEndUserConfigurationEnabled(boolean isEndUserConfigurationEnabled) Set the isEndUserConfigurationEnabled property.

Method Detail

getCustomBrandingText

@Nonnull
java.lang.String getCustomBrandingText()

Returns the custom branding text of inbox

Returns:

The custom branding text

setCustomBrandingText

void setCustomBrandingText(@Nullable
                           java.lang.String text)

Set the custom branding text.

Parameters:

text - Custom Branding text

getCustomHelpUrl

@Nullable
java.net.URL getCustomHelpUrl()

Returns the url where a user should be directed to (from inbox) for help If not set, AEM's default help behavior will be in effect

Returns:

The custom help url

setCustomHelpUrl

void setCustomHelpUrl(@Nullable
                      java.net.URL url)

Set the custom help link url

Parameters:

url - The url where a user should be directed to (from inbox) for help

getCustomLogoPath

@Nullable
java.lang.String getCustomLogoPath()

Return the JCR path of image to be used as the branding logo

Returns:

The logo path

setCustomLogoPath

void setCustomLogoPath(@Nullable
                       java.lang.String path)

Set the JCR path of image to be used as the branding logo

Parameters:

path - If null, the default branding logo will be used

getColumns

@Nonnull
java.util.List<ViewConfigurationColumn> getColumns()

The column in the inbox

Returns:

a list of ViewConfigurationColumn

isEndUserConfigurationEnabled

boolean isEndUserConfigurationEnabled()

Returns if end user configuration is enabled by the inbox admin or not.

Returns:

true if end user configuration is enabled and false if not enabled.

setIsEndUserConfigurationEnabled

void setIsEndUserConfigurationEnabled(boolean isEndUserConfigurationEnabled)

Set the isEndUserConfigurationEnabled property.

Parameters:

isEndUserConfigurationEnabled - true or false