com.adobe.cq.social.graph.client.api

Interface Following

All Superinterfaces:

SocialComponent

All Known Subinterfaces:

MutableFollowing

All Known Implementing Classes:

AbstractFollowing

public interface Following
extends SocialComponent

Field Summary

Fields

Modifier and Type	Field and Description
static java.lang.String	PROP_FOLLOWEDID
static java.lang.String	PROP_USERID
static java.lang.String	RESOURCE_TYPE

Fields inherited from interface com.adobe.cq.social.scf.SocialComponent

CSV_SELECTOR, DEFAULT_SELECTOR, INDEX_SELECTOR, PROP_REFERER, QUERY_SELECTOR, TRANSLATE_SELECTOR

Method Summary

Modifier and Type	Method and Description
Edge	edge() Get the relationship representing this instance
Vertex	followedNode() Get the followed user graph node
java.lang.String	getFollowedId() Get the followed Id.
java.lang.String	getFollowedResourceType() Get the followed Resource Type
boolean	getIsFollowed() Check the follow state
boolean	getIsFollowedUser() Check if the followed item is a user
boolean	getMayFollow() Indicate whether the current user can follow the specify following user.
User	getUser() Get the user
SocialGraph	socialGraph() Get socialGraph of this instance.
Vertex	userNode() Get the user social graph node

Methods inherited from interface com.adobe.cq.social.scf.SocialComponent

getAsMap, getFriendlyUrl, getId, getParentComponent, getProperties, getProperty, getProperty, getResource, getResourceType, getSourceComponent, getUrl, toJSONString

Field Detail

RESOURCE_TYPE

static final java.lang.String RESOURCE_TYPE

See Also:

Constant Field Values

PROP_USERID

static final java.lang.String PROP_USERID

See Also:

Constant Field Values

PROP_FOLLOWEDID

static final java.lang.String PROP_FOLLOWEDID

See Also:

Constant Field Values

Method Detail

getUser

User getUser()

Get the user

Returns:

the follower

getFollowedId

java.lang.String getFollowedId()

Get the followed Id. This could be a CommunityUser or other SocialComponent.

Returns:

the followed component

getFollowedResourceType

java.lang.String getFollowedResourceType()

Get the followed Resource Type

Returns:

getMayFollow

boolean getMayFollow()

Indicate whether the current user can follow the specify following user.

Returns:

true if the followed component can be followed.

getIsFollowed

boolean getIsFollowed()

Check the follow state

Returns:

the current following status

getIsFollowedUser

boolean getIsFollowedUser()

Check if the followed item is a user

Returns:

true if the followed user is a user

socialGraph

SocialGraph socialGraph()

Get socialGraph of this instance.

Returns:

the social graph

edge

Edge edge()

Get the relationship representing this instance

Returns:

the edge of this instance

userNode

Vertex userNode()

Get the user social graph node

Returns:

the vertex of this instance

followedNode

Vertex followedNode()

Get the followed user graph node

Returns:

the followed vertex node