com.adobe.cq.inbox.api.preferences

Interface ViewConfigurationProvider

@ProviderType
public interface ViewConfigurationProvider

Interface for the setting and getting AEM Inbox view configuration

Method Summary

Modifier and Type	Method and Description
ViewConfiguration	getViewConfiguration(ResourceResolver resolver) Get the ViewConfiguration of Inbox
void	setViewConfiguration(ResourceResolver resolver, ViewConfiguration viewConfiguration) Set the ViewConfiguration of Inbox

Method Detail

getViewConfiguration

@Nonnull
ViewConfiguration getViewConfiguration(@Nonnull
                                                ResourceResolver resolver)
                                         throws InboxException

Get the ViewConfiguration of Inbox

Parameters:

resolver - ResourceResolver of the callee, user should be part of 'workflow-users' group

Returns:

The current view configuration of the inbox

Throws:

InboxException - InboxException

setViewConfiguration

@Nonnull
void setViewConfiguration(@Nonnull
                                   ResourceResolver resolver,
                                   @Nonnull
                                   ViewConfiguration viewConfiguration)
                            throws InboxException

Set the ViewConfiguration of Inbox

Parameters:

resolver - ResourceResolver of the callee

viewConfiguration - ViewConfiguration to be stored

Throws:

InboxException - InboxException