Interface ITemplateFormatter

Interface for basic capabilites that any Template Formatter should provide/support

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

Methods

Initialize(TemplateProviderBase)

Method to initialize the formatter with the proper TemplateProvider instance

Declaration
void Initialize(TemplateProviderBase provider)
Parameters
TemplateProviderBase provider

The provider that is calling the current template formatter

IsValid(Stream)

Method to validate the content of a formatted template instance

Declaration
bool IsValid(Stream template)
Parameters
Stream template

The formatted template instance as a Stream
Returns
System.Boolean

Boolean result of the validation

ToFormattedTemplate(ProvisioningTemplate)

Method to format a ProvisioningTemplate into a formatted template

Declaration
Stream ToFormattedTemplate(ProvisioningTemplate template)
Parameters
ProvisioningTemplate template

The input ProvisioningTemplate
Returns
Stream

The output formatted template as a Stream

ToProvisioningTemplate(Stream)

Method to convert a formatted template into a ProvisioningTemplate

Declaration
ProvisioningTemplate ToProvisioningTemplate(Stream template)
Parameters
Stream template

The input formatted template as a Stream
Returns
ProvisioningTemplate

The output ProvisioningTemplate

ToProvisioningTemplate(Stream, String)

Method to convert a formatted template into a ProvisioningTemplate, based on a specific ID

Declaration
ProvisioningTemplate ToProvisioningTemplate(Stream template, String identifier)
Parameters
Stream template

The input formatted template as a Stream
String identifier

The identifier of the template to convert
Returns
ProvisioningTemplate

The output ProvisioningTemplate

Extension Methods