Features (v2) In-Process API Service

Ben Tiedt — Tue, 19 Nov 2019 20:04:39 GMT

Current Revision posted to API Documentation by Ben Tiedt on 11/19/2019 20:04:39

This service is available via Telligent.Evolution.Extensibility.Apis.Get<Telligent.Evolution.Extensibility.Api.Version2.IFeatures>() and is defined in Telligent.Evolution.Platform.dll

Events

Events.AfterCreate

Handler

void FeaturedContentAfterFeatureCreateEventHandler([[FeaturedContentAfterFeatureCreateEventArgs (v2) In-Process API Event Argument|FeaturedContentAfterFeatureCreateEventArgs]] e);

Events.AfterDelete

Handler

void FeaturedContentAfterFeatureDeleteEventHandler([[FeaturedContentAfterFeatureDeleteEventArgs (v2) In-Process API Event Argument|FeaturedContentAfterFeatureDeleteEventArgs]] e);

Events.AfterUpdate

Handler

void FeaturedContentAfterFeatureUpdateEventHandler([[FeaturedContentAfterFeatureUpdateEventArgs (v2) In-Process API Event Argument|FeaturedContentAfterFeatureUpdateEventArgs]] e);

Events.BeforeCreate

Handler

void FeaturedContentBeforeFeatureCreateEventHandler([[FeaturedContentBeforeFeatureCreateEventArgs (v2) In-Process API Event Argument|FeaturedContentBeforeFeatureCreateEventArgs]] e);

Events.BeforeDelete

Handler

void FeaturedContentBeforeFeatureDeleteEventHandler([[FeaturedContentBeforeFeatureDeleteEventArgs (v2) In-Process API Event Argument|FeaturedContentBeforeFeatureDeleteEventArgs]] e);

Events.BeforeUpdate

Handler

void FeaturedContentBeforeFeatureUpdateEventHandler([[FeaturedContentBeforeFeatureUpdateEventArgs (v2) In-Process API Event Argument|FeaturedContentBeforeFeatureUpdateEventArgs]] e);

Methods

bool CanFeature(Guid contentId, Guid contentTypeId);

Identifies if the accessing user can feature the specified content

Parameters

Name	Type	Description	Required	Default	Options
contentId	`Guid`	Content Id	Required
contentTypeId	`Guid`	Content Type Id	Required

Return Type

bool

bool CanFeature(string contentUrl, Guid oauthClientId);

Identifies if the accessing user can feature the specified external content

Parameters

Name	Type	Description	Required	Default	Options
contentUrl	`string`	Content Url	Required
oauthClientId	`Guid`	Oauth Client Id	Required

Return Type

bool

Feature Create(Guid contentId, Guid contentTypeId, FeaturesCreateOptions options);

Features an item

Parameters

Name	Type	Description	Required
contentId	`Guid`	Content Id	Required
contentTypeId	`Guid`	Content Type Id	Required
options	`[[FeaturesCreateOptions (v2) In-Process API Supplementary Type\|FeaturesCreateOptions]]`	Options	Required

Return Type

[[Feature (v2) In-Process API Supplementary Type|Feature]]

Feature Create(string contentUrl, Guid oauthClientId, FeaturesCreateOptions options);

Features an external item

Parameters

Name	Type	Description	Required
contentUrl	`string`	Content Url	Required
oauthClientId	`Guid`	Oauth Client Id	Required
options	`[[FeaturesCreateOptions (v2) In-Process API Supplementary Type\|FeaturesCreateOptions]]`	Options	Required

Return Type

[[Feature (v2) In-Process API Supplementary Type|Feature]]

AdditionalInfo Delete(Guid contentId, Guid contentTypeId, FeaturesDeleteOptions options);

Removes a featured item

Parameters

Name	Type	Description	Required
contentId	`Guid`	Content Id	Required
contentTypeId	`Guid`	Content Type Id	Required
options	`[[FeaturesDeleteOptions (v2) In-Process API Supplementary Type\|FeaturesDeleteOptions]]`	Options	Required

Return Type

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

AdditionalInfo Delete(string contentUrl, Guid oauthClientId, FeaturesDeleteOptions options);

Removes an external featured item

Parameters

Name	Type	Description	Required
contentUrl	`string`	Content Url	Required
oauthClientId	`Guid`	Oauth Client Id	Required
options	`[[FeaturesDeleteOptions (v2) In-Process API Supplementary Type\|FeaturesDeleteOptions]]`	Options	Required

Return Type

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

Feature Get(Guid contentId, Guid contentTypeId, FeaturesGetOptions options);

Get a featured item

Parameters

Name	Type	Description	Required
contentId	`Guid`	Content Id	Required
contentTypeId	`Guid`	Content Type Id	Required
options	`[[FeaturesGetOptions (v2) In-Process API Supplementary Type\|FeaturesGetOptions]]`	Options	Required

Return Type

[[Feature (v2) In-Process API Supplementary Type|Feature]]

Feature Get(string contentUrl, Guid oauthClientId, FeaturesGetOptions options);

Get an external featured item

Parameters

Name	Type	Description	Required
contentUrl	`string`	Content Url	Required
oauthClientId	`Guid`	Oauth Client Id	Required
options	`[[FeaturesGetOptions (v2) In-Process API Supplementary Type\|FeaturesGetOptions]]`	Options	Required

Return Type

[[Feature (v2) In-Process API Supplementary Type|Feature]]

PagedList<Feature> List(FeaturesListOptions options = null);

Lists featured items

Parameters

Name	Type	Description	Required	Default	Options
options	`[[FeaturesListOptions (v2) In-Process API Supplementary Type\|FeaturesListOptions]]`	Optional parameter names are: UserId, GroupId, ApplicationId, Count	Optional

Return Type

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

bool SupportsFeatures(Guid contentTypeId);

Determines if the supplied content type supports features

Parameters

Name	Type	Description	Required	Default	Options
contentTypeId	`Guid`	Content Type Id	Required

Return Type

bool

Feature Update(Guid contentId, Guid contentTypeId, FeaturesUpdateOptions options);

Updates a featured item

Parameters

Name	Type	Description	Required
contentId	`Guid`	Content Id	Required
contentTypeId	`Guid`	Content Type Id	Required
options	`[[FeaturesUpdateOptions (v2) In-Process API Supplementary Type\|FeaturesUpdateOptions]]`	Options	Required

Return Type

[[Feature (v2) In-Process API Supplementary Type|Feature]]

Feature Update(string contentUrl, Guid oauthClientId, FeaturesUpdateOptions options);

Updates an external featured item

Parameters

Name	Type	Description	Required
contentUrl	`string`	Content Url	Required
oauthClientId	`Guid`	Oauth Client Id	Required
options	`[[FeaturesUpdateOptions (v2) In-Process API Supplementary Type\|FeaturesUpdateOptions]]`	Options	Required

Return Type

[[Feature (v2) In-Process API Supplementary Type|Feature]]