Articles In-Process API Service

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

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

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

Events

Events.AfterCreate

Handler

void ArticleAfterCreateEventHandler([[ArticleAfterCreateEventArgs In-Process API Event Argument|ArticleAfterCreateEventArgs]] e);

Events.AfterDelete

Handler

void ArticleAfterDeleteEventHandler([[ArticleAfterDeleteEventArgs In-Process API Event Argument|ArticleAfterDeleteEventArgs]] e);

Events.AfterUpdate

Handler

void ArticleAfterUpdateEventHandler([[ArticleAfterUpdateEventArgs In-Process API Event Argument|ArticleAfterUpdateEventArgs]] e);

Events.BeforeCreate

Handler

void ArticleBeforeCreateEventHandler([[ArticleBeforeCreateEventArgs In-Process API Event Argument|ArticleBeforeCreateEventArgs]] e);

Events.BeforeDelete

Handler

void ArticleBeforeDeleteEventHandler([[ArticleBeforeDeleteEventArgs In-Process API Event Argument|ArticleBeforeDeleteEventArgs]] e);

Events.BeforeUpdate

Handler

void ArticleBeforeUpdateEventHandler([[ArticleBeforeUpdateEventArgs In-Process API Event Argument|ArticleBeforeUpdateEventArgs]] e);

Events.Render

Handler

void ArticleRenderEventHandler([[ArticleRenderEventArgs In-Process API Event Argument|ArticleRenderEventArgs]] e);

Properties

Name	Type	Description	Default	Options
ContentTypeId	`Guid`

Methods

AdditionalInfo Delete(Guid id);

Parameters

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

Return Type

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

Article Get(ArticleGetOptions options);

Parameters

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

Return Type

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

PagedList<Article> List(ArticleListOptions options = null);

Parameters

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

Return Type

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

ApiList<Article> Lookup(string queryText, ArticleLookupOptions options = null);

Parameters

Name	Type	Description	Required	Default	Options
queryText	`string`	Query Text	Required
options	`[[ArticleLookupOptions In-Process API Supplementary Type\|ArticleLookupOptions]]`	Options	Optional

Return Type

[[ApiList(T) In-Process API Supplementary Type|ApiList]]<[[Article In-Process API Supplementary Type|Article]]>

Article Undelete(Guid id);

Parameters

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

Return Type

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