com.adobe.cq.social.subscriptions.api

Interface Subscription

public interface Subscription

Field Summary

Fields

Modifier and Type	Field and Description
static java.lang.String	NOTIFICATION_RELATION_TYPE
static java.lang.String	PROP_ENDID
static java.lang.String	PROP_REL_TYPE
static java.lang.String	PROP_STARTID
static java.lang.String	PROP_TYPE
static java.lang.String	SUBSCRIPTION_RELATION_TYPE
static java.lang.String	SUBSCRIPTION_RESOURCE_TYPE

Method Summary

Modifier and Type	Method and Description
java.lang.String	getCategory() Get the subscription category, i.e, RESOURCE, USER, etc..
java.lang.String	getOwner() Get the owner of the subscription
java.lang.String	getPath() Get the path of this subscription
java.lang.String	getSubscribedId() Get the id the user wants to subscribe to.
java.lang.String	getSubscriptionType() Get subscription type, ie., following, notification

Field Detail

PROP_TYPE

static final java.lang.String PROP_TYPE

See Also:

Constant Field Values

PROP_REL_TYPE

static final java.lang.String PROP_REL_TYPE

See Also:

Constant Field Values

PROP_STARTID

static final java.lang.String PROP_STARTID

See Also:

Constant Field Values

PROP_ENDID

static final java.lang.String PROP_ENDID

See Also:

Constant Field Values

SUBSCRIPTION_RESOURCE_TYPE

static final java.lang.String SUBSCRIPTION_RESOURCE_TYPE

See Also:

Constant Field Values

NOTIFICATION_RELATION_TYPE

static final java.lang.String NOTIFICATION_RELATION_TYPE

See Also:

Constant Field Values

SUBSCRIPTION_RELATION_TYPE

static final java.lang.String SUBSCRIPTION_RELATION_TYPE

See Also:

Constant Field Values

Method Detail

getSubscribedId

java.lang.String getSubscribedId()

Get the id the user wants to subscribe to. The id can be a resource path, or a user id.

Returns:

the subscribed id

getOwner

java.lang.String getOwner()

Get the owner of the subscription

Returns:

String

getPath

java.lang.String getPath()

Get the path of this subscription

Returns:

String

getSubscriptionType

java.lang.String getSubscriptionType()

Get subscription type, ie., following, notification

Returns:

String

getCategory

java.lang.String getCategory()

Get the subscription category, i.e, RESOURCE, USER, etc..

Returns:

String