Categories In-Process API Service

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

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

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

Events

Events.AfterCreate

Handler

void CategoryAfterCreateEventHandler([[CategoryAfterCreateEventArgs In-Process API Event Argument|CategoryAfterCreateEventArgs]] e);

Events.AfterDelete

Handler

void CategoryAfterDeleteEventHandler([[CategoryAfterDeleteEventArgs In-Process API Event Argument|CategoryAfterDeleteEventArgs]] e);

Events.AfterUpdate

Handler

void CategoryAfterUpdateEventHandler([[CategoryAfterUpdateEventArgs In-Process API Event Argument|CategoryAfterUpdateEventArgs]] e);

Events.BeforeCreate

Handler

void CategoryBeforeCreateEventHandler([[CategoryBeforeCreateEventArgs In-Process API Event Argument|CategoryBeforeCreateEventArgs]] e);

Events.BeforeDelete

Handler

void CategoryBeforeDeleteEventHandler([[CategoryBeforeDeleteEventArgs In-Process API Event Argument|CategoryBeforeDeleteEventArgs]] e);

Events.BeforeUpdate

Handler

void CategoryBeforeUpdateEventHandler([[CategoryBeforeUpdateEventArgs In-Process API Event Argument|CategoryBeforeUpdateEventArgs]] e);

Methods

Category Create(Guid collectionId, string name, CategoryCreateOptions options = null);

Parameters

Name	Type	Description	Required
collectionId	`Guid`	Collection Id	Required
name	`string`	Name	Required
options	`[[CategoryCreateOptions In-Process API Supplementary Type\|CategoryCreateOptions]]`	Options	Optional

Return Type

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

AdditionalInfo Delete(int Id, CategoryDeleteOptions options = null);

Parameters

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

Return Type

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

Category Get(CategoryGetOptions options);

Parameters

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

Return Type

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

ApiList<Category> List(Guid collectionId, CategoryListOptions options = null);

Parameters

Name	Type	Description	Required	Default	Options
collectionId	`Guid`	Collection Id	Required
options	`[[CategoryListOptions In-Process API Supplementary Type\|CategoryListOptions]]`	Options	Optional

Return Type

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

ApiList<Category> Lookup(string queryText, CategoryLookupOptions options = null);

Parameters

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

Return Type

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

Category Undelete(int Id);

Parameters

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

Return Type

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

Category Update(int Id, CategoryUpdateOptions options);

Parameters

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

Return Type

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