Class FileService

Represents the File Service, which is an easy access to operations involving objects like Scripts, Stylesheets and Templates

Inheritance

System.Object

RepositoryService

Namespace: Umbraco.Cms.Core.Services.Implement

Assembly: cs.temp.dll.dll

Syntax

public class FileService : RepositoryService

Constructors

FileService(IScopeProvider, ILoggerFactory, IEventMessagesFactory, IStylesheetRepository, IScriptRepository, ITemplateRepository, IPartialViewRepository, IPartialViewMacroRepository, IAuditRepository, IShortStringHelper, IOptions<GlobalSettings>, IHostingEnvironment)

Declaration

public FileService(IScopeProvider uowProvider, ILoggerFactory loggerFactory, IEventMessagesFactory eventMessagesFactory, IStylesheetRepository stylesheetRepository, IScriptRepository scriptRepository, ITemplateRepository templateRepository, IPartialViewRepository partialViewRepository, IPartialViewMacroRepository partialViewMacroRepository, IAuditRepository auditRepository, IShortStringHelper shortStringHelper, IOptions<GlobalSettings> globalSettings, IHostingEnvironment hostingEnvironment)

Parameters

Type	Name	Description
IScopeProvider	uowProvider
ILoggerFactory	loggerFactory
IEventMessagesFactory	eventMessagesFactory
IStylesheetRepository	stylesheetRepository
IScriptRepository	scriptRepository
ITemplateRepository	templateRepository
IPartialViewRepository	partialViewRepository
IPartialViewMacroRepository	partialViewMacroRepository
IAuditRepository	auditRepository
IShortStringHelper	shortStringHelper
IOptions<GlobalSettings>	globalSettings
IHostingEnvironment	hostingEnvironment

Methods

CreatePartialView(IPartialView, String, Int32)

Declaration

public Attempt<IPartialView> CreatePartialView(IPartialView partialView, string snippetName = null, int userId = default(int))

Parameters

Type	Name	Description
IPartialView	partialView
System.String	snippetName
System.Int32	userId

Returns

Type	Description
Attempt<IPartialView>

CreatePartialViewFolder(String)

Declaration

public void CreatePartialViewFolder(string folderPath)

Parameters

Type	Name	Description
System.String	folderPath

CreatePartialViewMacro(IPartialView, String, Int32)

Declaration

public Attempt<IPartialView> CreatePartialViewMacro(IPartialView partialView, string snippetName = null, int userId = default(int))

Parameters

Type	Name	Description
IPartialView	partialView
System.String	snippetName
System.Int32	userId

Returns

Type	Description
Attempt<IPartialView>

CreatePartialViewMacroFolder(String)

Declaration

public void CreatePartialViewMacroFolder(string folderPath)

Parameters

Type	Name	Description
System.String	folderPath

CreateScriptFolder(String)

Declaration

public void CreateScriptFolder(string folderPath)

Parameters

Type	Name	Description
System.String	folderPath

CreateStyleSheetFolder(String)

Declaration

public void CreateStyleSheetFolder(string folderPath)

Parameters

Type	Name	Description
System.String	folderPath

CreateTemplateForContentType(String, String, Int32)

Creates a template for a content type

Declaration

public Attempt<OperationResult<OperationResultType, ITemplate>> CreateTemplateForContentType(string contentTypeAlias, string contentTypeName, int userId = default(int))

Parameters

Type	Name	Description
System.String	contentTypeAlias
System.String	contentTypeName
System.Int32	userId

Returns

Type	Description
Attempt<OperationResult<OperationResultType, ITemplate>>	The template created

CreateTemplateWithIdentity(String, String, String, ITemplate, Int32)

Create a new template, setting the content if a view exists in the filesystem

Declaration

public ITemplate CreateTemplateWithIdentity(string name, string alias, string content, ITemplate masterTemplate = null, int userId = default(int))

Parameters

Type	Name	Description
System.String	name
System.String	alias
System.String	content
ITemplate	masterTemplate
System.Int32	userId

Returns

Type	Description
ITemplate

DeletePartialView(String, Int32)

Declaration

public bool DeletePartialView(string path, int userId = default(int))

Parameters

Type	Name	Description
System.String	path
System.Int32	userId

Returns

Type	Description
System.Boolean

DeletePartialViewFolder(String)

Declaration

public void DeletePartialViewFolder(string folderPath)

Parameters

Type	Name	Description
System.String	folderPath

DeletePartialViewMacro(String, Int32)

Declaration

public bool DeletePartialViewMacro(string path, int userId = default(int))

Parameters

Type	Name	Description
System.String	path
System.Int32	userId

Returns

Type	Description
System.Boolean

DeletePartialViewMacroFolder(String)

Declaration

public void DeletePartialViewMacroFolder(string folderPath)

Parameters

Type	Name	Description
System.String	folderPath

DeleteScript(String, Int32)

Declaration

public void DeleteScript(string path, int userId = default(int))

Parameters

Type	Name	Description
System.String	path
System.Int32	userId

DeleteScriptFolder(String)

Declaration

public void DeleteScriptFolder(string folderPath)

Parameters

Type	Name	Description
System.String	folderPath

DeleteStylesheet(String, Int32)

Declaration

public void DeleteStylesheet(string path, int userId = default(int))

Parameters

Type	Name	Description
System.String	path
System.Int32	userId

DeleteStyleSheetFolder(String)

Declaration

public void DeleteStyleSheetFolder(string folderPath)

Parameters

Type	Name	Description
System.String	folderPath

DeleteTemplate(String, Int32)

Deletes a template by its alias

Declaration

public void DeleteTemplate(string alias, int userId = default(int))

Parameters

Type	Name	Description
System.String	alias	Alias of the to delete
System.Int32	userId

GetPartialView(String)

Declaration

public IPartialView GetPartialView(string path)

Parameters

Type	Name	Description
System.String	path

Returns

Type	Description
IPartialView

GetPartialViewFileContentStream(String)

Declaration

public Stream GetPartialViewFileContentStream(string filepath)

Parameters

Type	Name	Description
System.String	filepath

Returns

Type	Description
Stream

GetPartialViewFileSize(String)

Declaration

public long GetPartialViewFileSize(string filepath)

Parameters

Type	Name	Description
System.String	filepath

Returns

Type	Description
System.Int64

GetPartialViewMacro(String)

Declaration

public IPartialView GetPartialViewMacro(string path)

Parameters

Type	Name	Description
System.String	path

Returns

Type	Description
IPartialView

GetPartialViewMacroFileContentStream(String)

Declaration

public Stream GetPartialViewMacroFileContentStream(string filepath)

Parameters

Type	Name	Description
System.String	filepath

Returns

Type	Description
Stream

GetPartialViewMacroFileSize(String)

Declaration

public long GetPartialViewMacroFileSize(string filepath)

Parameters

Type	Name	Description
System.String	filepath

Returns

Type	Description
System.Int64

GetPartialViewMacroSnippetContent(String)

Declaration

public string GetPartialViewMacroSnippetContent(string snippetName)

Parameters

Type	Name	Description
System.String	snippetName

Returns

Type	Description
System.String

GetPartialViews(String[])

Declaration

public IEnumerable<IPartialView> GetPartialViews(params string[] names)

Parameters

Type	Name	Description
System.String[]	names

Returns

Type	Description
System.Collections.Generic.IEnumerable<IPartialView>

GetPartialViewSnippetContent(String)

Declaration

public string GetPartialViewSnippetContent(string snippetName)

Parameters

Type	Name	Description
System.String	snippetName

Returns

Type	Description
System.String

GetPartialViewSnippetNames(String[])

Declaration

public IEnumerable<string> GetPartialViewSnippetNames(params string[] filterNames)

Parameters

Type	Name	Description
System.String[]	filterNames

Returns

Type	Description
System.Collections.Generic.IEnumerable<System.String>

GetScript(String)

Declaration

public IScript GetScript(string name)

Parameters

Type	Name	Description
System.String	name

Returns

Type	Description
IScript

GetScriptFileContentStream(String)

Declaration

public Stream GetScriptFileContentStream(string filepath)

Parameters

Type	Name	Description
System.String	filepath

Returns

Type	Description
Stream

GetScriptFileSize(String)

Declaration

public long GetScriptFileSize(string filepath)

Parameters

Type	Name	Description
System.String	filepath

Returns

Type	Description
System.Int64

GetScripts(String[])

Declaration

public IEnumerable<IScript> GetScripts(params string[] names)

Parameters

Type	Name	Description
System.String[]	names

Returns

Type	Description
System.Collections.Generic.IEnumerable<IScript>

GetStylesheet(String)

Declaration

public IStylesheet GetStylesheet(string path)

Parameters

Type	Name	Description
System.String	path

Returns

Type	Description
IStylesheet

GetStylesheetFileContentStream(String)

Declaration

public Stream GetStylesheetFileContentStream(string filepath)

Parameters

Type	Name	Description
System.String	filepath

Returns

Type	Description
Stream

GetStylesheetFileSize(String)

Declaration

public long GetStylesheetFileSize(string filepath)

Parameters

Type	Name	Description
System.String	filepath

Returns

Type	Description
System.Int64

GetStylesheets(String[])

Declaration

public IEnumerable<IStylesheet> GetStylesheets(params string[] paths)

Parameters

Type	Name	Description
System.String[]	paths

Returns

Type	Description
System.Collections.Generic.IEnumerable<IStylesheet>

GetTemplate(Guid)

Gets a object by its guid identifier.

Declaration

public ITemplate GetTemplate(Guid id)

Parameters

Type	Name	Description
System.Guid	id	The guid identifier of the template.

Returns

Type	Description
ITemplate	The object matching the identifier, or null.

GetTemplate(Int32)

Gets a object by its identifier.

Declaration

public ITemplate GetTemplate(int id)

Parameters

Type	Name	Description
System.Int32	id	The identifier of the template.

Returns

Type	Description
ITemplate	The object matching the identifier, or null.

GetTemplate(String)

Gets a object by its alias.

Declaration

public ITemplate GetTemplate(string alias)

Parameters

Type	Name	Description
System.String	alias	The alias of the template.

Returns

Type	Description
ITemplate	The object matching the alias, or null.

GetTemplateDescendants(Int32)

Gets the template descendants

Declaration

public IEnumerable<ITemplate> GetTemplateDescendants(int masterTemplateId)

Parameters

Type	Name	Description
System.Int32	masterTemplateId

Returns

Type	Description
System.Collections.Generic.IEnumerable<ITemplate>

GetTemplateFileContentStream(String)

Declaration

public Stream GetTemplateFileContentStream(string filepath)

Parameters

Type	Name	Description
System.String	filepath

Returns

Type	Description
Stream

GetTemplateFileSize(String)

Declaration

public long GetTemplateFileSize(string filepath)

Parameters

Type	Name	Description
System.String	filepath

Returns

Type	Description
System.Int64

GetTemplates(Int32)

Gets a list of all objects

Declaration

public IEnumerable<ITemplate> GetTemplates(int masterTemplateId)

Parameters

Type	Name	Description
System.Int32	masterTemplateId

Returns

Type	Description
System.Collections.Generic.IEnumerable<ITemplate>	An enumerable list of objects

GetTemplates(String[])

Gets a list of all objects

Declaration

public IEnumerable<ITemplate> GetTemplates(params string[] aliases)

Parameters

Type	Name	Description
System.String[]	aliases

Returns

Type	Description
System.Collections.Generic.IEnumerable<ITemplate>	An enumerable list of objects

SavePartialView(IPartialView, Int32)

Declaration

public Attempt<IPartialView> SavePartialView(IPartialView partialView, int userId = default(int))

Parameters

Type	Name	Description
IPartialView	partialView
System.Int32	userId

Returns

Type	Description
Attempt<IPartialView>

SavePartialViewMacro(IPartialView, Int32)

Declaration

public Attempt<IPartialView> SavePartialViewMacro(IPartialView partialView, int userId = default(int))

Parameters

Type	Name	Description
IPartialView	partialView
System.Int32	userId

Returns

Type	Description
Attempt<IPartialView>

SaveScript(IScript, Int32)

Declaration

public void SaveScript(IScript script, int userId = default(int))

Parameters

Type	Name	Description
IScript	script
System.Int32	userId

SaveStylesheet(IStylesheet, Int32)

Declaration

public void SaveStylesheet(IStylesheet stylesheet, int userId = default(int))

Parameters

Type	Name	Description
IStylesheet	stylesheet
System.Int32	userId

SaveTemplate(ITemplate, Int32)

Saves a

Declaration

public void SaveTemplate(ITemplate template, int userId = default(int))

Parameters

Type	Name	Description
ITemplate	template	to save
System.Int32	userId

SaveTemplate(IEnumerable<ITemplate>, Int32)

Saves a collection of objects

Declaration

public void SaveTemplate(IEnumerable<ITemplate> templates, int userId = default(int))

Parameters

Type	Name	Description
System.Collections.Generic.IEnumerable<ITemplate>	templates	List of to save
System.Int32	userId	Optional id of the user

SetPartialViewFileContent(String, Stream)

Declaration

public void SetPartialViewFileContent(string filepath, Stream content)

Parameters

Type	Name	Description
System.String	filepath
Stream	content

SetPartialViewMacroFileContent(String, Stream)

Declaration

public void SetPartialViewMacroFileContent(string filepath, Stream content)

Parameters

Type	Name	Description
System.String	filepath
Stream	content

SetScriptFileContent(String, Stream)

Declaration

public void SetScriptFileContent(string filepath, Stream content)

Parameters

Type	Name	Description
System.String	filepath
Stream	content

SetStylesheetFileContent(String, Stream)

Declaration

public void SetStylesheetFileContent(string filepath, Stream content)

Parameters

Type	Name	Description
System.String	filepath
Stream	content

SetTemplateFileContent(String, Stream)

Declaration

public void SetTemplateFileContent(string filepath, Stream content)

Parameters

Type	Name	Description
System.String	filepath
Stream	content