core_v2_commentVotes Script API

Ben Tiedt — Fri, 23 Apr 2021 19:56:13 GMT

Current Revision posted to API Documentation by Ben Tiedt on 04/23/2021 19:56:13

Create
Delete
Get
List
Update

Methods

Create

Creates a vote on a comment

Velocity

#set($commentVoteResponse = $core_v2_commentVotes.Create($commentId, $value))

JavaScript

var commentVoteResponse = core_v2_commentVotes.Create(commentId, value);

Parameters

Name	Type	Description	Required	Default	Options
commentId	`Guid`	Id of the comment	Required
value	`Boolean`	Vote value: Up(true) or Down(false)	Required

Returns

[[CommentVote Script API Type|CommentVote]]

Delete

Deletes a comment vote

Velocity

#set($additionalInfoResponse = $core_v2_commentVotes.Delete($commentId, $userId))

JavaScript

var additionalInfoResponse = core_v2_commentVotes.Delete(commentId, userId);

Parameters

Name	Type	Description	Required	Default	Options
commentId	`Guid`	Id of the comment	Required
userId	`Int32`	Id of the user	Required

Returns

[[AdditionalInfo Script API Type|AdditionalInfo]]

Get

Get a vote on a comment

Velocity

#set($commentVoteResponse = $core_v2_commentVotes.Get($commentId, $userId))

JavaScript

var commentVoteResponse = core_v2_commentVotes.Get(commentId, userId);

Parameters

Name	Type	Description	Required	Default	Options
commentId	`Guid`	Id of the comment	Required
userId	`Int32`	Id of the user	Required

Returns

[[CommentVote Script API Type|CommentVote]]

List

Get a list of comment votes

Velocity

#set($pagedListResponse = $core_v2_commentVotes.List("%{ CommentId = $commentIdArg, PageIndex = $pageIndexArg, PageSize = $pageSizeArg, UserId = $userIdArg, Value = $valueArg }"))

JavaScript

var pagedListResponse = core_v2_commentVotes.List({ CommentId: commentIdArg, PageIndex: pageIndexArg, PageSize: pageSizeArg, UserId: userIdArg, Value: valueArg });

Parameters

Name	Type	Description	Required	Default
options	Options	Set of optional parameters including:	Required
CommentId	`Guid`	Id of the comment	Optional
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
UserId	`Int32`	Id of the user	Optional
Value	`Boolean`	Vote value: Up(trure) or Down(false)	Optional

Returns

[[PagedList Script API Type|PagedList]] of [[CommentVote Script API Type|CommentVote]]

Update

Velocity

#set($commentVoteResponse = $core_v2_commentVotes.Update($commentId, $value))

JavaScript

var commentVoteResponse = core_v2_commentVotes.Update(commentId, value);

Parameters

Name	Type	Description	Required	Default	Options
commentId	`Guid`	Comment Id	Required
value	`Boolean`	Value	Required

Returns

[[CommentVote Script API Type|CommentVote]]