ModulePackageBuilder Class

Allows you to create NuGet package containing all module files.

Inheritance Hierarchy

System.Object
  CMS.Modules.ModulePackageBuilder

Namespace: CMS.Modules
Assembly: CMS.Modules (in CMS.Modules.dll) Version: 8.2.23

Syntax

public class ModulePackageBuilder

The ModulePackageBuilder type exposes the following members.

Constructors

	Name	Description
Public method	ModulePackageBuilder	Creates new ModulePackageBuilder for given ResourceInfo (module). Builder can be created only for modules which are in development (ResourceIsInDevelopment is set to true). Builder can not be created for CUSTOMSYSTEM.

Methods

	Name	Description
Public method	BuildPackage(String)	Builds the module installation package to the file specified by given path.
Public method	BuildPackage(Stream)	Builds the module installation package to the given stream.
Public method	GetModuleFiles	Gets List of relative paths to files that will be included in the instalation package.
Public method	GetModuleMetadata	Gets module's package metadata.
Public method	GetModuleObjects	Gets object query for module objects of given type which are included in the installation package. objectType must be one of those enumerated in IncludedObjectTypes, otherwise returns null.

Extension Methods

	Name	Description
Public Extension Method	AsValue	Converts object to a query value which can be used as a query parameter (Defined by QueryExtensions.)
Public Extension Method	GetAPIString	Gets the string by the specified resource key (Defined by CoreExtensions.)
Public Extension Method	GetString	Gets the string by the specified resource key (Defined by CoreExtensions.)
Public Extension Method	ToBoolean	Returns the boolean representation of an object or default value if not. (Defined by CoreExtensions.)
Public Extension Method	ToDateTime	Returns the DateTime representation of an object or default value if not. (Defined by CoreExtensions.)
Public Extension Method	ToDouble	Returns the double representation of an object or default value if not. (Defined by CoreExtensions.)
Public Extension Method	ToGuid	Returns the Guid representation of an object or default value if not. (Defined by CoreExtensions.)
Public Extension Method	ToInteger	Returns the integer representation of an object or default value if not. (Defined by CoreExtensions.)
Public Extension Method	ToString	Returns the string representation of an object or default value if not. (Defined by CoreExtensions.)

Properties

	Name	Description
Public property	IncludedObjectTypes	The installation package contains module objects of types enumerated by this property. The module object type itself ("cms.resource") is not present in the enumeration.