Enables scripted content fragments to use content subscriptions
Methods
CanDeleteSubscription
Returns whether the accessing user can delete a subscription to a piece of content
Usage
#set($booleanResponse = $core_v2_contentSubscription.CanDeleteSubscription($contentId, $subscribedUserId, "%{TypeId = $typeIdArg}"))
Parameters
Name | Type | Description | Required | Default | Options |
---|---|---|---|---|---|
contentId | Guid | Content 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 a piece of content
Usage
#set($booleanResponse = $core_v2_contentSubscription.CanDeleteSubscription($contentId, $subscribedUserId))
Parameters
Name | Type | Description | Required | Default | Options |
---|---|---|---|---|---|
contentId | Guid | Content Id | Required | ||
subscribedUserId | int | User who subscribed the content | Required |
Return Type
bool
CanSubscribe
Identifies if the accessing user can bookmark the given piece of content
Usage
#set($booleanResponse = $core_v2_contentSubscription.CanSubscribe($contentId, $contentTypeId))
Parameters
Name | Type | Description | Required | Default | Options |
---|---|---|---|---|---|
contentId | Guid | Content Id | Required | ||
contentTypeId | Guid | Content Type Id | Required |
Return Type
bool
Create
Set a subscription to a piece of content
Usage
#set($contentSubscriptionResponse = $core_v2_contentSubscription.Create($contentId, $contentTypeId, "%{TypeId = $typeIdArg}"))
Parameters
Name | Type | Description | Required | Default | Options |
---|---|---|---|---|---|
contentId | Guid | Content Id | Required | ||
contentTypeId | Guid | Content 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($contentSubscriptionResponse = $core_v2_contentSubscription.Delete($contentId, $contentTypeId, "%{TypeId = $typeIdArg}"))
Parameters
Name | Type | Description | Required | Default | Options |
---|---|---|---|---|---|
contentId | Guid | Content Id | Required | ||
contentTypeId | Guid | Content Type Id | Required | ||
TypeId | Guid | Optional Type Id of the subscription. | Optional |
Return Type
Get
Retrieve a subscription to a piece of content
Usage
#set($contentSubscriptionResponse = $core_v2_contentSubscription.Get($contentId, "%{TypeId = $typeIdArg}"))
Parameters
Name | Type | Description | Required | Default | Options |
---|---|---|---|---|---|
contentId | Guid | Content Id | Required | ||
TypeId | Guid | Optional Type Id of the subscription. | Optional |
Return Type
List
List content subscriptions for the accessing user
Usage
#set($pagedListResponse = $core_v2_contentSubscription.List("%{ApplicationId = $applicationIdArg, ApplicationTypeId = $applicationTypeIdArg, ContainerId = $containerIdArg, ContentTypeId = $contentTypeIdArg, 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 | ||
ContentTypeId | Guid | Filter to this content type. | 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<ContentSubscription>
MuteSubscription
Usage
$core_v2_contentSubscription.MuteSubscription($contentId, $contentTypeId, $isMuted, "%{TypeId = $typeIdArg}")
Parameters
Name | Type | Description | Required | Default | Options |
---|---|---|---|---|---|
contentId | Guid | Content Id | Required | ||
contentTypeId | Guid | Content Type Id | Required | ||
isMuted | bool | Is Muted | Required | ||
TypeId | Guid | Optional Type Id of the subscription. | Optional |
SupportsSubscriptions
Identifies whether the specified application type supports subscriptions
Usage
#set($booleanResponse = $core_v2_contentSubscription.SupportsSubscriptions($contentTypeId))
Parameters
Name | Type | Description | Required | Default | Options |
---|---|---|---|---|---|
contentTypeId | Guid | Content Type Id | Required |
Return Type
bool