C# Class JDP.Remediation.Console.Helper

Show file Open project: OfficeDev/PnP-Transformation

Public Properties

Property	Type	Description
alreadyAuthorized	bool
contextCount	int

Public Methods

Method	Description
AddWebPartToPage ( Web web, string webPartFile, Microsoft page, string zoneId ) : void
CreateAuthenticatedUserContext ( string domain, string username, SecureString password, string siteUrl ) : ClientContext
CreateAuthenticatedUserContextOld ( string domain, string username, SecureString password, string siteUrl ) : ClientContext
CreateSecureString ( string data ) : SecureString	Creates a Secure String
DeleteFileByServerRelativeUrl ( Web web, string serverRelativeFilePath ) : bool	Deletes the specified file from the specified web.
DeleteListByUrl ( Web web, string webRelativeUrl ) : void
DeleteMasterPageCatalogFile ( Web web, string mpFileName ) : void
DeleteWebPartFile ( Web web, string wpFileName ) : void
EnsureSiteColumn ( Web root, System.Guid fieldID, string fieldAsXml ) : Field
GetFileFromWeb ( Web web, string filePath ) : File
GetMasterPageInfo ( Web web ) : MasterPageInfo
ParseInputLine ( string inputLine ) : string[]
PublishMasterPage ( Web web, string mpFilePath, string title, string description ) : string
ReadInputFile ( string inputFileSpec, bool hasHeader ) : string[]
RemoveWebPartFromPage ( Web web, string wpTitle, File wpPage ) : void
SetMasterPages ( Web web, MasterPageInfo mpi, bool isRoot ) : void
SetMasterPages ( Web web, string mpFilePath, bool isRoot, bool inheritMaster ) : void
UploadDisplayTemplateFileJS ( Web web, string dtFileName, string localFilePath, string displayTemplateFolderName, string title, string description ) : void
UploadMasterPage ( Web web, string mpFileName, string localFilePath, string title, string description ) : string
UploadWebPartFile ( Web web, string wpFileName, string localFilePath, string title, string description ) : void
WebPartIsPresentOnPage ( Web web, string wpTitle, File wpPage ) : bool

Private Methods

Method	Description
GetContentType ( Web web, List list, string contentType ) : string

Method Details

AddWebPartToPage() public static method

public static AddWebPartToPage ( Web web, string webPartFile, Microsoft page, string zoneId ) : void
web	Web
webPartFile	string
page	Microsoft
zoneId	string
return	void

CreateAuthenticatedUserContext() public static method

public static CreateAuthenticatedUserContext ( string domain, string username, SecureString password, string siteUrl ) : ClientContext
domain	string
username	string
password	System.Security.SecureString
siteUrl	string
return	ClientContext

CreateAuthenticatedUserContextOld() public static method

public static CreateAuthenticatedUserContextOld ( string domain, string username, SecureString password, string siteUrl ) : ClientContext
domain	string
username	string
password	System.Security.SecureString
siteUrl	string
return	ClientContext

CreateSecureString() public static method

Creates a Secure String

public static CreateSecureString ( string data ) : SecureString
data	string	string to be converted
return	System.Security.SecureString

DeleteFileByServerRelativeUrl() public static method

Deletes the specified file from the specified web.

public static DeleteFileByServerRelativeUrl ( Web web, string serverRelativeFilePath ) : bool
web	Web	this MUST be the web that contains the file to delete
serverRelativeFilePath	string	the SERVER-relative path to the file ("/sites/site/web/lib/folder/file.ext")
return	bool

DeleteListByUrl() public static method

public static DeleteListByUrl ( Web web, string webRelativeUrl ) : void
web	Web
webRelativeUrl	string
return	void

DeleteMasterPageCatalogFile() public static method

public static DeleteMasterPageCatalogFile ( Web web, string mpFileName ) : void
web	Web
mpFileName	string
return	void

DeleteWebPartFile() public static method

public static DeleteWebPartFile ( Web web, string wpFileName ) : void
web	Web
wpFileName	string
return	void

EnsureSiteColumn() public static method

public static EnsureSiteColumn ( Web root, System.Guid fieldID, string fieldAsXml ) : Field
root	Web
fieldID	System.Guid
fieldAsXml	string
return	Field

GetFileFromWeb() public static method

public static GetFileFromWeb ( Web web, string filePath ) : File
web	Web
filePath	string
return	File

GetMasterPageInfo() public static method

public static GetMasterPageInfo ( Web web ) : MasterPageInfo
web	Web
return	MasterPageInfo

ParseInputLine() public static method

public static ParseInputLine ( string inputLine ) : string[]
inputLine	string
return	string[]

PublishMasterPage() public static method

public static PublishMasterPage ( Web web, string mpFilePath, string title, string description ) : string
web	Web
mpFilePath	string
title	string
description	string
return	string

ReadInputFile() public static method

public static ReadInputFile ( string inputFileSpec, bool hasHeader ) : string[]
inputFileSpec	string
hasHeader	bool
return	string[]

RemoveWebPartFromPage() public static method

public static RemoveWebPartFromPage ( Web web, string wpTitle, File wpPage ) : void
web	Web
wpTitle	string
wpPage	File
return	void

SetMasterPages() public static method

public static SetMasterPages ( Web web, MasterPageInfo mpi, bool isRoot ) : void
web	Web
mpi	MasterPageInfo
isRoot	bool
return	void

SetMasterPages() public static method

public static SetMasterPages ( Web web, string mpFilePath, bool isRoot, bool inheritMaster ) : void
web	Web
mpFilePath	string
isRoot	bool
inheritMaster	bool
return	void

UploadDisplayTemplateFileJS() public static method

public static UploadDisplayTemplateFileJS ( Web web, string dtFileName, string localFilePath, string displayTemplateFolderName, string title, string description ) : void
web	Web
dtFileName	string
localFilePath	string
displayTemplateFolderName	string
title	string
description	string
return	void

UploadMasterPage() public static method

public static UploadMasterPage ( Web web, string mpFileName, string localFilePath, string title, string description ) : string
web	Web
mpFileName	string
localFilePath	string
title	string
description	string
return	string

UploadWebPartFile() public static method

public static UploadWebPartFile ( Web web, string wpFileName, string localFilePath, string title, string description ) : void
web	Web
wpFileName	string
localFilePath	string
title	string
description	string
return	void

WebPartIsPresentOnPage() public static method

public static WebPartIsPresentOnPage ( Web web, string wpTitle, File wpPage ) : bool
web	Web
wpTitle	string
wpPage	File
return	bool

Property Details

alreadyAuthorized public static property

public static bool alreadyAuthorized
return	bool

contextCount public static property

public static int contextCount
return	int