com.adobe.cq.social.scf

Interface User

All Superinterfaces:

SocialAuthorizable, SocialComponent

All Known Subinterfaces:

CommunityMemberUser, CommunityUser, LivefyreUser, MessagingUser

All Known Implementing Classes:

AbstractCommunityGroupUser, AbstractUser

public interface User
extends SocialAuthorizable

Nested Class Summary

Nested Classes

Modifier and Type	Interface and Description
static interface	User.Badge An interface that represents a badge that is awarded to community users.

Field Summary

Fields

Modifier and Type	Field and Description
static java.lang.String	RESOURCE_TYPE
static java.lang.String	SOCIAL_AUTHORS_PREFIX

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
java.lang.String	getAvatarUrl() Get URL to fetch the user avatar.
java.util.List<User.Badge>	getBadges()
java.lang.Boolean	getDisabled()
java.lang.String	getDisabledReason()
java.lang.String	getLargeAvatarUrl() Get URL to fetch the user avatar (48px).
java.lang.Long	getNumberOfPosts() Deprecated.
java.lang.String	getProfileUrl() Get externalized URL to the profile page
java.lang.String	getUserId()
java.lang.Boolean	isUserUGCLimited() Checks if is user sand boxed.

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

getAuthorizableId, getName, getPath

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

SOCIAL_AUTHORS_PREFIX

static final java.lang.String SOCIAL_AUTHORS_PREFIX

See Also:

Constant Field Values

Method Detail

getAvatarUrl

java.lang.String getAvatarUrl()

Get URL to fetch the user avatar.

Returns:

the url of the user avatar

getLargeAvatarUrl

java.lang.String getLargeAvatarUrl()

Get URL to fetch the user avatar (48px).

Returns:

the url of the user avatar

getProfileUrl

java.lang.String getProfileUrl()

Get externalized URL to the profile page

Returns:

an externalized URL to the user's public profile

getNumberOfPosts

@Deprecated
java.lang.Long getNumberOfPosts()

Deprecated.

Returns:

number of forum posts authored by the user

getBadges

java.util.List<User.Badge> getBadges()

Returns:

a list of badges that the user has been awarded

getDisabled

java.lang.Boolean getDisabled()

Returns:

true if the user is disabled, false otherwise

getUserId

java.lang.String getUserId()

Returns:

user id

getDisabledReason

java.lang.String getDisabledReason()

Returns:

if the user is disabled, return the string containing the reason, otherwise return null

isUserUGCLimited

java.lang.Boolean isUserUGCLimited()

Checks if is user sand boxed.

Returns:

the boolean