Class Publishing

Defines the Publishing configuration to provision

Inheritance
System.Object
BaseModel
Publishing
Inherited Members
Namespace: PnP.Framework.Provisioning.Model
Assembly: PnP.Framework.dll
Syntax
public class Publishing : BaseModel, IProvisioningTemplateDescendant

Constructors

Publishing()

Constructor for Publishing class

Declaration
public Publishing()

Publishing(AutoCheckRequirementsOptions, DesignPackage, IEnumerable<AvailableWebTemplate>, IEnumerable<PageLayout>)

Constructor for Publishing class

Declaration
public Publishing(AutoCheckRequirementsOptions autoCheckRequirements, DesignPackage designPackage = null, IEnumerable<AvailableWebTemplate> availableWebTemplates = null, IEnumerable<PageLayout> pageLayouts = null)
Parameters
AutoCheckRequirementsOptions autoCheckRequirements

AutoCheckRequirementsOption object
DesignPackage designPackage

Design Package for publishing
IEnumerable<AvailableWebTemplate> availableWebTemplates

Available WebTemplates for publishing
IEnumerable<PageLayout> pageLayouts

PageLayouts for publishing

Properties

AutoCheckRequirements

Defines how an engine should behave if the requirements for provisioning publishing capabilities are not satisfied by the target site

Declaration
public AutoCheckRequirementsOptions AutoCheckRequirements { get; set; }
Property Value
AutoCheckRequirementsOptions

AvailableWebTemplates

Defines the Available Web Templates for the current Publishing site

Declaration
public AvailableWebTemplateCollection AvailableWebTemplates { get; }
Property Value
AvailableWebTemplateCollection

DesignPackage

Defines a Design Package to import into the current Publishing site

Declaration
public DesignPackage DesignPackage { get; set; }
Property Value
DesignPackage

ImageRenditions

Declaration
public ImageRenditionCollection ImageRenditions { get; }
Property Value
ImageRenditionCollection

PageLayouts

Defines the Available Page Layouts for the current Publishing site

Declaration
public PageLayoutCollection PageLayouts { get; }
Property Value
PageLayoutCollection

Methods

Equals(Publishing)

Compares Publishing object based on AutoCheckRequirements, AvailableWebTemplates, DesignPackage and PageLayout properties.

Declaration
public bool Equals(Publishing other)
Parameters
Publishing other

Publishing object
Returns
System.Boolean

true if the Publishing object is equal to the current object; otherwise, false.

Equals(Object)

Compares object with Publishing

Declaration
public override bool Equals(object obj)
Parameters
System.Object obj

Object that represents Publishing
Returns
System.Boolean

true if the current object is equal to the Publishing

GetHashCode()

Gets the hash code

Declaration
public override int GetHashCode()
Returns
System.Int32

Returns HashCode

Extension Methods