ContentSubscriptions In-Process API Service

Ben Tiedt — Tue, 19 Nov 2019 20:06:07 GMT

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

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

Properties

Name	Type	Description	Default	Options
DataTypeId	`Guid`

Methods

bool CanCreate(Guid contentId, Guid contentTypeId);

Parameters

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

Return Type

bool

bool CanDelete(Guid contentId, Guid? typeId, int subscribedUserId);

Parameters

Name	Type	Description	Required
contentId	`Guid`	Content Id	Required
typeId	`Guid?`	Type Id	Required
subscribedUserId	`int`	Subscribed User Id	Required

Return Type

bool

ContentSubscription Create(Guid contentId, Guid contentTypeId, ContentSubscriptionOptions options = null);

Parameters

Name	Type	Description	Required
contentId	`Guid`	Content Id	Required
contentTypeId	`Guid`	Content Type Id	Required
options	`[[ContentSubscriptionOptions In-Process API Supplementary Type\|ContentSubscriptionOptions]]`	Options	Optional

Return Type

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

ContentSubscription Delete(Guid contentId, Guid contentTypeId, ContentSubscriptionOptions options = null);

Parameters

Name	Type	Description	Required
contentId	`Guid`	Content Id	Required
contentTypeId	`Guid`	Content Type Id	Required
options	`[[ContentSubscriptionOptions In-Process API Supplementary Type\|ContentSubscriptionOptions]]`	Options	Optional

Return Type

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

ContentSubscription Get(Guid contentId, ContentSubscriptionGetOptions options = null);

Parameters

Name	Type	Description	Required	Default	Options
contentId	`Guid`	Content Id	Required
options	`[[ContentSubscriptionGetOptions In-Process API Supplementary Type\|ContentSubscriptionGetOptions]]`	Options	Optional

Return Type

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

PagedList<ContentSubscription> List(ContentSubscriptionListOptions options = null);

Parameters

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

Return Type

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

void MuteSubscription(Guid contentId, Guid contentTypeId, bool isMuted, ContentSubscriptionMuteOptions options = null);

Parameters

Name	Type	Description	Required
contentId	`Guid`	Content Id	Required
contentTypeId	`Guid`	Content Type Id	Required
isMuted	`bool`	Is Muted	Required
options	`[[ContentSubscriptionMuteOptions In-Process API Supplementary Type\|ContentSubscriptionMuteOptions]]`	Options	Optional

PagedList<User> SubscribedUsers(Guid contentId, ContentSubscriberListOptions options = null);

Parameters

Name	Type	Description	Required	Default	Options
contentId	`Guid`	Content Id	Required
options	`[[ContentSubscriberListOptions In-Process API Supplementary Type\|ContentSubscriberListOptions]]`	Options	Optional

Return Type

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

bool Supports(Guid contentTypeId);

Parameters

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

Return Type

bool