Class Installer

The Installer class provides a single entrypoint for Package Installation.

Inheritance

System.Object

Installer

Namespace: DotNetNuke.Services.Installer

Assembly: DotNetNuke.dll

Syntax

public class Installer : object

Constructors

| Improve this Doc View Source

Installer(PackageInfo, String)

Initializes a new instance of the Installer class. This Constructor creates a new Installer instance from a PackageInfo object.

Declaration

public Installer(PackageInfo package, string physicalSitePath)

Parameters

Type	Name	Description
PackageInfo	package	The PackageInfo instance.
System.String	physicalSitePath	The physical path to the root of the site.

| Improve this Doc View Source

Installer(Stream, String, Boolean, Boolean)

Initializes a new instance of the Installer class. This Constructor creates a new Installer instance from a Stream and a string representing the physical path to the root of the site.

Declaration

public Installer(Stream inputStream, string physicalSitePath, bool loadManifest, bool deleteTemp)

Parameters

Type	Name	Description
Stream	inputStream	The Stream to use to create this InstallerInfo instance.
System.String	physicalSitePath	The physical path to the root of the site.
System.Boolean	loadManifest	Flag that determines whether the manifest will be loaded.
System.Boolean	deleteTemp	Whether delete the temp folder.

| Improve this Doc View Source

Installer(Stream, String, Boolean)

Initializes a new instance of the Installer class. This Constructor creates a new Installer instance from a Stream and a string representing the physical path to the root of the site.

Declaration

public Installer(Stream inputStream, string physicalSitePath, bool loadManifest)

Parameters

Type	Name	Description
Stream	inputStream	The Stream to use to create this InstallerInfo instance.
System.String	physicalSitePath	The physical path to the root of the site.
System.Boolean	loadManifest	Flag that determines whether the manifest will be loaded.

| Improve this Doc View Source

Installer(String, String, Boolean)

Initializes a new instance of the Installer class.

Declaration

public Installer(string manifest, string physicalSitePath, bool loadManifest)

Parameters

Type	Name	Description
System.String	manifest	The install package manifest.
System.String	physicalSitePath	The physical path to the site.
System.Boolean	loadManifest	A value indicating whether to load the manifest.

| Improve this Doc View Source

Installer(String, String, String, Boolean)

Initializes a new instance of the Installer class. This Constructor creates a new Installer instance from a string representing the physical path to the temporary install folder and a string representing the physical path to the root of the site.

Declaration

public Installer(string tempFolder, string manifest, string physicalSitePath, bool loadManifest)

Parameters

Type	Name	Description
System.String	tempFolder	The physical path to the zip file containg the package.
System.String	manifest	The manifest filename.
System.String	physicalSitePath	The physical path to the root of the site.
System.Boolean	loadManifest	Flag that determines whether the manifest will be loaded.

Properties

| Improve this Doc View Source

InstallerInfo

Gets the associated InstallerInfo object.

Declaration

public InstallerInfo InstallerInfo { get; }

Property Value

Type	Description
InstallerInfo	An InstallerInfo.

| Improve this Doc View Source

IsValid

Gets a value indicating whether the associated InstallerInfo is valid.

Declaration

public bool IsValid { get; }

Property Value

Type	Description
System.Boolean	True - if valid, False if not.

| Improve this Doc View Source

Packages

Gets a SortedList of Packages that are included in the Package Zip.

Declaration

public SortedList<int, PackageInstaller> Packages { get; }

Property Value

Type	Description
SortedList<System.Int32, PackageInstaller>	A SortedList(Of Integer, PackageInstaller).

| Improve this Doc View Source

TempInstallFolder

Gets the installation temporary folder path.

Declaration

public string TempInstallFolder { get; }

Property Value

Type	Description
System.String	The installation temporory folder path.

Methods

| Improve this Doc View Source

ConvertLegacyNavigator(XPathNavigator, InstallerInfo)

Converts legacy manifest navigation to support old manifest format.

Declaration

public static XPathNavigator ConvertLegacyNavigator(XPathNavigator rootNav, InstallerInfo info)

Parameters

Type	Name	Description
XPathNavigator	rootNav	The root xml navigation path.
InstallerInfo	info	InstallerInfo.

Returns

Type	Description
XPathNavigator	A new converted that works with current manifest schema.

| Improve this Doc View Source

DeleteTempFolder()

Deletes the package temporary folder.

Declaration

public void DeleteTempFolder()

| Improve this Doc View Source

Install()

The Install method installs the feature.

Declaration

public bool Install()

Returns

Type	Description
System.Boolean	A value indicating whether the install succeeded.

| Improve this Doc View Source

ReadManifest(Boolean)

The ReadManifest method reads the manifest file and parses it into packages.

Declaration

public void ReadManifest(bool deleteTemp)

Parameters

Type	Name	Description
System.Boolean	deleteTemp	A value indicating whether to delete the temporary folder.

| Improve this Doc View Source

UnInstall(Boolean)

The UnInstall method uninstalls the feature.

Declaration

public bool UnInstall(bool deleteFiles)

Parameters

Type	Name	Description
System.Boolean	deleteFiles	A flag that indicates whether the files should be deleted.

Returns

Type	Description
System.Boolean	A value indicating whether the uninstall succeeded.

Extension Methods

JsonExtensionsWeb.ToJson(Object)