core_v2_applicationSubscription Script API

Enables scripted content fragments to use application subscriptions

CanDeleteSubscription
CanSubscribe
Create
Delete
Get
List
SupportsSubscriptions

Methods

CanDeleteSubscription

CanDeleteSubscription Overload 1

Returns whether the accessing user can delete a subscription to an application

Velocity

#set($booleanResponse = $core_v2_applicationSubscription.CanDeleteSubscription($applicationId, $subscribedUserId, "%{ TypeId = $typeIdArg }"))

JavaScript

var booleanResponse = core_v2_applicationSubscription.CanDeleteSubscription(applicationId, subscribedUserId, { TypeId: typeIdArg });

Parameters

Name	Type	Description	Required
applicationId	`Guid`	Application Id	Required
subscribedUserId	`Int32`	User who subscribed the application	Required
options	Options	Set of optional parameters including:	Required
TypeId	`Guid`	Categorization type	Optional

CanDeleteSubscription Overload 2

Returns whether the accessing user can delete a subscription to an application

Velocity

#set($booleanResponse = $core_v2_applicationSubscription.CanDeleteSubscription($applicationId, $subscribedUserId))

JavaScript

var booleanResponse = core_v2_applicationSubscription.CanDeleteSubscription(applicationId, subscribedUserId);

Parameters

Name	Type	Description	Required	Default	Options
applicationId	`Guid`	Application Id	Required
subscribedUserId	`Int32`	User who subscribed the content	Required

Returns

Boolean

CanSubscribe

Identifies if the accessing user can bookmark the specified application

Velocity

#set($booleanResponse = $core_v2_applicationSubscription.CanSubscribe($applicationId, $applicationTypeId))

JavaScript

var 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

Returns

Boolean

Create

Set a subscription to a piece of content

Velocity

#set($applicationSubscriptionResponse = $core_v2_applicationSubscription.Create($applicationId, $applicationTypeId, "%{ TypeId = $typeIdArg }"))

JavaScript

var applicationSubscriptionResponse = core_v2_applicationSubscription.Create(applicationId, applicationTypeId, { TypeId: typeIdArg });

Parameters

Name	Type	Description	Required
applicationId	`Guid`	Application Id	Required
applicationTypeId	`Guid`	Application Type Id	Required
options	Options	Set of optional parameters including:	Required
TypeId	`Guid`	Optional Type Id of the subscription.	Optional

Returns

ApplicationSubscription

Delete

Remove a subscription to a piece of content

Velocity

#set($applicationSubscriptionResponse = $core_v2_applicationSubscription.Delete($applicationId, $applicationTypeId, "%{ TypeId = $typeIdArg }"))

JavaScript

var applicationSubscriptionResponse = core_v2_applicationSubscription.Delete(applicationId, applicationTypeId, { TypeId: typeIdArg });

Parameters

Name	Type	Description	Required
applicationId	`Guid`	Application Id	Required
applicationTypeId	`Guid`	Application Type Id	Required
options	Options	Set of optional parameters including:	Required
TypeId	`Guid`	Optional Type Id of the subscription.	Optional

Returns

ApplicationSubscription

Get

Retrieve a subscription to an application

Velocity

#set($applicationSubscriptionResponse = $core_v2_applicationSubscription.Get($applicationId, "%{ TypeId = $typeIdArg }"))

JavaScript

var applicationSubscriptionResponse = core_v2_applicationSubscription.Get(applicationId, { TypeId: typeIdArg });

Parameters

Name	Type	Description	Required
applicationId	`Guid`	Application Id	Required
options	Options	Set of optional parameters including:	Required
TypeId	`Guid`	Optional Type Id of the subscription.	Optional

Returns

ApplicationSubscription

List

List Overload 1

List application subscriptions for the accessing user

Velocity

#set($pagedListResponse = $core_v2_applicationSubscription.List("%{ ApplicationId = $applicationIdArg, ApplicationTypeId = $applicationTypeIdArg, ContainerId = $containerIdArg, IncludeAllTypeIds = $includeAllTypeIdsArg, IncludeSubContainers = $includeSubContainersArg, PageIndex = $pageIndexArg, PageSize = $pageSizeArg, TypeId = $typeIdArg }"))

JavaScript

var pagedListResponse = core_v2_applicationSubscription.List({ ApplicationId: applicationIdArg, ApplicationTypeId: applicationTypeIdArg, ContainerId: containerIdArg, IncludeAllTypeIds: includeAllTypeIdsArg, IncludeSubContainers: includeSubContainersArg, PageIndex: pageIndexArg, PageSize: pageSizeArg, TypeId: typeIdArg });

Parameters

Name	Type	Description	Required	Default
options	Options	Set of optional parameters including:	Required
ApplicationId	`Guid`	Filter to this application.	Optional
ApplicationTypeId	`Guid`	Filter to this application type.	Optional
ContainerId	`Guid`	Filter to this container.	Optional
IncludeAllTypeIds	`Boolean`	Option to include all Type Id's. If TypeId is passed in, will be ignored.	Optional	False
IncludeSubContainers	`Boolean`	Include subcontainers of the ContainerId.	Optional
PageIndex	`Int32`	Page index for the results.	Optional
PageSize	`Int32`	Page size for the results.	Optional
TypeId	`Guid`	Optional Type Id of the subscription.	Optional

List Overload 2

List application subscriptions for the accessing user

Velocity

#set($pagedListResponse = $core_v2_applicationSubscription.List($applicationId, $applicationTypeId, "%{ PageIndex = $pageIndexArg, PageSize = $pageSizeArg, SortBy = $sortByArg, SortOrder = $sortOrderArg, TypeId = $typeIdArg, UsernameSearch = $usernameSearchArg }"))

JavaScript

var pagedListResponse = core_v2_applicationSubscription.List(applicationId, applicationTypeId, { PageIndex: pageIndexArg, PageSize: pageSizeArg, SortBy: sortByArg, SortOrder: sortOrderArg, TypeId: typeIdArg, UsernameSearch: usernameSearchArg });

Parameters

Name	Type	Description	Required	Default	Options
applicationId	`Guid`	Application Id	Required
applicationTypeId	`Guid`	Application Type Id	Required
options	Options	Set of optional parameters including:	Required
PageIndex	`Int32`	Page index for the results.	Optional
PageSize	`Int32`	Page size for the results.	Optional
SortBy	`String`	Sort By	Optional	Default	Default, Username
SortOrder	`String`	Sort Order	Optional	Ascending	Ascending, Descending
TypeId	`Guid`	Optional Type Id of the subscription.	Optional
UsernameSearch	`Guid`	Username to filter by.	Optional

Returns

PagedList of ApplicationSubscription

SupportsSubscriptions

Identifies whether the specified application type supports subscriptions

Velocity

#set($booleanResponse = $core_v2_applicationSubscription.SupportsSubscriptions($applicationTypeId))

JavaScript

var booleanResponse = core_v2_applicationSubscription.SupportsSubscriptions(applicationTypeId);

Parameters

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

Returns

Boolean

Recommended