core_v2_forumReplyVote Script API

Enables scripted content fragments to use Forum Reply Shares

Create
Delete
Get
List
Update

Methods

Create

Votes for a thread reply for the accessing user

Velocity

#set($forumReplyVoteResponse = $core_v2_forumReplyVote.Create($replyId, "%{ Value = $valueArg, VoteType = $voteTypeArg }"))

JavaScript

var forumReplyVoteResponse = core_v2_forumReplyVote.Create(replyId, { Value: valueArg, VoteType: voteTypeArg });

Parameters

Name	Type	Description	Required	Default
replyId	`Int32`	Id of the reply being voted on	Required
options	Options	Set of optional parameters including:	Required
Value	`Boolean`	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

Returns

ForumReplyVote

Delete

Removes a vote for a thread reply for the accessing user

Velocity

#set($additionalInfoResponse = $core_v2_forumReplyVote.Delete($replyId, "%{ VoteType = $voteTypeArg }"))

JavaScript

var additionalInfoResponse = core_v2_forumReplyVote.Delete(replyId, { VoteType: voteTypeArg });

Parameters

Name	Type	Description	Required	Default
replyId	`Int32`	Id of the reply that was voted on	Required
options	Options	Set of optional parameters including:	Required
VoteType	`String`	Either AnswerVerification or Quality. AnswerVerification can only be on QuestionAndAnswer replies. Only Quality votes can be down voted.	Optional	AnswerVerification

Returns

AdditionalInfo

Get

Get Overload 1

Gets an existing AnswerVerification vote for a thread reply for the accessing user

Velocity

#set($forumReplyVoteResponse = $core_v2_forumReplyVote.Get($replyId))

JavaScript

var forumReplyVoteResponse = core_v2_forumReplyVote.Get(replyId);

Parameters

Name	Type	Description	Required	Default	Options
replyId	`Int32`	Id of the reply voted on	Required

Get Overload 2

Gets an existing AnswerVerification vote for a thread reply for the accessing user

Velocity

#set($forumReplyVoteResponse = $core_v2_forumReplyVote.Get($replyId, "%{ VoteType = $voteTypeArg }"))

JavaScript

var forumReplyVoteResponse = core_v2_forumReplyVote.Get(replyId, { VoteType: voteTypeArg });

Parameters

Name	Type	Description	Required	Default
replyId	`Int32`	Id of the reply voted on	Required
options	Options	Set of optional parameters including:	Required
VoteType	`String`	Either AnswerVerification or Quality. AnswerVerification can only be on QuestionAndAnswer replies. Only Quality votes can be down voted.	Optional	AnswerVerification

Returns

ForumReplyVote

List

List Overload 1

Lists thread reply votes

Velocity

#set($pagedListResponse = $core_v2_forumReplyVote.List($replyId))

JavaScript

var pagedListResponse = core_v2_forumReplyVote.List(replyId);

Parameters

Name	Type	Description	Required	Default	Options
replyId	`Int32`	Reply Id	Required

List Overload 2

Lists thread reply votes

Velocity

#set($pagedListResponse = $core_v2_forumReplyVote.List($replyId, "%{ PageIndex = $pageIndexArg, PageSize = $pageSizeArg, SortBy = $sortByArg, SortOrder = $sortOrderArg, UserId = $userIdArg, Value = $valueArg, VoteType = $voteTypeArg }"))

JavaScript

var 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	`Int32`	Reply Id	Required
options	Options	Set of optional parameters including:	Required
PageIndex	`Int32`	Specify the page number of paged results to return. Zero-based index.	Optional	0
PageSize	`Int32`	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	`Int32`	Specify the user id.	Optional
Value	`Boolean`	Vote Value: Up (true) or Down (false).	Optional
VoteType	`String`	Vote Type	Optional	AnswerVerification	AnswerVerification, Quality

Returns

PagedList of ForumReplyVote

Update

Updated existing vote for a thread reply for the accessing user.

Velocity

#set($forumReplyVoteResponse = $core_v2_forumReplyVote.Update($replyId, "%{ Value = $valueArg, VoteType = $voteTypeArg }"))

JavaScript

var forumReplyVoteResponse = core_v2_forumReplyVote.Update(replyId, { Value: valueArg, VoteType: voteTypeArg });

Parameters

Name	Type	Description	Required	Default
replyId	`Int32`	Id of the reply being voted on.	Required
options	Options	Set of optional parameters including:	Required
Value	`Boolean`	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

Returns

ForumReplyVote

Recommended