com.adobe.cq.socialmedia.SocialSpace Maven / Gradle / Ivy

package com.adobe.cq.socialmedia;

import aQute.bnd.annotation.ProviderType;

import javax.annotation.Nonnull;

/**
 * Defines a social media network space (ex.: board, page).
 */
@ProviderType
public interface SocialSpace {

    /**
     * Retrieves the name of the space.
     * @return The name of the space.
     */
    @Nonnull String getName();

    /**
     * Retrieves the space id.
     * @return The space id.
     */
    @Nonnull String getId();

    /**
     * Retrieves a non expiring token. The token can be used for CRUD operations on that space.
     * @return The token which allows modifications to that space.
     */
    @Nonnull String getToken();

}