Click or drag to resize
ModulePackageBuilder Class
Allows for creating a NuGet package containing all installable module files.
Inheritance Hierarchy
SystemObject
  CMS.ModulesModulePackageBuilder

Namespace: CMS.Modules
Assembly: CMS.Modules (in CMS.Modules.dll) Version: 12.0.0
Syntax
C#
public class ModulePackageBuilder

The ModulePackageBuilder type exposes the following members.

Constructors
  NameDescription
Public methodModulePackageBuilder
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.
Top
Properties
  NameDescription
Public propertyIncludedObjectTypes
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.
Top
Methods
  NameDescription
Public methodBuildPackage(Stream)
Builds the module installation package to the given stream.
Public methodBuildPackage(String)
Builds the module installation package to the file specified by given path.
Public methodGetModuleFiles
Gets List of relative paths to files that will be included in the installation package.
Public methodGetModuleMetadata
Gets module's package metadata.
Public methodGetModuleObjects
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.
Top
See Also