core_v2_applicationSubscription Script API

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	Default	Options
applicationId	Guid	Application Id	Required
subscribedUserId	Int32	User who subscribed the application	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

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

Create

Set a subscription to an applictaion

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	Default	Options
applicationId	Guid	Application Id	Required
applicationTypeId	Guid	Application Type Id	Required
TypeId	Guid	Optional Type Id of the subscription.	Optional

Returns

Delete

Remove a subscription to an application

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	Default	Options
applicationId	Guid	Application Id	Required
applicationTypeId	Guid	Application Type Id	Required
TypeId	Guid	Optional Type Id of the subscription.	Optional

Returns

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	Default	Options
applicationId	Guid	Application Id	Required
TypeId	Guid	Optional Type Id of the subscription.	Optional

Returns

List

List application subscriptions for the accessing user

Velocity

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

JavaScript

var 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	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

Returns

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