ApplicationSubscriptions In-Process API Service

Ben Tiedt — Fri, 08 Mar 2024 17:31:55 GMT

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

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

Methods

bool CanCreate(Guid applicationId, Guid applicationTypeId);

Parameters

Name	Type	Description	Required	Default	Options
applicationId	`Guid`	Application Id	Required
applicationTypeId	`Guid`	Application Type Id	Required

Return Type

bool

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

Parameters

Name	Type	Description	Required
conpplicationIdatentId	`Guid`	Conpplication Idatent Id	Required
typeId	`Guid?`	Type Id	Required
subscribedUserId	`int`	Subscribed User Id	Required

Return Type

bool

ApplicationSubscription Create(Guid applicationId, Guid applicationTypeId, ApplicationSubscriptionOptions options = null);

Parameters

Name	Type	Description	Required
applicationId	`Guid`	Application Id	Required
applicationTypeId	`Guid`	Application Type Id	Required
options	`[[ApplicationSubscriptionOptions In-Process API Supplementary Type\|ApplicationSubscriptionOptions]]`	Options	Optional

Return Type

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

ApplicationSubscription Delete(Guid applicationId, Guid applicationTypeId, ApplicationSubscriptionOptions options = null);

Parameters

Name	Type	Description	Required
applicationId	`Guid`	Application Id	Required
applicationTypeId	`Guid`	Application Type Id	Required
options	`[[ApplicationSubscriptionOptions In-Process API Supplementary Type\|ApplicationSubscriptionOptions]]`	Options	Optional

Return Type

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

ApplicationSubscription Get(Guid applicationId, ApplicationSubscriptionGetOptions options = null);

Parameters

Name	Type	Description	Required	Default	Options
applicationId	`Guid`	Application Id	Required
options	`[[ApplicationSubscriptionGetOptions In-Process API Supplementary Type\|ApplicationSubscriptionGetOptions]]`	Options	Optional

Return Type

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

PagedList<ApplicationSubscription> List(ApplicationSubscriptionListOptions options = null);

Parameters

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

Return Type

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

PagedList<ApplicationSubscription> List(Guid applicationId, Guid applicationTypeId, ApplicationSubscriberListOptions options = null);

Parameters

Name	Type	Description	Required
applicationId	`Guid`	Application Id	Required
applicationTypeId	`Guid`	Application Type Id	Required
options	`[[ApplicationSubscriberListOptions In-Process API Supplementary Type\|ApplicationSubscriberListOptions]]`	Options	Optional

Return Type

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

PagedList<User> SubscribedUsers(Guid applicationId, ApplicationSubscriberListOptions options = null);

Obsolete. Obsolete in 12.0. Use List(Guid ApplicationId, Guid ApplicationTypeId, ApplicationSubscriberListOptions options) instead. Will be removed in the next major version.

Parameters

Name	Type	Description	Required	Default	Options
applicationId	`Guid`	Application Id	Required
options	`[[ApplicationSubscriberListOptions In-Process API Supplementary Type\|ApplicationSubscriberListOptions]]`	Options	Optional

Return Type

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

bool Supports(Guid applicationTypeId);

Parameters

Name	Type	Description	Required	Default	Options
applicationTypeId	`Guid`	Application Type Id	Required

Return Type

bool