Class ProvisioningTemplate

Domain Object for the Provisioning Template

Inheritance
System.Object
BaseHierarchyModel
ProvisioningTemplate
Inherited Members
Namespace: PnP.Framework.Provisioning.Model
Assembly: PnP.Framework.dll
Syntax
public class ProvisioningTemplate : BaseHierarchyModel, IProvisioningHierarchyDescendant

Constructors

ProvisioningTemplate()

Constructor for ProvisioningTemplate class

Declaration
public ProvisioningTemplate()

ProvisioningTemplate(FileConnectorBase)

Constructor for ProvisioningTemplate class

Declaration
public ProvisioningTemplate(FileConnectorBase connector)
Parameters
FileConnectorBase connector

FileConnectorBase object

Properties

AddIns

Defines the SharePoint Add-ins to provision

Declaration
public AddInCollection AddIns { get; }
Property Value
AddInCollection

ApplicationLifecycleManagement

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

AuditSettings

The Audit Settings for the Provisioning Template

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

BaseSiteTemplate

The Base SiteTemplate of the Provisioning Template

Declaration
public String BaseSiteTemplate { get; set; }
Property Value
String

ClientSidePages

Gets a collection of ClientSidePage to configure for the site

Declaration
public ClientSidePageCollection ClientSidePages { get; }
Property Value
ClientSidePageCollection

ComposedLook

Gets or Sets the composed look of the template

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

Connector

Gets or sets the File Connector

Declaration
public FileConnectorBase Connector { get; set; }
Property Value
FileConnectorBase

ContentTypes

Gets a collection of Content Types to create

Declaration
public ContentTypeCollection ContentTypes { get; }
Property Value
ContentTypeCollection

CustomActions

Gets or sets CustomActions for the template

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

Description

The Description of the Provisioning Template

Declaration
public String Description { get; set; }
Property Value
String

Directories

Gets a collection of directories from which upload files for the template

Declaration
public DirectoryCollection Directories { get; }
Property Value
DirectoryCollection

DisplayName

The Display Name of the Provisioning Template

Declaration
public String DisplayName { get; set; }
Property Value
String

ExtensibilityHandlers

Gets or sets the Extensibility Handlers

Declaration
public ExtensibilityHandlerCollection ExtensibilityHandlers { get; }
Property Value
ExtensibilityHandlerCollection

Features

Gets or sets a list of features to activate or deactivate

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

Files

Gets a collection of files for the template

Declaration
public FileCollection Files { get; }
Property Value
FileCollection

Header

The Header of the Site

Declaration
public SiteHeader Header { get; set; }
Property Value
SiteHeader

Id

Gets or sets the ID of the Provisioning Template

Declaration
public string Id { get; set; }
Property Value
System.String

ImagePreviewUrl

The Image Preview Url of the Provisioning Template

Declaration
public String ImagePreviewUrl { get; set; }
Property Value
String

Lists

Declaration
public ListInstanceCollection Lists { get; }
Property Value
ListInstanceCollection

Localizations

Gets or sets the Localizations

Declaration
public LocalizationCollection Localizations { get; }
Property Value
LocalizationCollection

Navigation

The Navigation configurations of the Provisioning Template

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

Pages

Gets a collection of Wiki Pages for the template

Declaration
public PageCollection Pages { get; }
Property Value
PageCollection

Parameters

Any parameters that can be used throughout the template

Declaration
public Dictionary<string, string> Parameters { get; }
Property Value
Dictionary<System.String, System.String>

Properties

A set of custom Properties for the Provisioning Template

Declaration
public Dictionary<String, String> Properties { get; }
Property Value
Dictionary<String, String>

PropertyBagEntries

Declaration
public PropertyBagEntryCollection PropertyBagEntries { get; }
Property Value
PropertyBagEntryCollection

Providers

Gets a collection of Providers that are used during the extensibility pipeline

Declaration
public ProviderCollection Providers { get; }
Property Value
ProviderCollection

ProvisioningTemplateWebhooks

The Webhooks for the Provisioning Template

Declaration
public ProvisioningTemplateWebhookCollection ProvisioningTemplateWebhooks { get; set; }
Property Value
ProvisioningTemplateWebhookCollection

Publishing

Defines the Publishing configuration to provision

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

RegionalSettings

The Regional Settings of the Provisioning Template

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

Scope

Declares the target scope of the current Provisioning Template

Declaration
public ProvisioningTemplateScope Scope { get; set; }
Property Value
ProvisioningTemplateScope

SearchSettings

The Search Settings for the Provisioning Template

Declaration
public string SearchSettings { get; set; }
Property Value
System.String

Security

Security Groups Members for the Template

Declaration
public SiteSecurity Security { get; set; }
Property Value
SiteSecurity

SiteFields

Gets a collection of fields

Declaration
public FieldCollection SiteFields { get; }
Property Value
FieldCollection

SitePolicy

Gets or Sets the Site Policy

Declaration
public string SitePolicy { get; set; }
Property Value
System.String

SiteSearchSettings

The Site Collection level Search Settings for the Provisioning Template

Declaration
public String SiteSearchSettings { get; set; }
Property Value
String

SiteSettings

The Site Settings of the Provisioning Template

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

SiteWebhooks

Gets a collection of SiteWebhooks to configure for the site

Declaration
public SiteWebhookCollection SiteWebhooks { get; }
Property Value
SiteWebhookCollection

SupportedUILanguages

The Supported UI Languages for the Provisioning Template

Declaration
public SupportedUILanguageCollection SupportedUILanguages { get; }
Property Value
SupportedUILanguageCollection

TemplateCultureInfo

The default CultureInfo of the Provisioning Template, used to format all input values, optional attribute.

Declaration
public String TemplateCultureInfo { get; set; }
Property Value
String

Tenant

The Tenant-wide settings for the template

Declaration
public ProvisioningTenant Tenant { get; set; }
Property Value
ProvisioningTenant

TermGroups

Gets a collection of termgroups to deploy to the site

Declaration
public TermGroupCollection TermGroups { get; }
Property Value
TermGroupCollection

Theme

The Theme of the Site

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

Version

Gets or sets the Version of the Provisioning Template

Declaration
public double Version { get; set; }
Property Value
System.Double

WebSearchSettings

The Web level Search Settings for the Provisioning Template

Declaration
public String WebSearchSettings { get; set; }
Property Value
String

WebSettings

The Web Settings of the Provisioning Template

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

Workflows

Defines the Workflows to provision

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

Methods

Equals(ProvisioningTemplate)

Compares ProvisioningTemplate object based on ComposedLook, ContentTypes, CustomActions, SiteFeature, WebFeatures, Files, Id, Lists, PropertyBagEntries, Providers, Security, SiteFields, SitePolicy, Version, Pages, TermGroups, Workflows, AddIns, Publishing, Loaclizations, WebSettings, SiteWebhooks, ClientSidePages, Tenant, and SiteSettings properties.

Declaration
public bool Equals(ProvisioningTemplate other)
Parameters
ProvisioningTemplate other

ProvisioningTemplate object
Returns
System.Boolean

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

Equals(Object)

Compares object with ProvisioningTemplate

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

Object that represents ProvisioningTemplate
Returns
System.Boolean

true if the current object is equal to the ProvisioningTemplate

GetHashCode()

Gets the hash code

Declaration
public override int GetHashCode()
Returns
System.Int32

Returns HashCode

ToXML(ITemplateFormatter)

Serializes a template to XML

Declaration
public string ToXML(ITemplateFormatter formatter = null)
Parameters
ITemplateFormatter formatter

ITemplateFormatter object
Returns
System.String

Returns XML string for the given stream

Extension Methods