Interface IPackageController

Namespace: DotNetNuke.Services.Installer.Packages

Assembly: DotNetNuke.dll

Syntax

public interface IPackageController

Methods

| Improve this Doc View Source

DeleteExtensionPackage(PackageInfo)

DeleteExtensionPackage is used to remove an Extension Package for the System.

Declaration

void DeleteExtensionPackage(PackageInfo package)

Parameters

Type	Name	Description
PackageInfo	package	The Package you wish to delete.

| Improve this Doc View Source

GetExtensionPackage(Int32, Func<PackageInfo, Boolean>, Boolean)

GetExtensionPackage is used to retrieve a specific package from the data store.

Declaration

PackageInfo GetExtensionPackage(int portalId, Func<PackageInfo, bool> predicate, bool useCopy)

Parameters

Type	Name	Description
System.Int32	portalId	The Id of the portal. Most extension packages do not belong to a specific portal so in most situations developers will need to pass -1 to indicate this. The main situation where the portal Id will have a specific value is for skins which have been installed for a spcific portal/site.
Func<PackageInfo, System.Boolean>	predicate	The "search criteria" to use to identify the extension package to retrieve. In most cases this will be a simple lambda method e.g. p => p.Name == "Name".
System.Boolean	useCopy	Whether use a copy of the package info object.

Returns

Type	Description
PackageInfo	The extension package.

| Improve this Doc View Source

GetExtensionPackage(Int32, Func<PackageInfo, Boolean>)

GetExtensionPackage is used to retrieve a specific package from the data store.

Declaration

PackageInfo GetExtensionPackage(int portalId, Func<PackageInfo, bool> predicate)

Parameters

Type	Name	Description
System.Int32	portalId	The Id of the portal. Most extension packages do not belong to a specific portal so in most situations developers will need to pass -1 to indicate this. The main situation where the portal Id will have a specific value is for skins which have been installed for a spcific portal/site.
Func<PackageInfo, System.Boolean>	predicate	The "search criteria" to use to identify the extension package to retrieve. In most cases this will be a simple lambda method e.g. p => p.Name == "Name".

Returns

Type	Description
PackageInfo	The extension package.

| Improve this Doc View Source

GetExtensionPackages(Int32, Func<PackageInfo, Boolean>)

GetExtensionPackages is used to retrieve packages from the data store.

Declaration

IList<PackageInfo> GetExtensionPackages(int portalId, Func<PackageInfo, bool> predicate)

Parameters

Type	Name	Description
System.Int32	portalId	The Id of the portal. Most extension packages do not belong to a specific portal so in most situations developers will need to pass -1 to indicate this. The main situation where the portal Id will have a specific value is for skins which have been installed for a spcific portal/site.
Func<PackageInfo, System.Boolean>	predicate	The "search criteria" to use to identify the extension packages to retrieve. In most cases this will be a simple lambda method e.g. p => p.PackageType == "Module".

Returns

Type	Description
IList<PackageInfo>	A list of extension packages.

| Improve this Doc View Source

GetExtensionPackages(Int32)

GetExtensionPackages is used to retrieve packages from the data store.

Declaration

IList<PackageInfo> GetExtensionPackages(int portalId)

Parameters

Type	Name	Description
System.Int32	portalId	The Id of the portal. Most extension packages do not belong to a specific portal so in most situations developers will need to pass -1 to indicate this. The main situation where the portal Id will have a specific value is for skins which have been installed for a spcific portal/site.

Returns

Type	Description
IList<PackageInfo>	A list of extension packages.

| Improve this Doc View Source

GetExtensionPackageType(Func<PackageType, Boolean>)

GetExtensionPackage is used to retrieve a specific package type from the data store.

Declaration

PackageType GetExtensionPackageType(Func<PackageType, bool> predicate)

Parameters

Type	Name	Description
Func<PackageType, System.Boolean>	predicate	The "search criteria" to use to identify the package type to retrieve. In most cases this will be a simple lambda method e.g. t => t.PackageType == "Modules".

Returns

Type	Description
PackageType	A package type.

| Improve this Doc View Source

GetExtensionPackageTypes()

GetExtensionPackageTypes is used to retrieve package types from the data store.

Declaration

IList<PackageType> GetExtensionPackageTypes()

Returns

Type	Description
IList<PackageType>	A list of package types.

| Improve this Doc View Source

GetPackageDependencies(Func<PackageDependencyInfo, Boolean>)

Get the dependencies for a package.

Declaration

IList<PackageDependencyInfo> GetPackageDependencies(Func<PackageDependencyInfo, bool> predicate)

Parameters

Type	Name	Description
Func<PackageDependencyInfo, System.Boolean>	predicate

Returns

Type	Description
IList<PackageDependencyInfo>	A List of PackageDependencyInfo objects.

| Improve this Doc View Source

SaveExtensionPackage(PackageInfo)

SaveExtensionPackage is used to save an Extension Package.

Declaration

void SaveExtensionPackage(PackageInfo package)

Parameters

Type	Name	Description
PackageInfo	package	The Package you wish to save.

Extension Methods

JsonExtensionsWeb.ToJson(Object)