Enables scripted content fragments to use Forum Reply Shares
Methods
Create
Votes for a thread reply for the accessing user
Usage
#set($forumReplyVoteResponse = $core_v2_forumReplyVote.Create($replyId, "%{Value = $valueArg, VoteType = $voteTypeArg}"))
Parameters
Name | Type | Description | Required | Default | Options |
---|---|---|---|---|---|
replyId | int | Id of the reply being voted on | Required | ||
Value | bool | Vote Value: Up (true) or Down (false). Only true is accepted when the VoteType is AnswerVerification. | Optional | True | |
VoteType | string | Either AnswerVerification or Quality. AnswerVerification can only be on QuestionAndAnswer replies. Only Quality votes can be down voted. | Optional | AnswerVerification |
Return Type
Delete
Removes a vote for a thread reply for the accessing user
Usage
#set($additionalInfoResponse = $core_v2_forumReplyVote.Delete($replyId, "%{VoteType = $voteTypeArg}"))
Parameters
Name | Type | Description | Required | Default | Options |
---|---|---|---|---|---|
replyId | int | Id of the reply that was voted on | Required | ||
VoteType | string | Either AnswerVerification or Quality. AnswerVerification can only be on QuestionAndAnswer replies. Only Quality votes can be down voted. | Optional | AnswerVerification |
Return Type
Get
Gets an existing AnswerVerification vote for a thread reply for the accessing user
Usage
#set($forumReplyVoteResponse = $core_v2_forumReplyVote.Get($replyId))
Parameters
Name | Type | Description | Required | Default | Options |
---|---|---|---|---|---|
replyId | int | Id of the reply voted on | Required |
Return Type
Get
Gets an existing AnswerVerification vote for a thread reply for the accessing user
Usage
#set($forumReplyVoteResponse = $core_v2_forumReplyVote.Get($replyId, "%{VoteType = $voteTypeArg}"))
Parameters
Name | Type | Description | Required | Default | Options |
---|---|---|---|---|---|
replyId | int | Id of the reply voted on | Required | ||
VoteType | string | Either AnswerVerification or Quality. AnswerVerification can only be on QuestionAndAnswer replies. Only Quality votes can be down voted. | Optional | AnswerVerification |
Return Type
List
Lists thread reply votes
Usage
#set($pagedListResponse = $core_v2_forumReplyVote.List($replyId))
Parameters
Name | Type | Description | Required | Default | Options |
---|---|---|---|---|---|
replyId | int | Reply Id | Required |
Return Type
List
Lists thread reply votes
Usage
#set($pagedListResponse = $core_v2_forumReplyVote.List($replyId, "%{PageIndex = $pageIndexArg, PageSize = $pageSizeArg, SortBy = $sortByArg, SortOrder = $sortOrderArg, UserId = $userIdArg, Value = $valueArg, VoteType = $voteTypeArg}"))
Parameters
Name | Type | Description | Required | Default | Options |
---|---|---|---|---|---|
replyId | int | Reply Id | Required | ||
PageIndex | int | Specify the page number of paged results to return. Zero-based index. | Optional | 0 | |
PageSize | int | Specify the number of results to return per page. | Optional | 20 | |
SortBy | string | Sort mechanism | Optional | Date | Date |
SortOrder | string | Sort order | Optional | Descending | Ascending, Descending |
UserId | int | Specify the user id. | Optional | ||
Value | bool | Vote Value: Up (true) or Down (false). | Optional | ||
VoteType | string | Vote Type | Optional | AnswerVerification | AnswerVerification, Quality |
Return Type
Update
Updated existing vote for a thread reply for the accessing user.
Usage
#set($forumReplyVoteResponse = $core_v2_forumReplyVote.Update($replyId, "%{Value = $valueArg, VoteType = $voteTypeArg}"))
Parameters
Name | Type | Description | Required | Default | Options |
---|---|---|---|---|---|
replyId | int | Id of the reply being voted on. | Required | ||
Value | bool | Vote Value: Up (true) or Down (false). Only true is accepted when the VoteType is AnswerVerification. | Optional | True | |
VoteType | string | Either AnswerVerification or Quality. AnswerVerification can only be on QuestionAndAnswer replies. Only Quality votes can be down voted. | Optional | AnswerVerification |