Interface ITemplateProviderExtension

Interface for extending the XMLTemplateProvider while retrieving a template

Namespace: PnP.Framework.Provisioning.Providers
Assembly: PnP.Framework.dll
Syntax
public interface ITemplateProviderExtension

Properties

SupportsGetTemplatePostProcessing

Declares whether the object supports post-processing during GetTemplate

Declaration
Boolean SupportsGetTemplatePostProcessing { get; }
Property Value
Boolean

SupportsGetTemplatePreProcessing

Declares whether the object supports pre-processing during GetTemplate

Declaration
Boolean SupportsGetTemplatePreProcessing { get; }
Property Value
Boolean

SupportsSaveTemplatePostProcessing

Declares whether the object supports post-processing during SaveTemplate

Declaration
Boolean SupportsSaveTemplatePostProcessing { get; }
Property Value
Boolean

SupportsSaveTemplatePreProcessing

Declares whether the object supports pre-processing during SaveTemplate

Declaration
Boolean SupportsSaveTemplatePreProcessing { get; }
Property Value
Boolean

Methods

Initialize(Object)

Initialization method to setup the extension object

Declaration
void Initialize(Object settings)
Parameters
Object settings

PostProcessGetTemplate(ProvisioningTemplate)

Method invoked after deserializing the template from the source repository

Declaration
ProvisioningTemplate PostProcessGetTemplate(ProvisioningTemplate template)
Parameters
ProvisioningTemplate template

The just deserialized template
Returns
ProvisioningTemplate

The resulting template, after post-processing

PostProcessSaveTemplate(Stream)

Method invoked after serializing the template and before it is saved onto the target repository

Declaration
Stream PostProcessSaveTemplate(Stream stream)
Parameters
Stream stream

The source stream
Returns
Stream

The resulting stream, after pre-processing

PreProcessGetTemplate(Stream)

Method invoked before deserializing the template from the source repository

Declaration
Stream PreProcessGetTemplate(Stream stream)
Parameters
Stream stream

The source stream
Returns
Stream

The resulting stream, after pre-processing

PreProcessSaveTemplate(ProvisioningTemplate)

Method invoked before serializing the template and before it is saved onto the target repository

Declaration
ProvisioningTemplate PreProcessSaveTemplate(ProvisioningTemplate template)
Parameters
ProvisioningTemplate template

The template that is going to be serialized
Returns
ProvisioningTemplate

The resulting template, after pre-processing

Extension Methods