LocalInstallation Members

NFX Class Library

[This is preliminary documentation and is subject to change.]

The LocalInstallation type exposes the following members.

Constructors

	Name	Description
	LocalInstallation	Initializes local installation, tries to read local manifest from rootPath or localManifestDir if it is !=null

Methods

	Name	Description
	BeginInstallation	Starts the installation so InstallPackage() can be called
	CheckLocalAndInstallIfNeeded	Checks local installation first for missing of different packages and if there are no differences then returns false, otherwise re-installs all packages defined by in install-set locally and returns true. Pass force=true to re-install regardless of manifest comparison (false by default)
	Destructor	(Overrides DisposableObject Destructor .)
	Dispose	Deterministically disposes object. DO NOT OVERRIDE this method, override Destructor() instead (Inherited from DisposableObject.)
	EndInstallation	Updates local installation manifest if changes have been made (Modified=true)
	EnsureObjectNotDisposed	Checks to see whether object dispose started or has already been disposed and throws an exception if Dispose() was called (Inherited from DisposableObject.)
	Equals	Determines whether the specified object is equal to the current object. (Inherited from Object.)
	Finalize	(Inherited from DisposableObject.)
	FindMissingOrDifferentPackage	Finds a package form the install set which is either missing on local machine or is not the same as the one in installSet. Returns the package info from install set
	GetHashCode	Serves as the default hash function. (Inherited from Object.)
	GetType	Gets the Type of the current instance. (Inherited from Object.)
	InstallPackage	Unconditionally installs a package - copies a set of files contained in the FileSystemDirectory assigning it some mnemonic name
	MemberwiseClone	Creates a shallow copy of the current Object. (Inherited from Object.)
	ToString	Returns a string that represents the current object. (Inherited from Object.)

Extension Methods

	Name	Description
	AsBool	(Defined by ObjectValueConversion.)
	AsByte	(Defined by ObjectValueConversion.)
	AsChar	(Defined by ObjectValueConversion.)
	AsDateTime	Overloaded. (Defined by ObjectValueConversion.)
	AsDateTime(DateTime, ConvertErrorHandling)	Overloaded. (Defined by ObjectValueConversion.)
	AsDecimal	(Defined by ObjectValueConversion.)
	AsDouble	(Defined by ObjectValueConversion.)
	AsEnum TEnum	(Defined by ObjectValueConversion.)
	AsFloat	(Defined by ObjectValueConversion.)
	AsGDID	Overloaded. (Defined by ObjectValueConversion.)
	AsGDID(GDID, ConvertErrorHandling)	Overloaded. (Defined by ObjectValueConversion.)
	AsGDIDSymbol	Overloaded. (Defined by ObjectValueConversion.)
	AsGDIDSymbol(GDIDSymbol, ConvertErrorHandling)	Overloaded. (Defined by ObjectValueConversion.)
	AsGUID	(Defined by ObjectValueConversion.)
	AsInt	(Defined by ObjectValueConversion.)
	AsJSONConfig	(Defined by ObjectValueConversion.)
	AsLaconicConfig	(Defined by ObjectValueConversion.)
	AsLong	(Defined by ObjectValueConversion.)
	AsNonNullOrEmptyString	(Defined by ObjectValueConversion.)
	AsNullableBool	(Defined by ObjectValueConversion.)
	AsNullableByte	(Defined by ObjectValueConversion.)
	AsNullableChar	(Defined by ObjectValueConversion.)
	AsNullableDateTime	(Defined by ObjectValueConversion.)
	AsNullableDecimal	(Defined by ObjectValueConversion.)
	AsNullableDouble	(Defined by ObjectValueConversion.)
	AsNullableEnum TEnum	(Defined by ObjectValueConversion.)
	AsNullableFloat	(Defined by ObjectValueConversion.)
	AsNullableGDID	(Defined by ObjectValueConversion.)
	AsNullableGDIDSymbol	(Defined by ObjectValueConversion.)
	AsNullableGUID	(Defined by ObjectValueConversion.)
	AsNullableInt	(Defined by ObjectValueConversion.)
	AsNullableLong	(Defined by ObjectValueConversion.)
	AsNullableSByte	(Defined by ObjectValueConversion.)
	AsNullableShort	(Defined by ObjectValueConversion.)
	AsNullableTimeSpan	(Defined by ObjectValueConversion.)
	AsNullableUInt	(Defined by ObjectValueConversion.)
	AsNullableULong	(Defined by ObjectValueConversion.)
	AsNullableUShort	(Defined by ObjectValueConversion.)
	AsSByte	(Defined by ObjectValueConversion.)
	AsShort	(Defined by ObjectValueConversion.)
	AsString	(Defined by ObjectValueConversion.)
	AsTimeSpan	Overloaded. (Defined by ObjectValueConversion.)
	AsTimeSpan(TimeSpan, ConvertErrorHandling)	Overloaded. (Defined by ObjectValueConversion.)
	AsUInt	(Defined by ObjectValueConversion.)
	AsULong	(Defined by ObjectValueConversion.)
	AsUri	(Defined by ObjectValueConversion.)
	AsUShort	(Defined by ObjectValueConversion.)
	AsXMLConfig	(Defined by ObjectValueConversion.)
	ToErlObject	Overloaded. Try to convert .NET native object type to corresponding Erlang term. Throw exception if conversion is not possible (Defined by ErlObject.)
	ToErlObject(ErlTypeOrder, Boolean)	Overloaded. Try to convert .NET native object type to corresponding Erlang term of given type. Throw exception if conversion is not possible (Defined by ErlObject.)
	ToJSON(JSONWritingOptions)	Overloaded. Serializes object into JSON string (Defined by JSONExtensions.)
	ToJSON(TextWriter, JSONWritingOptions)	Overloaded. Serializes object into JSON format using provided TextWriter (Defined by JSONExtensions.)
	ToJSON(Stream, JSONWritingOptions, Encoding)	Overloaded. Serializes object into JSON format using provided stream and optional encoding (Defined by JSONExtensions.)

Properties

	Name	Description
	Disposed	Indicates whether this object was already disposed - the Dispose() has finished (Inherited from DisposableObject.)
	DisposeStarted	Indicates whether this object Dispose() has been called and dispose started but not finished yet (Inherited from DisposableObject.)
	InstallationStarted	Returns true to indicate that BeginInstallation() has been called
	Item	Returns installed package manifest by name or null
	Modified	Returns true to indicate that local installation has changed as the result of package installation
	PackageManifests	Gets package manifests
	PackageNames	Gets package names
	RootPath	Root path of the installation