Package com.adobe.cq.inbox.api.preferences

Interface InboxPreferencesProvider

@ProviderType
public interface InboxPreferencesProvider

Interface for the setting and getting AEM Inbox Preferences

Method Summary

Modifier and Type	Method	Description
InboxPreferences	getPreferences(ResourceResolver resolver)	Returns the InboxPreferences of the user or empty object if Inbox Prefernces is not present
void	setPreferences(ResourceResolver resolver, InboxPreferences preferences)	Sets the InboxPreferences of the user or null if you want to remove inbox preferences

Method Detail

getPreferences

@Nonnull
InboxPreferences getPreferences(@Nonnull
                                ResourceResolver resolver)
                         throws InboxException

Returns the InboxPreferences of the user or empty object if Inbox Prefernces is not present

Parameters:

resolver - The caller's ResourceResolver

Returns:

The InboxPreferences of the user

Throws:

InboxException - InboxException

setPreferences

void setPreferences(@Nonnull
                    ResourceResolver resolver,
                    @Nullable
                    InboxPreferences preferences)
             throws InboxException

Sets the InboxPreferences of the user or null if you want to remove inbox preferences

Parameters:

resolver - The caller's ResourceResolver

preferences - The InboxPreferences of the user

Throws:

InboxException - InboxException