PublishGroups In-Process API Service

Ben Tiedt — Fri, 15 Jan 2021 19:52:13 GMT

Current Revision posted to API Documentation by Ben Tiedt on 01/15/2021 19:52:13

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

Methods

PublishGroup Create(Guid collectionId, string name, PublishGroupCreateOptions options = null);

Parameters

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

Return Type

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

AdditionalInfo Delete(int id);

Parameters

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

Return Type

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

PublishGroup Get(int id);

Parameters

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

Return Type

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

PagedList<PublishGroup> List(Guid collectionId, PublishGroupListOptions options = null);

Parameters

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

Return Type

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

ApiList<PublishGroup> Lookup(string query, Guid collectionId);

Parameters

Name	Type	Description	Required	Default	Options
query	`string`	Query	Required
collectionId	`Guid`	Collection Id	Required

Return Type

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

PublishGroup Update(int id, PublishGroupUpdateOptions options);

Parameters

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

Return Type

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