Namespace: Packaging

Namespaces

Manage

Methods

Appearition.Packaging.AvailablePackages (request, requestOptions)Array.<Appearition.Packaging.MyAvailablePackagesViewModel> static

Retrieves a list of published packages available to the user

Name	Type	Description
request	Appearition.Packaging.MyAvailablePackagesRequestViewModel	filter packages
requestOptions	any	configure callbacks

Returns:

Type	Description
Array.<Appearition.Packaging.MyAvailablePackagesViewModel>	This is returned as part of the success callback function in the requestOptions param

Appearition.Packaging.CheckStatus (packageId, requestOptions)Appearition.Packaging.PackageProcessingViewModel static

Instructs the system to subscribe the user into the given package.

Name	Type	Description
packageId	number	identifies a package the user has subscribed to, to get the status of
requestOptions	any	configure callbacks

Returns:

Type	Description
Appearition.Packaging.PackageProcessingViewModel	This is returned as part of the success callback function in the requestOptions param

Appearition.Packaging.SelectPackage (request, requestOptions)Appearition.Packaging.SelectedPackageViewModel static

Instructs the system to subscribe the user into the given package.

Name	Type	Description
request	Appearition.Packaging.SelectedPackageViewModel	the package to subscribe the user to
requestOptions	any	configure callbacks

Returns:

Type	Description
Appearition.Packaging.SelectedPackageViewModel	This is returned as part of the success callback function in the requestOptions param

Type Definitions

Appearition.Packaging.MyAvailablePackagesRequestViewModel

This is the data structure used to pass to the MyAvailablePackages method

Properties:

Name	Type	Description
PackageKey	string	The key to the package to filter or pre-select
Group	string	The name of the group of packages to filter or pre-select

Appearition.Packaging.MyAvailablePackagesViewModel

This is the data structure returned for the MyAvailablePackages method

Properties:

Name	Type	Description
Packages	Array.<Appearition.Packaging.PackageSummaryViewModel>	The list of packages available to show
AutoSelectedPackage	number	If a package was auto selected on the server, this object will contain the ID of the package and the current processing status

Appearition.Packaging.PackageSummaryViewModel

This is the data structure of a specific package

Properties:

Name	Type	Description
Id	number	Identifies the package
Name	string	The name of the package
PackageKey	string	Another unique identifier of the package. Can be used in the URL to highlight or auto select
GroupName	string	The name of the group that this package belongs to.
Description	string	HTML supported text
Ordinal	number	Allows sorting of packages when presented to the user
AlreadyChosen	boolean	Indicates if the user has already subscribed to this package
NeedsBilling	boolean	Indicates if the package requires payment
PackageStatus	string	The current subscription status of the package in relation to the user
CanAutoSelect	boolean	Indicates if the package can be automatically subscribe the user into
HideSelection	boolean	Indicates if the package cannot be selected by the user. Instead this package is informational whereby the description may contain a link to another location

Appearition.Packaging.SelectedPackageViewModel

This is the data structure of a specific package

Properties:

Name	Type	Description
TenantPackageId	number	Identifies the package
ProcessingStatus	string	The current subscription status of the package in relation to the user