ModulePackageBuilder Class

Allows for creating a NuGet package containing all installable module files.

Inheritance Hierarchy

System.Object
  CMS.Modules.ModulePackageBuilder

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

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.

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.

Methods

	Name	Description
Public method	BuildPackage(Stream)	Builds the module installation package to the given stream.
Public method	BuildPackage(String)	Builds the module installation package to the file specified by given path.
Public method	GetModuleFiles	Gets List of relative paths to files that will be included in the installation 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.