com.adobe.cq.social.filelibrary.client.api

Interface Document

All Superinterfaces:

Asset<FileLibraryConfiguration>, Comment<FileLibraryConfiguration>, SocialCollectionComponent, SocialComponent

public interface Document
extends Asset<FileLibraryConfiguration>

Nested Class Summary

Nested classes/interfaces inherited from interface com.adobe.cq.social.commons.comments.api.Comment

Comment.ModeratorActions, Comment.ModeratorStatus, Comment.Tag

Field Summary

Fields inherited from interface com.adobe.cq.social.filelibrary.client.api.Asset

LAST_SELF_MOD_BY, PN_NAME

Fields inherited from interface com.adobe.cq.social.commons.comments.api.Comment

COMMENT_RESOURCETYPE, COMMENTCOLLECTION_RESOURCETYPE, JSON_EXTENSION, NODE_TYPE, PROP_APPROVED, PROP_REFERER, PROP_SPAM, PROP_USE_REFERRER_URL, SOCO_SELECTOR

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

CSV_SELECTOR, DEFAULT_SELECTOR, INDEX_SELECTOR, QUERY_SELECTOR, TRANSLATE_SELECTOR

Method Summary

Modifier and Type	Method and Description
java.lang.String	getPath() Get the path of the resource of this document
SocialComponent	getRating()
java.lang.String	getType() Get the mime type of this document
SocialComponent	getVotes() Deprecated.

Methods inherited from interface com.adobe.cq.social.filelibrary.client.api.Asset

getFileLibraryId, getFriendlyUrl, getName, getParentFriendlyUrl, getParentName, isFileLibraryClosed, isFolder

Methods inherited from interface com.adobe.cq.social.commons.comments.api.Comment

getAttachment, getAttachments, getAuthor, getCanDelete, getCanEdit, getCanReply, getCanTranslate, getConfiguration, getCreated, getCurrentUserFlagText, getFlagReasons, getMessage, getModeratorActions, getModeratorStatus, getPageInfo, getParentId, getPublishDate, getReferrerUrl, getSourceComponentId, getState, getTags, getTranslationAttribution, getTranslationDescription, getTranslationDisplay, getTranslationTitle, getUseFlagReasons, isApproved, isClosed, isDraft, isFeatured, isFlaggedByUser, isPinned, isScheduled, isTopLevel, isUserModerator, isVisible

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

getItems, getTotalSize, setPagination, setSortedOrder

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

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

Method Detail

getType

java.lang.String getType()

Get the mime type of this document

Returns:

String

getPath

java.lang.String getPath()

Get the path of the resource of this document

Returns:

String

getVotes

@Deprecated
SocialComponent getVotes()

Deprecated.

Use getRating instead

Specified by:

getVotes in interface Comment<FileLibraryConfiguration>

Returns:

voting component

getRating

SocialComponent getRating()

Returns:

the ratings for this document