View Source

Interface IBasicFileService<TEntity>

Namespace: Umbraco.Cms.Core.Services

Assembly: Umbraco.Core.dll

Syntax

public interface IBasicFileService<TEntity>
    where TEntity : IFile

Type Parameters

Name	Description
TEntity

Methods

GetAllAsync(String[])

Gets all by path, or all if no paths are specified.

Declaration

Task<IEnumerable<TEntity>> GetAllAsync(params string[] paths)

Parameters

Type	Name	Description
System.String[]	paths	Optional paths of to get.

Returns

Type	Description
Task<IEnumerable<TEntity>>	IEnumerable of

GetAsync(String)

Gets by path.

Declaration

Task<TEntity> GetAsync(string path)

Parameters

Type	Name	Description
System.String	path	The path to get from.

Returns

Type	Description
Task<TEntity>	, or null if not found

GetContentStreamAsync(String)

Get the content of a file as a stream.

Declaration

Task<Stream> GetContentStreamAsync(string path)

Parameters

Type	Name	Description
System.String	path	The path to the file.

Returns

Type	Description
Task<Stream>	A stream containing the contents of the file.

GetFileSizeAsync(String)

Declaration

Task<long> GetFileSizeAsync(string path)

Parameters

Type	Name	Description
System.String	path

Returns

Type	Description
Task<System.Int64>

SetContentStreamAsync(String, Stream)

Set the content of a file from a stream.

Declaration

Task SetContentStreamAsync(string path, Stream content)

Parameters

Type	Name	Description
System.String	path	The path to the file.
Stream	content	The desired content of the file as a stream.

Returns

Type	Description
Task