ForumThreadVotes In-Process API Service

Ben Tiedt — Fri, 15 Jan 2021 19:50:38 GMT

Current Revision posted to API Documentation by Ben Tiedt on 01/15/2021 19:50:38

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

Events

Events.AfterCreate

Handler

void ForumThreadVoteAfterCreateEventHandler([[ForumThreadVoteAfterCreateEventArgs In-Process API Event Argument|ForumThreadVoteAfterCreateEventArgs]] e);

Events.AfterDelete

Handler

void ForumThreadVoteAfterDeleteEventHandler([[ForumThreadVoteAfterDeleteEventArgs In-Process API Event Argument|ForumThreadVoteAfterDeleteEventArgs]] e);

Events.AfterUpdate

Handler

void ForumThreadVoteAfterUpdateEventHandler([[ForumThreadVoteAfterUpdateEventArgs In-Process API Event Argument|ForumThreadVoteAfterUpdateEventArgs]] e);

Events.BeforeCreate

Handler

void ForumThreadVoteBeforeCreateEventHandler([[ForumThreadVoteBeforeCreateEventArgs In-Process API Event Argument|ForumThreadVoteBeforeCreateEventArgs]] e);

Events.BeforeDelete

Handler

void ForumThreadVoteBeforeDeleteEventHandler([[ForumThreadVoteBeforeDeleteEventArgs In-Process API Event Argument|ForumThreadVoteBeforeDeleteEventArgs]] e);

Events.BeforeUpdate

Handler

void ForumThreadVoteBeforeUpdateEventHandler([[ForumThreadVoteBeforeUpdateEventArgs In-Process API Event Argument|ForumThreadVoteBeforeUpdateEventArgs]] e);

Methods

ForumThreadVote Create(int threadId, ForumThreadVoteCreateOptions options = null);

Votes for a thread for the accessing user

Parameters

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

Return Type

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

AdditionalInfo Delete(int threadId, ForumThreadVoteDeleteOptions options = null);

Removes a vote for a thread for the accessing user

Parameters

Name	Type	Description	Required	Default	Options
threadId	`int`	Thread Id	Required
options	`[[ForumThreadVoteDeleteOptions In-Process API Supplementary Type\|ForumThreadVoteDeleteOptions]]`	Optional Parameter name: VoteType	Optional

Return Type

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

ForumThreadVote Get(int threadId, ForumThreadVoteGetOptions options = null);

Gets an existing vote for a thread for the accessing user

Parameters

Name	Type	Description	Required	Default	Options
threadId	`int`	Thread Id	Required
options	`[[ForumThreadVoteGetOptions In-Process API Supplementary Type\|ForumThreadVoteGetOptions]]`	OptionalParameter names are: VoteType and Value	Optional

Return Type

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

PagedList<ForumThreadVote> List(ForumThreadVoteListOptions options);

Lists thread votes

Parameters

Name	Type	Description	Required	Default	Options
options	`[[ForumThreadVoteListOptions In-Process API Supplementary Type\|ForumThreadVoteListOptions]]`	Options include: ThreadId, UserId, SortBy, SortOrder, PageSize, PageIndex	Required

Return Type

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

ForumThreadVote Update(int threadId, ForumThreadVoteUpdateOptions options = null);

Updates an existing vote for a thread for the accessing user

Parameters

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

Return Type

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