C# Class OfficeDevPnP.Core.Framework.Provisioning.ObjectHandlers.ObjectFiles

Inheritance: ObjectHandlerBase

Mostra file Open project: OfficeDev/PnP-Sites-Core Class Usage Examples

Public Properties

Property	Type	Description
BlockedExtensionsInNoScript	string[]
BlockedLibrariesInNoScript	string[]

Public Methods

Method	Description
ExtractObjects ( Web web, ProvisioningTemplate template, ProvisioningTemplateCreationInformation creationInfo ) : ProvisioningTemplate
ProvisionObjects ( Web web, ProvisioningTemplate template, TokenParser parser, ProvisioningTemplateApplyingInformation applyingInformation ) : TokenParser
SetFileProperties ( Microsoft.SharePoint.Client.File file, string>.IDictionary properties, bool checkoutIfRequired = true ) : void
SkipFile ( bool isNoScriptSite, string fileName, string folderName ) : bool	Checks if a given file can be uploaded. Sites using NoScript can't handle all uploads
WillExtract ( Web web, ProvisioningTemplate template, ProvisioningTemplateCreationInformation creationInfo ) : bool
WillProvision ( Web web, ProvisioningTemplate template ) : bool

Private Methods

Method	Description
CheckOutIfNeeded ( Web web, Microsoft.SharePoint.Client.File targetFile ) : bool
CleanupEntities ( ProvisioningTemplate template, ProvisioningTemplate baseTemplate ) : ProvisioningTemplate
GetFileStream ( ProvisioningTemplate template, Model file ) : Stream	Retrieves Stream from connector. If the file name contains special characters (e.g. "%20") and cannot be retrieved, a workaround will be performed
Tokenize ( Web web, string xml ) : string
UploadFile ( ProvisioningTemplate template, Model file, Microsoft folder, Stream stream ) : Microsoft.SharePoint.Client.File

Method Details

ExtractObjects() public method

public ExtractObjects ( Web web, ProvisioningTemplate template, ProvisioningTemplateCreationInformation creationInfo ) : ProvisioningTemplate
web	Web
template	ProvisioningTemplate
creationInfo	ProvisioningTemplateCreationInformation
return	ProvisioningTemplate

ProvisionObjects() public method

public ProvisionObjects ( Web web, ProvisioningTemplate template, TokenParser parser, ProvisioningTemplateApplyingInformation applyingInformation ) : TokenParser
web	Web
template	ProvisioningTemplate
parser	TokenParser
applyingInformation	ProvisioningTemplateApplyingInformation
return	TokenParser

SetFileProperties() public method

public SetFileProperties ( Microsoft.SharePoint.Client.File file, string>.IDictionary properties, bool checkoutIfRequired = true ) : void
file	Microsoft.SharePoint.Client.File
properties	string>.IDictionary
checkoutIfRequired	bool
return	void

SkipFile() public static method

Checks if a given file can be uploaded. Sites using NoScript can't handle all uploads

public static SkipFile ( bool isNoScriptSite, string fileName, string folderName ) : bool
isNoScriptSite	bool	Is this a noscript site?
fileName	string	Filename to verify
folderName	string	Folder (library) to verify
return	bool

WillExtract() public method

public WillExtract ( Web web, ProvisioningTemplate template, ProvisioningTemplateCreationInformation creationInfo ) : bool
web	Web
template	ProvisioningTemplate
creationInfo	ProvisioningTemplateCreationInformation
return	bool

WillProvision() public method

public WillProvision ( Web web, ProvisioningTemplate template ) : bool
web	Web
template	ProvisioningTemplate
return	bool

Property Details

BlockedExtensionsInNoScript public_oe static_oe property

public static string[] BlockedExtensionsInNoScript
return	string[]

BlockedLibrariesInNoScript public_oe static_oe property

public static string[] BlockedLibrariesInNoScript
return	string[]