Class TemplateProviderBase

Handles methods for Template Provider

Inheritance
System.Object
TemplateProviderBase
JsonTemplateProvider
MarkdownTemplateProvider
XMLTemplateProvider
Namespace: PnP.Framework.Provisioning.Providers
Assembly: PnP.Framework.dll
Syntax
public abstract class TemplateProviderBase : object

Constructors

TemplateProviderBase()

Default Constructor

Declaration
public TemplateProviderBase()

TemplateProviderBase(FileConnectorBase)

Constructor

Declaration
public TemplateProviderBase(FileConnectorBase connector)
Parameters
FileConnectorBase connector

Properties

Connector

File Connector

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

Parameters

Template parameters

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

SupportsDelete

Supports template delete

Declaration
public virtual bool SupportsDelete { get; }
Property Value
System.Boolean

SupportsSave

Supports template save

Declaration
public virtual bool SupportsSave { get; }
Property Value
System.Boolean

Uri

Uri of site

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

Methods

Delete(String)

Deletes ProvisioningTemplate

Declaration
public abstract void Delete(string uri)
Parameters
System.String uri

The target uri

GetHierarchies()

Gets list of ProvisioningHierarchies

Declaration
public abstract List<ProvisioningHierarchy> GetHierarchies()
Returns
List<ProvisioningHierarchy>

Returns collection of ProvisioningHierarchies

GetHierarchy(Stream)

Gets ProvisioningHierarchy

Declaration
public abstract ProvisioningHierarchy GetHierarchy(Stream stream)
Parameters
Stream stream

The source as a stream
Returns
ProvisioningHierarchy

Returns a ProvisioningHierarchy

GetHierarchy(String)

Gets ProvisioningHierarchy

Declaration
public abstract ProvisioningHierarchy GetHierarchy(string uri)
Parameters
System.String uri

The source uri
Returns
ProvisioningHierarchy

Returns a ProvisioningHierarchy

GetTemplate(Stream)

Gets ProvisioningTemplate

Declaration
public abstract ProvisioningTemplate GetTemplate(Stream stream)
Parameters
Stream stream

The source stream
Returns
ProvisioningTemplate

Returns a ProvisioningTemplate

GetTemplate(Stream, ITemplateFormatter)

Gets ProvisioningTemplate

Declaration
public abstract ProvisioningTemplate GetTemplate(Stream stream, ITemplateFormatter formatter)
Parameters
Stream stream

The source stream
ITemplateFormatter formatter

Provisioning Template formatter
Returns
ProvisioningTemplate

Returns a ProvisioningTemplate

GetTemplate(Stream, ITemplateProviderExtension[])

Gets ProvisioningTemplate

Declaration
public abstract ProvisioningTemplate GetTemplate(Stream stream, ITemplateProviderExtension[] extensions)
Parameters
Stream stream

The source stream
ITemplateProviderExtension[] extensions

Collection of provisioning template extensions
Returns
ProvisioningTemplate

Returns a ProvisioningTemplate

GetTemplate(Stream, String)

Gets ProvisioningTemplate

Declaration
public abstract ProvisioningTemplate GetTemplate(Stream stream, string identifier)
Parameters
Stream stream

The source stream
System.String identifier

ProvisioningTemplate identifier
Returns
ProvisioningTemplate

Returns a ProvisioningTemplate

GetTemplate(Stream, String, ITemplateFormatter)

Gets ProvisioningTemplate

Declaration
public abstract ProvisioningTemplate GetTemplate(Stream stream, string identifier, ITemplateFormatter formatter)
Parameters
Stream stream

The source stream
System.String identifier

ProvisioningTemplate identifier
ITemplateFormatter formatter

Provisioning Template formatter
Returns
ProvisioningTemplate

Returns a ProvisioningTemplate

GetTemplate(Stream, String, ITemplateFormatter, ITemplateProviderExtension[])

Gets ProvisioningTemplate

Declaration
public abstract ProvisioningTemplate GetTemplate(Stream stream, string identifier, ITemplateFormatter formatter, ITemplateProviderExtension[] extensions)
Parameters
Stream stream

The source stream
System.String identifier

ProvisioningTemplate identifier
ITemplateFormatter formatter

Provisioning Template formatter
ITemplateProviderExtension[] extensions

Collection of provisioning template extensions
Returns
ProvisioningTemplate

Returns a ProvisioningTemplate

GetTemplate(String)

Gets ProvisioningTemplate

Declaration
public abstract ProvisioningTemplate GetTemplate(string uri)
Parameters
System.String uri

The source uri
Returns
ProvisioningTemplate

Returns a ProvisioningTemplate

GetTemplate(String, ITemplateFormatter)

Gets ProvisioningTemplate

Declaration
public abstract ProvisioningTemplate GetTemplate(string uri, ITemplateFormatter formatter)
Parameters
System.String uri

The source uri
ITemplateFormatter formatter

Provisioning Template formatter
Returns
ProvisioningTemplate

Returns a ProvisioningTemplate

GetTemplate(String, ITemplateProviderExtension[])

Gets ProvisioningTemplate

Declaration
public abstract ProvisioningTemplate GetTemplate(string uri, ITemplateProviderExtension[] extensions)
Parameters
System.String uri

The source uri
ITemplateProviderExtension[] extensions

Collection of provisioning template extensions
Returns
ProvisioningTemplate

Returns a ProvisioningTemplate

GetTemplate(String, String)

Gets ProvisioningTemplate

Declaration
public abstract ProvisioningTemplate GetTemplate(string uri, string identifier)
Parameters
System.String uri

The source uri
System.String identifier

ProvisioningTemplate identifier
Returns
ProvisioningTemplate

Returns a ProvisioningTemplate

GetTemplate(String, String, ITemplateFormatter)

Gets ProvisioningTemplate

Declaration
public abstract ProvisioningTemplate GetTemplate(string uri, string identifier, ITemplateFormatter formatter)
Parameters
System.String uri

The source uri
System.String identifier

ProvisioningTemplate identifier
ITemplateFormatter formatter

Provisioning Template formatter
Returns
ProvisioningTemplate

Returns a ProvisioningTemplate

GetTemplate(String, String, ITemplateFormatter, ITemplateProviderExtension[])

Gets ProvisioningTemplate

Declaration
public abstract ProvisioningTemplate GetTemplate(string uri, string identifier, ITemplateFormatter formatter, ITemplateProviderExtension[] extensions)
Parameters
System.String uri

The source uri
System.String identifier

ProvisioningTemplate identifier
ITemplateFormatter formatter

Provisioning Template formatter
ITemplateProviderExtension[] extensions

Collection of provisioning template extensions
Returns
ProvisioningTemplate

Returns a ProvisioningTemplate

GetTemplates()

Gets list of ProvisioningTemplates

Declaration
public abstract List<ProvisioningTemplate> GetTemplates()
Returns
List<ProvisioningTemplate>

Returns collection of ProvisioningTemplate

GetTemplates(ITemplateFormatter)

Gets list of ProvisioningTemplates

Declaration
public abstract List<ProvisioningTemplate> GetTemplates(ITemplateFormatter formatter)
Parameters
ITemplateFormatter formatter

Provisioning Template formatter
Returns
List<ProvisioningTemplate>

Returns collection of ProvisioningTemplate

PostProcessGetTemplateExtensions(ITemplateProviderExtension[], ProvisioningTemplate)

Declaration
protected ProvisioningTemplate PostProcessGetTemplateExtensions(ITemplateProviderExtension[] extensions, ProvisioningTemplate template)
Parameters
ITemplateProviderExtension[] extensions

ProvisioningTemplate template

Returns
ProvisioningTemplate

PostProcessSaveTemplateExtensions(ITemplateProviderExtension[], Stream)

Declaration
protected Stream PostProcessSaveTemplateExtensions(ITemplateProviderExtension[] extensions, Stream stream)
Parameters
ITemplateProviderExtension[] extensions

Stream stream

Returns
Stream

PreProcessGetTemplateExtensions(ITemplateProviderExtension[], Stream)

Declaration
protected Stream PreProcessGetTemplateExtensions(ITemplateProviderExtension[] extensions, Stream stream)
Parameters
ITemplateProviderExtension[] extensions

Stream stream

Returns
Stream

PreProcessSaveTemplateExtensions(ITemplateProviderExtension[], ProvisioningTemplate)

This method is invoked before calling the formatter to serialize the template

Declaration
protected virtual ProvisioningTemplate PreProcessSaveTemplateExtensions(ITemplateProviderExtension[] extensions, ProvisioningTemplate template)
Parameters
ITemplateProviderExtension[] extensions

The list of custom extensions
ProvisioningTemplate template

The template to serialize
Returns
ProvisioningTemplate

The template eventually updated by the custom extensions

Save(ProvisioningHierarchy)

Saves ProvisioningHierarchy

Declaration
public abstract void Save(ProvisioningHierarchy hierarchy)
Parameters
ProvisioningHierarchy hierarchy

Provisioning Hierarchy

Save(ProvisioningTemplate)

Saves ProvisioningTemplate

Declaration
public abstract void Save(ProvisioningTemplate template)
Parameters
ProvisioningTemplate template

Provisioning Template

Save(ProvisioningTemplate, ITemplateFormatter)

Saves ProvisioningTemplate

Declaration
public abstract void Save(ProvisioningTemplate template, ITemplateFormatter formatter)
Parameters
ProvisioningTemplate template

Provisioning Template
ITemplateFormatter formatter

Provisioning Template Formatter

Save(ProvisioningTemplate, ITemplateFormatter, ITemplateProviderExtension[])

Saves ProvisioningTemplate

Declaration
public abstract void Save(ProvisioningTemplate template, ITemplateFormatter formatter, ITemplateProviderExtension[] extensions)
Parameters
ProvisioningTemplate template

Provisioning Template
ITemplateFormatter formatter

Provisioning Template Formatter
ITemplateProviderExtension[] extensions

Collection of provisioning template extensions

Save(ProvisioningTemplate, ITemplateProviderExtension[])

Saves ProvisioningTemplate

Declaration
public abstract void Save(ProvisioningTemplate template, ITemplateProviderExtension[] extensions)
Parameters
ProvisioningTemplate template

Provisioning Template
ITemplateProviderExtension[] extensions

Collection of provisioning template extensions

SaveAs(ProvisioningHierarchy, String, ITemplateFormatter)

Saves ProvisioningHierarchy

Declaration
public abstract void SaveAs(ProvisioningHierarchy hierarchy, string uri, ITemplateFormatter formatter = null)
Parameters
ProvisioningHierarchy hierarchy

Provisioning Hierarchy
System.String uri

The target uri
ITemplateFormatter formatter

Provisioning Template Formatter

SaveAs(ProvisioningTemplate, String)

Saves ProvisioningTemplate

Declaration
public abstract void SaveAs(ProvisioningTemplate template, string uri)
Parameters
ProvisioningTemplate template

Provisioning Template
System.String uri

The target uri

SaveAs(ProvisioningTemplate, String, ITemplateFormatter)

Saves ProvisioningTemplate

Declaration
public abstract void SaveAs(ProvisioningTemplate template, string uri, ITemplateFormatter formatter)
Parameters
ProvisioningTemplate template

Provisioning Template
System.String uri

The target uri
ITemplateFormatter formatter

Provisioning Template Formatter

SaveAs(ProvisioningTemplate, String, ITemplateFormatter, ITemplateProviderExtension[])

Saves ProvisioningTemplate

Declaration
public abstract void SaveAs(ProvisioningTemplate template, string uri, ITemplateFormatter formatter, ITemplateProviderExtension[] extensions)
Parameters
ProvisioningTemplate template

Provisioning Template
System.String uri

The target uri
ITemplateFormatter formatter

Provisioning Template Formatter
ITemplateProviderExtension[] extensions

Collection of provisioning template extensions

SaveAs(ProvisioningTemplate, String, ITemplateProviderExtension[])

Saves ProvisioningTemplate

Declaration
public abstract void SaveAs(ProvisioningTemplate template, string uri, ITemplateProviderExtension[] extensions)
Parameters
ProvisioningTemplate template

Provisioning Template
System.String uri

The target uri
ITemplateProviderExtension[] extensions

Collection of provisioning template extensions

SaveToConnector(ProvisioningTemplate, String, ITemplateFormatter, ITemplateProviderExtension[])

Declaration
protected virtual void SaveToConnector(ProvisioningTemplate template, string uri, ITemplateFormatter formatter, ITemplateProviderExtension[] extensions)
Parameters
ProvisioningTemplate template

System.String uri

ITemplateFormatter formatter

ITemplateProviderExtension[] extensions

Extension Methods