com.adobe.cq.social.forum.client.api

Interface ForumConfiguration

All Superinterfaces:

CommentCollectionConfiguration

All Known Subinterfaces:

CalendarConfiguration

All Known Implementing Classes:

BaseForumConfiguration, CalendarConfigurationImpl, QnaConfiguration

public interface ForumConfiguration
extends CommentCollectionConfiguration

Field Summary

Fields

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

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

ALLOW_PRIVILEGED_MEMBERS, ANALYTICS_TIME_SELECTOR, ENABLE_MENTIONS, MAX_MENTIONS, MIN_IMG_DEFAULT_SIZE_FOR_THUMBNAIL, MIN_IMG_SIZE_FOR_THUMBNAIL_PROPERTY, PN_ALLOW_ATTACHMENT, PN_ALLOW_CLOSE, PN_ALLOW_CUSTOM_FLAGREASON, PN_ALLOW_DELETE_COMMENTS, PN_ALLOW_DENY, PN_ALLOW_FEATURED_CONTENT, PN_ALLOW_FLAGGING, PN_ALLOW_FOLLOWING, PN_ALLOW_MOVE, PN_ALLOW_PINNING, PN_ALLOW_REPLIES, PN_ALLOW_SUBSCRIPTIONS, PN_ALLOW_TAGGING, PN_ALLOW_TRANSLATE_ALL, PN_ALLOW_VOTING, PN_DO_NOT_GET_REPLIES_ON_LISTING_PAGE, PN_MAX_ITEMS_PER_PAGE, PN_RTE_ENABLED, PN_SHOW_BADGES, PN_SORT_FIELD, PN_SORT_FIELD_ORDER, PN_SORT_ORDER, PN_VOTING_ROOT, PN_VOTING_TYPE, PRIVILEGED_USERS_GROUP, PV_DEFAULT_ALLOW_ATTACHMENT, PV_DEFAULT_ALLOW_CLOSE, PV_DEFAULT_ALLOW_CUSTOM_FLAGREASON, PV_DEFAULT_ALLOW_DELETE_COMMENTS, PV_DEFAULT_ALLOW_DENY, PV_DEFAULT_ALLOW_FEATURED_CONTENT, PV_DEFAULT_ALLOW_FLAGGING, PV_DEFAULT_ALLOW_FOLLOWING, PV_DEFAULT_ALLOW_MOVE, PV_DEFAULT_ALLOW_PIN, PV_DEFAULT_ALLOW_REPLIES, PV_DEFAULT_ALLOW_SUBSCRIPTIONS, PV_DEFAULT_ALLOW_TRANSLATE_ALL, PV_DEFAULT_ALLOW_VOTING, PV_DEFAULT_ANALYTICS_TIME_SELECTOR, PV_DEFAULT_DO_NOT_GET_REPLIES_ON_LISTING_PAGE, PV_DEFAULT_LAST_UPDATED, PV_DEFAULT_NEWEST, PV_DEFAULT_RTE_ENABLED, PV_DEFAULT_SHOW_BADGES, PV_DEFAULT_SORT_FIELD, PV_DEFAULT_VOTING_ROOT, PV_DEFAULT_VOTING_TYPE, PV_SORT_ASC, PV_SORT_DESC, SORT_BY, THUMBNAIL_DEFAULT_SIZE, THUMBNAIL_SIZE_PROPERTY, UI_MENTION_PATTERN

Method Summary

Modifier and Type	Method and Description
long	getTagFilterLimit() The limit value for getting tags.
java.lang.String	getTagFilterVal() The filter value for getting tags.
boolean	isBreadcrumbsEnabled()
boolean	isTaggingAllowed() Checks if is tagging allowed.
boolean	isUsingPrivilegedUsers() Checks if priviliged users group is set.

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

getAnalyticsTimeSelector, getMaxMentions, getMinimumImgSizeForThumbnail, getPageSize, getSortByItemsList, getSortFields, getSortOrder, getThumbNailSize, getUIMentionPattern, isAttachmentAllowed, isCloseAllowed, isCustomFlagReasonAllowed, isDeleteAllowed, isDenyAllowed, isDoNotGetRepliesOnListingPage, isEditAllowed, isFeaturingContentAllowed, isFlaggingAllowed, isFollowingAllowed, isMentionsEnabled, isMoveAllowed, isPinAllowed, isReplyAllowed, isRTEEnabled, isSubscriptionsAllowed, isTranslateAllButtonAllowed, isVotingAllowed

Field Detail

PN_SHOW_BREADCRUMBS

static final java.lang.String PN_SHOW_BREADCRUMBS

See Also:

Constant Field Values

Method Detail

isTaggingAllowed

boolean isTaggingAllowed()

Checks if is tagging allowed.

Returns:

true, if is tagging allowed

getTagFilterVal

java.lang.String getTagFilterVal()

The filter value for getting tags.

Returns:

a string of the path to filter

getTagFilterLimit

long getTagFilterLimit()

The limit value for getting tags.

Returns:

a maximum number of tags to display.

isBreadcrumbsEnabled

boolean isBreadcrumbsEnabled()

Returns:

true if the forum is configured to show breadcrumbs, false otherwise. defaults to true

isUsingPrivilegedUsers

boolean isUsingPrivilegedUsers()

Checks if priviliged users group is set.

Returns:

true, if is using priviliged users