ArticleVersions In-Process API Service

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

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

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

Events

Events.AfterCreate

Handler

void ArticleVersionAfterCreateEventHandler([[ArticleVersionAfterCreateEventArgs In-Process API Event Argument|ArticleVersionAfterCreateEventArgs]] e);

Events.AfterDelete

Handler

void ArticleVersionAfterDeleteEventHandler([[ArticleVersionAfterDeleteEventArgs In-Process API Event Argument|ArticleVersionAfterDeleteEventArgs]] e);

Events.AfterUpdate

Handler

void ArticleVersionAfterUpdateEventHandler([[ArticleVersionAfterUpdateEventArgs In-Process API Event Argument|ArticleVersionAfterUpdateEventArgs]] e);

Events.BeforeCreate

Handler

void ArticleVersionBeforeCreateEventHandler([[ArticleVersionBeforeCreateEventArgs In-Process API Event Argument|ArticleVersionBeforeCreateEventArgs]] e);

Events.BeforeDelete

Handler

void ArticleVersionBeforeDeleteEventHandler([[ArticleVersionBeforeDeleteEventArgs In-Process API Event Argument|ArticleVersionBeforeDeleteEventArgs]] e);

Events.BeforeUpdate

Handler

void ArticleVersionBeforeUpdateEventHandler([[ArticleVersionBeforeUpdateEventArgs In-Process API Event Argument|ArticleVersionBeforeUpdateEventArgs]] e);

Events.Render

Handler

void ArticleVersionRenderEventHandler([[ArticleVersionRenderEventArgs In-Process API Event Argument|ArticleVersionRenderEventArgs]] e);

Methods

ArticleVersion Create(string title, string body, int typeId, ArticleVersionCreateOptions options = null);

Used to create a new article in a collection or a new article version for an existing article.

Parameters

Name	Type	Description	Required
title	`string`	Title	Required
body	`string`	Body	Required
typeId	`int`	Type Id	Required
options	`[[ArticleVersionCreateOptions In-Process API Supplementary Type\|ArticleVersionCreateOptions]]`	Options	Optional

Return Type

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

AdditionalInfo Delete(Guid articleId, Guid version);

Parameters

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

Return Type

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

ArticleVersion Get(Guid articleId, Guid version);

Parameters

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

Return Type

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

PagedList<ArticleVersion> List(Guid articleId, ArticleVersionListOptions options = null);

Parameters

Name	Type	Description	Required	Default	Options
articleId	`Guid`	Article Id	Required
options	`[[ArticleVersionListOptions In-Process API Supplementary Type\|ArticleVersionListOptions]]`	Options	Optional

Return Type

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

ArticleVersion Undelete(Guid articleId, Guid version);

Parameters

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

Return Type

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

ArticleVersion Update(Guid articleId, Guid version, ArticleVersionUpdateOptions options);

Used to update an existing article version.

Parameters

Name	Type	Description	Required
articleId	`Guid`	Article Id	Required
version	`Guid`	Version	Required
options	`[[ArticleVersionUpdateOptions In-Process API Supplementary Type\|ArticleVersionUpdateOptions]]`	Options	Required

Return Type

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