ArticleCollections In-Process API Service

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

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

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

Events

Events.AfterCreate

Handler

void ArticleCollectionAfterCreateEventHandler([[ArticleCollectionAfterCreateEventArgs In-Process API Event Argument|ArticleCollectionAfterCreateEventArgs]] e);

Events.AfterDelete

Handler

void ArticleCollectionAfterDeleteEventHandler([[ArticleCollectionAfterDeleteEventArgs In-Process API Event Argument|ArticleCollectionAfterDeleteEventArgs]] e);

Events.AfterUpdate

Handler

void ArticleCollectionAfterUpdateEventHandler([[ArticleCollectionAfterUpdateEventArgs In-Process API Event Argument|ArticleCollectionAfterUpdateEventArgs]] e);

Events.BeforeCreate

Handler

void ArticleCollectionBeforeCreateEventHandler([[ArticleCollectionBeforeCreateEventArgs In-Process API Event Argument|ArticleCollectionBeforeCreateEventArgs]] e);

Events.BeforeDelete

Handler

void ArticleCollectionBeforeDeleteEventHandler([[ArticleCollectionBeforeDeleteEventArgs In-Process API Event Argument|ArticleCollectionBeforeDeleteEventArgs]] e);

Events.BeforeUpdate

Handler

void ArticleCollectionBeforeUpdateEventHandler([[ArticleCollectionBeforeUpdateEventArgs In-Process API Event Argument|ArticleCollectionBeforeUpdateEventArgs]] e);

Events.Render

Handler

void ArticleCollectionRenderEventHandler([[ArticleCollectionRenderEventArgs In-Process API Event Argument|ArticleCollectionRenderEventArgs]] e);

Events.SelectTheme

Handler

void ArticleCollectionSelectThemeEventHandler([[ArticleCollectionSelectThemeEventArgs In-Process API Event Argument|ArticleCollectionSelectThemeEventArgs]] e);

Properties

Name	Type	Description	Default	Options
ApplicationTypeId	`Guid`
ThemeTypeId	`Guid`
TotalLicensedRemaining	`int`

Methods

ArticleCollection Create(int groupId, string name, ArticleCollectionsCreateOptions options = null);

Parameters

Name	Type	Description	Required
groupId	`int`	Group Id	Required
name	`string`	Name	Required
options	`[[ArticleCollectionsCreateOptions In-Process API Supplementary Type\|ArticleCollectionsCreateOptions]]`	Options	Optional

Return Type

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

AdditionalInfo Delete(Guid id);

Parameters

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

Return Type

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

ArticleCollection Get(ArticleCollectionsGetOptions options);

Parameters

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

Return Type

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

PagedList<ArticleCollection> List(ArticleCollectionsListOptions options = null);

Parameters

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

Return Type

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

ApiList<ArticleCollection> Lookup(string queryText, ArticleCollectionLookupOptions options = null);

Parameters

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

Return Type

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

ArticleCollection Undelete(Guid id);

Parameters

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

Return Type

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

ArticleCollection Update(Guid id, ArticleCollectionsUpdateOptions options);

Parameters

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

Return Type

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