CommentVotes In-Process API Service

Ben Tiedt — Fri, 08 Mar 2024 17:31:38 GMT

Current Revision posted to API Documentation by Ben Tiedt on 03/08/2024 17:31:38

This service is available via Telligent.Evolution.Extensibility.Apis.Get<Telligent.Evolution.Extensibility.Api.Version1.ICommentVotes>() and is defined in Telligent.Evolution.Platform.dll

Events

Events.AfterCreate

Handler

void CommentVoteAfterCreateEventHandler([[CommentVoteAfterCreateEventArgs In-Process API Event Argument|CommentVoteAfterCreateEventArgs]] e);

Events.AfterDelete

Handler

void CommentVoteAfterDeleteEventHandler([[CommentVoteAfterDeleteEventArgs In-Process API Event Argument|CommentVoteAfterDeleteEventArgs]] e);

Events.AfterUpdate

Handler

void CommentVoteAfterUpdateEventHandler([[CommentVoteAfterUpdateEventArgs In-Process API Event Argument|CommentVoteAfterUpdateEventArgs]] e);

Events.BeforeCreate

Handler

void CommentVoteBeforeCreateEventHandler([[CommentVoteBeforeCreateEventArgs In-Process API Event Argument|CommentVoteBeforeCreateEventArgs]] e);

Events.BeforeDelete

Handler

void CommentVoteBeforeDeleteEventHandler([[CommentVoteBeforeDeleteEventArgs In-Process API Event Argument|CommentVoteBeforeDeleteEventArgs]] e);

Events.BeforeUpdate

Handler

void CommentVoteBeforeUpdateEventHandler([[CommentVoteBeforeUpdateEventArgs In-Process API Event Argument|CommentVoteBeforeUpdateEventArgs]] e);

Properties

Name	Type	Description	Default	Options
DataTypeId Obsolete	`Guid`	Migrate usage to scripted email or scripted plugins.

Methods

CommentVote Create(Guid commentId, bool value);

Creates a vote on a comment

Parameters

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

Return Type

[[CommentVote In-Process API Supplementary Type|CommentVote]]

AdditionalInfo Delete(Guid commentId, int userId);

Parameters

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

Return Type

[[AdditionalInfo In-Process API Supplementary Type|AdditionalInfo]]

CommentVote Get(Guid commentId, int userId);

Parameters

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

Return Type

[[CommentVote In-Process API Supplementary Type|CommentVote]]

PagedList<CommentVote> Get(CommentVoteGetOptions options = null);

Parameters

Name	Type	Description	Required	Default	Options
options	`[[CommentVoteGetOptions In-Process API Supplementary Type\|CommentVoteGetOptions]]`	options include: CommentId, UserId, Value, PageSize, PageIndex	Optional

Return Type

[[PagedList(T) In-Process API Supplementary Type|PagedList]]<[[CommentVote In-Process API Supplementary Type|CommentVote]]>

CommentVote Update(Guid commentId, bool value);

Parameters

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

Return Type

[[CommentVote In-Process API Supplementary Type|CommentVote]]