Enables scripted content fragments to use application subscriptions
Methods
CanDeleteSubscription
Returns whether the accessing user can delete a subscription to an application
Usage
#set($booleanResponse = $core_v2_applicationSubscription.CanDeleteSubscription($applicationId, $subscribedUserId, "%{TypeId = $typeIdArg}"))
Parameters
Name | Type | Description | Required | Default | Options |
---|---|---|---|---|---|
applicationId | Guid | Application Id | Required | ||
subscribedUserId | int | User who subscribed the application | Required | ||
TypeId | Guid | Categorization type | Optional |
Return Type
bool
CanDeleteSubscription
Returns whether the accessing user can delete a subscription to an application
Usage
#set($booleanResponse = $core_v2_applicationSubscription.CanDeleteSubscription($applicationId, $subscribedUserId))
Parameters
Name | Type | Description | Required | Default | Options |
---|---|---|---|---|---|
applicationId | Guid | Application Id | Required | ||
subscribedUserId | int | User who subscribed the content | Required |
Return Type
bool
CanSubscribe
Identifies if the accessing user can bookmark the specified application
Usage
#set($booleanResponse = $core_v2_applicationSubscription.CanSubscribe($applicationId, $applicationTypeId))
Parameters
Name | Type | Description | Required | Default | Options |
---|---|---|---|---|---|
applicationId | Guid | Application Id | Required | ||
applicationTypeId | Guid | Application Type Id | Required |
Return Type
bool
Create
Set a subscription to a piece of content
Usage
#set($applicationSubscriptionResponse = $core_v2_applicationSubscription.Create($applicationId, $applicationTypeId, "%{TypeId = $typeIdArg}"))
Parameters
Name | Type | Description | Required | Default | Options |
---|---|---|---|---|---|
applicationId | Guid | Application Id | Required | ||
applicationTypeId | Guid | Application Type Id | Required | ||
TypeId | Guid | Optional Type Id of the subscription. | Optional |
Return Type
Delete
Remove a subscription to a piece of content
Usage
#set($applicationSubscriptionResponse = $core_v2_applicationSubscription.Delete($applicationId, $applicationTypeId, "%{TypeId = $typeIdArg}"))
Parameters
Name | Type | Description | Required | Default | Options |
---|---|---|---|---|---|
applicationId | Guid | Application Id | Required | ||
applicationTypeId | Guid | Application Type Id | Required | ||
TypeId | Guid | Optional Type Id of the subscription. | Optional |
Return Type
Get
Retrieve a subscription to an application
Usage
#set($applicationSubscriptionResponse = $core_v2_applicationSubscription.Get($applicationId, "%{TypeId = $typeIdArg}"))
Parameters
Name | Type | Description | Required | Default | Options |
---|---|---|---|---|---|
applicationId | Guid | Application Id | Required | ||
TypeId | Guid | Optional Type Id of the subscription. | Optional |
Return Type
List
List application subscriptions for the accessing user
Usage
#set($pagedListResponse = $core_v2_applicationSubscription.List("%{ApplicationId = $applicationIdArg, ApplicationTypeId = $applicationTypeIdArg, ContainerId = $containerIdArg, IncludeSubContainers = $includeSubContainersArg, PageIndex = $pageIndexArg, PageSize = $pageSizeArg, TypeId = $typeIdArg}"))
Parameters
Name | Type | Description | Required | Default | Options |
---|---|---|---|---|---|
ApplicationId | Guid | Filter to this application. | Optional | ||
ApplicationTypeId | Guid | Filter to this application type. | Optional | ||
ContainerId | Guid | Filter to this container. | Optional | ||
IncludeSubContainers | bool | Include subcontainers of the ContainerId. | Optional | ||
PageIndex | int | Page index for the results. | Optional | ||
PageSize | int | Page size for the results. | Optional | ||
TypeId | Guid | Optional Type Id of the subscription. | Optional |
Return Type
PagedList<ApplicationSubscription>
SupportsSubscriptions
Identifies whether the specified application type supports subscriptions
Usage
#set($booleanResponse = $core_v2_applicationSubscription.SupportsSubscriptions($applicationTypeId))
Parameters
Name | Type | Description | Required | Default | Options |
---|---|---|---|---|---|
applicationTypeId | Guid | Application Type Id | Required |
Return Type
bool