ForumReplyVotes In-Process API Service

Ben Tiedt — Fri, 08 Mar 2024 17:32:27 GMT

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

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

Events

Events.AfterCreate

Handler

void ForumReplyVoteAfterCreateEventHandler([[ForumReplyVoteAfterCreateEventArgs In-Process API Event Argument|ForumReplyVoteAfterCreateEventArgs]] e);

Events.AfterDelete

Handler

void ForumReplyVoteAfterDeleteEventHandler([[ForumReplyVoteAfterDeleteEventArgs In-Process API Event Argument|ForumReplyVoteAfterDeleteEventArgs]] e);

Events.AfterUpdate

Handler

void ForumReplyVoteAfterUpdateEventHandler([[ForumReplyVoteAfterUpdateEventArgs In-Process API Event Argument|ForumReplyVoteAfterUpdateEventArgs]] e);

Events.BeforeCreate

Handler

void ForumReplyVoteBeforeCreateEventHandler([[ForumReplyVoteBeforeCreateEventArgs In-Process API Event Argument|ForumReplyVoteBeforeCreateEventArgs]] e);

Events.BeforeDelete

Handler

void ForumReplyVoteBeforeDeleteEventHandler([[ForumReplyVoteBeforeDeleteEventArgs In-Process API Event Argument|ForumReplyVoteBeforeDeleteEventArgs]] e);

Events.BeforeUpdate

Handler

void ForumReplyVoteBeforeUpdateEventHandler([[ForumReplyVoteBeforeUpdateEventArgs In-Process API Event Argument|ForumReplyVoteBeforeUpdateEventArgs]] e);

Properties

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

Methods

ForumReplyVote Create(int replyId, ForumReplyVoteCreateOptions options = null);

Votes for a thread reply for the accessing user

Parameters

Name	Type	Description	Required	Default	Options
replyId	`int`	Reply Id	Required
options	`[[ForumReplyVoteCreateOptions In-Process API Supplementary Type\|ForumReplyVoteCreateOptions]]`	Optional parameter names are: VoteType and Value	Optional

Return Type

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

AdditionalInfo Delete(int replyId, ForumReplyVoteDeleteOptions options = null);

Removes a vote for a thread reply for the accessing user

Parameters

Name	Type	Description	Required	Default	Options
replyId	`int`	Reply Id	Required
options	`[[ForumReplyVoteDeleteOptions In-Process API Supplementary Type\|ForumReplyVoteDeleteOptions]]`	Optional parameter name: VoteType	Optional

Return Type

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

ForumReplyVote Get(int replyId, ForumReplyVoteGetOptions options = null);

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

Parameters

Name	Type	Description	Required	Default	Options
replyId	`int`	Reply Id	Required
options	`[[ForumReplyVoteGetOptions In-Process API Supplementary Type\|ForumReplyVoteGetOptions]]`	Optional parameter names are: VoteType and Value	Optional

Return Type

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

PagedList<ForumReplyVote> List(ForumReplyVoteListOptions options = null);

Lists thread reply votes

Parameters

Name	Type	Description	Required	Default	Options
options	`[[ForumReplyVoteListOptions In-Process API Supplementary Type\|ForumReplyVoteListOptions]]`	Options include: ReplyId, UserId, VoteType, Value, SortBy, SortOrder, PageSize, PageIndex	Optional

Return Type

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

ForumReplyVote Update(int replyId, ForumReplyVoteUpdateOptions options = null);

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

Parameters

Name	Type	Description	Required	Default	Options
replyId	`int`	Reply Id	Required
options	`[[ForumReplyVoteUpdateOptions In-Process API Supplementary Type\|ForumReplyVoteUpdateOptions]]`	Optional parameter names are: VoteType and Value	Optional

Return Type

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