Helpfulness In-Process API Service

Ben Tiedt — Fri, 08 Mar 2024 17:30:36 GMT

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

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

Events

Events.AfterCreate

Handler

void HelpfulnessAfterCreateEventHandler([[HelpfulnessAfterCreateEventArgs In-Process API Event Argument|HelpfulnessAfterCreateEventArgs]] e);

Events.AfterUpdate

Handler

void HelpfulnessAfterUpdateEventHandler([[HelpfulnessAfterUpdateEventArgs In-Process API Event Argument|HelpfulnessAfterUpdateEventArgs]] e);

Events.BeforeCreate

Handler

void HelpfulnessBeforeCreateEventHandler([[HelpfulnessBeforeCreateEventArgs In-Process API Event Argument|HelpfulnessBeforeCreateEventArgs]] e);

Events.BeforeUpdate

Handler

void HelpfulnessBeforeUpdateEventHandler([[HelpfulnessBeforeUpdateEventArgs In-Process API Event Argument|HelpfulnessBeforeUpdateEventArgs]] e);

Methods

AdditionalInfo Delete(int id);

Parameters

Name	Type	Description	Required	Default	Options
id	`int`	Id	Required

Return Type

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

Helpfulness Get(int id);

Parameters

Name	Type	Description	Required	Default	Options
id	`int`	Id	Required

Return Type

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

Helpfulness IsHelpful(Guid articleId);

Parameters

Name	Type	Description	Required	Default	Options
articleId	`Guid`	Article Id	Required

Return Type

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

PagedList<Helpfulness> List(HelpfulnessListOptions options);

Parameters

Name	Type	Description	Required	Default	Options
options	`[[HelpfulnessListOptions In-Process API Supplementary Type\|HelpfulnessListOptions]]`	Options	Required

Return Type

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

Helpfulness NotHelpful(Guid articleId, int responseTypeId, HelpfulnessCreateOptions options);

Parameters

Name	Type	Description	Required
articleId	`Guid`	Article Id	Required
responseTypeId	`int`	Response Type Id	Required
options	`[[HelpfulnessCreateOptions In-Process API Supplementary Type\|HelpfulnessCreateOptions]]`	Options	Required

Return Type

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

Helpfulness Update(int id, HelpfulnessUpdateOptions options);

Parameters

Name	Type	Description	Required	Default	Options
id	`int`	Id	Required
options	`[[HelpfulnessUpdateOptions In-Process API Supplementary Type\|HelpfulnessUpdateOptions]]`	Options	Required

Return Type

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