com.adobe.cq.social.enablement.client.api

Interface EnablementResourceSocialComponent

All Superinterfaces:

EnablementContentComponent, SocialComponent

public interface EnablementResourceSocialComponent
extends EnablementContentComponent, SocialComponent

Field Summary

Fields

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

Fields inherited from interface com.adobe.cq.social.enablement.model.api.EnablementContentComponent

DESCRIPTION_TRUNCATION_LIMIT, RESOURCE_HTML_SUFFIX

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

DEFAULT_SELECTOR, INDEX_SELECTOR, PROP_REFERER, QUERY_SELECTOR, TRANSLATE_SELECTOR

Method Summary

Modifier and Type	Method and Description
java.util.Map<java.lang.String,java.lang.String>	getAssetProperties()
java.util.List<EnablementContentContact>	getAuthors() Gets the authors assigned to the resource.
java.lang.String	getCommentsEndPoint()
java.lang.String	getDueDate()
java.lang.String	getDueStatus() Get due status for a resource "-2": Resource gets completed before due date "-1": Due date is more than 3 days later "1": Due within 3 days "2": Past due
java.lang.String	getDuration()
java.lang.String	getEnablementResourcePath()
java.lang.String	getEnablementResourceType()
java.util.List<EnablementContentContact>	getExperts() Gets the experts assigned to the resource.
java.lang.String	getExternalUrl()
java.lang.String	getFriendlyDueDate()
java.lang.String	getMarketingCloudOrgId()
java.lang.String	getNormalizedSize()
java.util.Map<java.lang.String,java.lang.String>	getParentLearningPathInfo()
java.lang.String	getPosterImagePath()
java.lang.String	getPublishedDate()
java.lang.String	getRatingsEndPoint()
java.lang.String	getResourceAssetPath()
long	getSize()
boolean	isAnalyticsEnabled()
java.lang.Boolean	isEnablementResource()
boolean	isResourceCompleted()
java.lang.Boolean	isScormResource()
boolean	isTypeImage()

Methods inherited from interface com.adobe.cq.social.enablement.model.api.EnablementContentComponent

getAuthorName, getCardImagePath, getContacts, getDescription, getPagePath, getResourceType, getSitePagePath, getTitle, getTruncatedDescription, setParentComponent

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

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

Field Detail

RESOURCE_TYPE

static final java.lang.String RESOURCE_TYPE

See Also:

Constant Field Values

Method Detail

getDuration

java.lang.String getDuration()

Returns:

duration of the Resource

getSize

long getSize()

Returns:

the size of the Resource

getNormalizedSize

java.lang.String getNormalizedSize()

Returns:

the friendly size of the Resource e.g 10 MB, 20 KB

getPublishedDate

java.lang.String getPublishedDate()

Returns:

the published date of the Resource

getFriendlyDueDate

java.lang.String getFriendlyDueDate()

Returns:

the friendly due date of the Resource

getDueDate

java.lang.String getDueDate()

Returns:

the due date of the Resource

getPosterImagePath

java.lang.String getPosterImagePath()

Returns:

the image path of the Resource poster

getResourceAssetPath

java.lang.String getResourceAssetPath()

Returns:

the resource asset path (e.g. /content/enablement/data/resources/spiderman/assets/asset/spidey.mp4)

getEnablementResourceType

java.lang.String getEnablementResourceType()

Returns:

the resource mime type (e.g. video/mp4)

getEnablementResourcePath

java.lang.String getEnablementResourcePath()

Returns:

the resource path identifier (e.g. /content/enablement/data/resources/spiderman)

getCommentsEndPoint

java.lang.String getCommentsEndPoint()
                              throws RepositoryException

Returns:

comments component end-point for this enablement resource (e.g. /content/enablement/data/resources/spiderman/social1421984027794/jcr:content/comments)

Throws:

RepositoryException - -- Throws RepositoryException when not able to find the node

getRatingsEndPoint

java.lang.String getRatingsEndPoint()
                             throws RepositoryException

Returns:

comments ratings end-point for this enablement resource (e.g. /content/enablement/data/resources/spiderman/social1421984027794/jcr:content/ratings)

Throws:

RepositoryException - -- Throws RepositoryException when not able to find the node

getMarketingCloudOrgId

java.lang.String getMarketingCloudOrgId()

Returns:

the marketing cloud org Id required to instantiate video heartbeat

isTypeImage

boolean isTypeImage()

Returns:

true iff the resource type is image

getExternalUrl

java.lang.String getExternalUrl()

Returns:

the external url for url resources

getAuthors

java.util.List<EnablementContentContact> getAuthors()

Gets the authors assigned to the resource.

Returns:

authors

getExperts

java.util.List<EnablementContentContact> getExperts()

Gets the experts assigned to the resource.

Returns:

experts

isEnablementResource

java.lang.Boolean isEnablementResource()

Returns:

Whether sling resource is an Enablement Resource

isAnalyticsEnabled

boolean isAnalyticsEnabled()

Returns:

true if the resource can track analytics

getParentLearningPathInfo

java.util.Map<java.lang.String,java.lang.String> getParentLearningPathInfo()

Returns:

information of learning path that contains current enablement resource

isScormResource

java.lang.Boolean isScormResource()

getAssetProperties

java.util.Map<java.lang.String,java.lang.String> getAssetProperties()

isResourceCompleted

boolean isResourceCompleted()

Returns:

If resource is completed by a user

getDueStatus

java.lang.String getDueStatus()

Get due status for a resource

• "-2": Resource gets completed before due date
• "-1": Due date is more than 3 days later
• "1": Due within 3 days
• "2": Past due

Returns:

String