Class Directory

Defines a Directory element, to describe a folder in the current repository that will be used to upload files into the target Site

Inheritance
System.Object
BaseModel
Directory
Inherited Members
Namespace: PnP.Framework.Provisioning.Model
Assembly: PnP.Framework.dll
Syntax
public class Directory : BaseModel, IProvisioningTemplateDescendant

Constructors

Directory()

Constructor for Directory class

Declaration
public Directory()

Directory(String, String, Boolean, FileLevel, Boolean, String, String, String, ObjectSecurity)

Constructor for Directory class

Declaration
public Directory(string src, string folder, bool overwrite, FileLevel level = FileLevel.Draft, bool recursive = false, string includeExtensions = null, string excludeExtensions = null, string metadataMappingFile = null, ObjectSecurity security = null)
Parameters
System.String src

Source Name
System.String folder

Folder Path
System.Boolean overwrite

Overwrite property
FileLevel level

File Level
System.Boolean recursive

Recursive property
System.String includeExtensions

Extensions which can be included in directory files
System.String excludeExtensions

Extensions which are excluded in drectory files
System.String metadataMappingFile

Metadata Mapping File
ObjectSecurity security

ObjectSecurity

Properties

ExcludedExtensions

The file Extensions to exclude while uploading the Directory

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

Folder

The TargetFolder of the Directory

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

IncludedExtensions

The file Extensions to include while uploading the Directory

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

Level

The Level status for the files in the Directory

Declaration
public FileLevel Level { get; set; }
Property Value
FileLevel

MetadataMappingFile

The file path of JSON mapping file with metadata for files to upload in the Directory

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

Overwrite

The Overwrite flag for the files in the Directory

Declaration
public bool Overwrite { get; set; }
Property Value
System.Boolean

Recursive

Defines whether to recursively browse through all the child folders of the Directory

Declaration
public bool Recursive { get; set; }
Property Value
System.Boolean

Security

Defines the Security rules for the File

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

Src

The Src of the Directory

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

Methods

Equals(Directory)

Compares Directory object based on ExcludedExtensions, Folder, IncludedExtensions, Level, MetaDataMappingFile, Overwrite, Recursive, Src and Security properties.

Declaration
public bool Equals(Directory other)
Parameters
Directory other

Directory object
Returns
System.Boolean

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

Equals(Object)

Compares object with Directory

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

Object that represents Directory
Returns
System.Boolean

true if the current object is equal to the Directory

GetHashCode()

Gets the hash code

Declaration
public override int GetHashCode()
Returns
System.Int32

Returns HashCode

Extension Methods