com.adobe.cq.social.subscriptions.client.api.UserSubscriptionPreferences Maven / Gradle / Ivy

Show more of this group Show more artifacts with this name
Show all versions of uber-jar Show documentation

There is a newer version: 6.5.21

/*************************************************************************
 *
 * ADOBE CONFIDENTIAL
 * __________________
 *
 *  Copyright 2015 Adobe Systems Incorporated
 *  All Rights Reserved.
 *
 * NOTICE:  All information contained herein is, and remains
 * the property of Adobe Systems Incorporated and its suppliers,
 * if any.  The intellectual and technical concepts contained
 * herein are proprietary to Adobe Systems Incorporated and its
 * suppliers and are protected by trade secret or copyright law.
 * Dissemination of this information or reproduction of this material
 * is strictly forbidden unless prior written permission is obtained
 * from Adobe Systems Incorporated.
 **************************************************************************/
package com.adobe.cq.social.subscriptions.client.api;

import java.util.Collection;
import java.util.Map;

import javax.jcr.RepositoryException;

import org.apache.sling.api.resource.ValueMap;

import com.adobe.cq.social.scf.SocialComponent;
import com.fasterxml.jackson.annotation.JsonIgnore;

public interface UserSubscriptionPreferences extends SocialComponent {
    String RESOURCE_TYPE = "social/subscriptions/components/hbs/subscriptionpreferences";

    /**
     * List of notification channels
     * @return Collection
     */
    Collection getNotificationChannels();

    /**
     * List of subscription channels
     * @return Collection
     */
    Collection getSubscriptionChannels();

    /**
     * List of notification categories
     * @return Map of channel categories
     * @throws RepositoryException Repository Exception
     */
    Map> getNotificationChannelCategories() throws RepositoryException;

    Map> getSubscriptionChannelCategories() throws RepositoryException;

    /**
     * Get the notification category settings for all the channels. The key of the map is the channel id, the value of
     * each item in the map is a Map, which provides the category settings.
     * @return Map of notification category settings
     * @throws RepositoryException Repository Exception
     */
    Map> getNotificationCategorySettings() throws RepositoryException;

    Map> getSubscriptionCategorySettings() throws RepositoryException;

    /**
     * Get user path
     * @return string with user path
     */
    @JsonIgnore
    String getUserPath();

}