Click or drag to resize
ModulePackageBuilder Class
Allows you to create NuGet package containing all module files.
Inheritance Hierarchy
SystemObject
  CMS.ModulesModulePackageBuilder

Namespace: CMS.Modules
Assembly: CMS.Modules (in CMS.Modules.dll) Version: 8.2.23
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
Methods
  NameDescription
Public methodBuildPackage(String)
Builds the module installation package to the file specified by given path.
Public methodBuildPackage(Stream)
Builds the module installation package to the given stream.
Public methodGetModuleFiles
Gets List of relative paths to files that will be included in the instalation 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
Extension Methods
  NameDescription
Public Extension MethodAsValue
Converts object to a query value which can be used as a query parameter
(Defined by QueryExtensions.)
Public Extension MethodGetAPIString
Gets the string by the specified resource key
(Defined by CoreExtensions.)
Public Extension MethodGetString
Gets the string by the specified resource key
(Defined by CoreExtensions.)
Public Extension MethodToBoolean
Returns the boolean representation of an object or default value if not.
(Defined by CoreExtensions.)
Public Extension MethodToDateTime
Returns the DateTime representation of an object or default value if not.
(Defined by CoreExtensions.)
Public Extension MethodToDouble
Returns the double representation of an object or default value if not.
(Defined by CoreExtensions.)
Public Extension MethodToGuid
Returns the Guid representation of an object or default value if not.
(Defined by CoreExtensions.)
Public Extension MethodToInteger
Returns the integer representation of an object or default value if not.
(Defined by CoreExtensions.)
Public Extension MethodToString
Returns the string representation of an object or default value if not.
(Defined by CoreExtensions.)
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
See Also