com.adobe.cq.social.badging.api

Interface UserBadge

public interface UserBadge

A user's earned/assigned badge info containing the path to the badge content (resource for the image, title, etc.) and whether it's an assigned badge.

Method Summary

Modifier and Type	Method and Description
java.lang.String	getBadgePath()
java.lang.String	getImagePath() Deprecated.
Resource	getResource() The earned or assigned badge user generated content resource.
boolean	isAssigned()

Method Detail

getImagePath

@Deprecated
 @Nonnull
java.lang.String getImagePath()

Deprecated.

Returns the absolute path to the badge image, e.g. the path to the png image. Can return an empty string if image can't be found or it no longer exist (e.g. resource removed from /libs/community/badging/images).

Returns:

absolute path to the badge image resource.

getBadgePath

@Nonnull
java.lang.String getBadgePath()

Returns:

the BadgingService.BADGE_PATH_PROP property or empty string if it doesn't exist.

isAssigned

boolean isAssigned()

Returns:

true if badge is an assigned badge.

getResource

@Nonnull
Resource getResource()

The earned or assigned badge user generated content resource. For example, resources in /content/usergenerated/asi/srp/{user's profile path}/badges. Not to be confused with a badge content resource, such as the resources in /libs/community/badging/images.

Returns:

the resource of the badge.