Class InstallerInfo

The InstallerInfo class holds all the information associated with a Installation.

Inheritance

System.Object

InstallerInfo

Namespace: DotNetNuke.Services.Installer

Assembly: DotNetNuke.dll

Syntax

public class InstallerInfo : object

Constructors

InstallerInfo()

Initializes a new instance of the InstallerInfo class. This Constructor creates a new InstallerInfo instance.

Declaration

public InstallerInfo()

InstallerInfo(PackageInfo, String)

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

Declaration

public InstallerInfo(PackageInfo package, string sitePath)

Parameters

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

InstallerInfo(Stream, String)

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

Declaration

public InstallerInfo(Stream inputStream, string sitePath)

Parameters

Type	Name	Description
Stream	inputStream	The Stream to use to create this InstallerInfo instance.
System.String	sitePath	The physical path to the root of the site.

InstallerInfo(String, InstallMode)

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

Declaration

public InstallerInfo(string sitePath, InstallMode mode)

Parameters

Type	Name	Description
System.String	sitePath	The physical path to the root of the site.
InstallMode	mode	Install Mode.

InstallerInfo(String, String, String)

Initializes a new instance of the InstallerInfo class. This Constructor creates a new InstallerInfo 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 InstallerInfo(string tempFolder, string manifest, string sitePath)

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	sitePath	The physical path to the root of the site.

Properties

AllowableFiles

Gets or sets a list of allowable file extensions (in addition to the Host's List).

Declaration

public string AllowableFiles { get; set; }

Property Value

Type	Description
System.String

Files

Gets a Dictionary of Files that are included in the Package.

Declaration

public Dictionary<string, InstallFile> Files { get; }

Property Value

Type	Description
Dictionary<System.String, InstallFile>

HasValidFiles

Gets a value indicating whether the package contains Valid Files.

Declaration

public bool HasValidFiles { get; }

Property Value

Type	Description
System.Boolean

IgnoreWhiteList

Gets or sets a value indicating whether the File Extension WhiteList is ignored.

Declaration

public bool IgnoreWhiteList { get; set; }

Property Value

Type	Description
System.Boolean

Installed

Gets or sets a value indicating whether gets whether the Package is already installed with the same version.

Declaration

public bool Installed { get; set; }

Property Value

Type	Description
System.Boolean

InstallMode

Gets the InstallMode.

Declaration

public InstallMode InstallMode { get; }

Property Value

Type	Description
InstallMode

InvalidFileExtensions

Gets the Invalid File Extensions.

Declaration

public string InvalidFileExtensions { get; }

Property Value

Type	Description
System.String

IsLegacyMode

Gets or sets a value indicating whether gets whether the Installer is in legacy mode.

Declaration

public bool IsLegacyMode { get; set; }

Property Value

Type	Description
System.Boolean

IsValid

Gets a value indicating whether the InstallerInfo instance is Valid.

Declaration

public bool IsValid { get; }

Property Value

Type	Description
System.Boolean

LegacyError

Gets or sets the associated Logger.

Declaration

public string LegacyError { get; set; }

Property Value

Type	Description
System.String

Log

Gets the associated Logger.

Declaration

public Logger Log { get; }

Property Value

Type	Description
Logger

ManifestFile

Gets and Sets the Manifest File for the Package.

Declaration

public InstallFile ManifestFile { get; }

Property Value

Type	Description
InstallFile

PackageID

Gets or sets the Id of the package after installation (-1 if fail).

Declaration

public int PackageID { get; set; }

Property Value

Type	Description
System.Int32

PhysicalSitePath

Gets the Physical Path to the root of the Site (eg D:\Websites\DotNetNuke").

Declaration

public string PhysicalSitePath { get; }

Property Value

Type	Description
System.String

PortalID

Gets or sets the Id of the current portal (-1 if Host).

Declaration

public int PortalID { get; set; }

Property Value

Type	Description
System.Int32

RepairInstall

Gets or sets a value indicating whether the Package Install is being repaired.

Declaration

public bool RepairInstall { get; set; }

Property Value

Type	Description
System.Boolean	A Boolean value.

SecurityAccessLevel

Gets or sets the security Access Level of the user that is calling the Installer.

Declaration

public SecurityAccessLevel SecurityAccessLevel { get; set; }

Property Value

Type	Description
SecurityAccessLevel

TempInstallFolder

Gets the Temporary Install Folder used to unzip the archive (and to place the backups of existing files) during InstallMode.

Declaration

public string TempInstallFolder { get; }

Property Value

Type	Description
System.String

Extension Methods

JsonExtensionsWeb.ToJson(Object)