IFolder Interface Reference

A ResourceType based folder interface. More...

Inheritance diagram for IFolder:

Public Member Functions
Task	CreateAsync (CancellationToken cancellationToken)
	Asynchronously creates folder. More...
Task	MoveAsync (IFolder destinationFolder, CancellationToken cancellationToken)
	Asynchronously moves folder. More...
Task	MoveAsync (IFolder destinationFolder, Action< int, int > progressAction, CancellationToken cancellationToken)
Task	DeleteAsync (CancellationToken cancellationToken)
	Asynchronously deletes folder. More...
Task	DeleteAsync (Action< int, int > progressAction, CancellationToken cancellationToken)
Task< bool >	ExistsAsync (CancellationToken cancellationToken)
	Asynchronously checks if folder exists. More...
Task< IReadOnlyCollection< INode > >	ListAsync (CancellationToken cancellationToken)
	Asynchronously lists folder contents. More...
Task< IReadOnlyCollection< IFolder > >	ListFoldersAsync (CancellationToken cancellationToken)
	Asynchronously lists folder contents. More...
Task< IReadOnlyCollection< IFile > >	ListFilesAsync (CancellationToken cancellationToken)
	Asynchronously lists folder contents. More...
Task< FolderInfo >	GetFolderInfoAsync (CancellationToken cancellationToken)
	Asynchronously gets folder information structure. More...
Task< bool >	HasSubfoldersAsync (IAclRepository aclRepository, IReadOnlyCollection< string > userRoles, CancellationToken cancellationToken)
	Asynchronously determines whether the folder has any subfolders. More...
Task< string >	GetUrlAsync (CancellationToken cancellationToken)
	Asynchronously gets folder url. More...
bool	IsHidden ()
	Checks if folder is hidden on the ResourceType. More...

Properties
string	Name [get]
	Gets the folder name. More...
string	Path [get]
	Gets ResourceType relative path to the folder. More...
string	FullPath [get]
	Gets the absolute path to the folder. More...
ResourceType	ResourceType [get]
	Gets the ResourceType. More...
IFolder	ParentFolder [get]
	Gets parent folder instance. More...

Detailed Description

A ResourceType based folder interface.

Member Function Documentation

CreateAsync()

Task CreateAsync

(

CancellationToken

cancellationToken

)

Asynchronously creates folder.

Parameters

cancellationToken

A cancellation token.

DeleteAsync()

Task DeleteAsync

(

CancellationToken

cancellationToken

)

Asynchronously deletes folder.

This method will delete all folder's contents.

Parameters

cancellationToken

A cancellation token.

ExistsAsync()

Task<bool> ExistsAsync

(

CancellationToken

cancellationToken

)

Asynchronously checks if folder exists.

Parameters

cancellationToken

A cancellation token.

Returns

True if folder exists, false otherwise.

GetFolderInfoAsync()

Task<FolderInfo> GetFolderInfoAsync

(

CancellationToken

cancellationToken

)

Asynchronously gets folder information structure.

Parameters

cancellationToken

A cancellation token.

Returns

A folder information structure.

GetUrlAsync()

Task<string> GetUrlAsync

(

CancellationToken

cancellationToken

)

Asynchronously gets folder url.

If a file system should generate Proxy commands, a folder url should be retreived with help of IProxyUrlGenerator.

Parameters

cancellationToken

A cancellation token.

Returns

A folder url.

HasSubfoldersAsync()

Task<bool> HasSubfoldersAsync	(	IAclRepository	aclRepository,
		IReadOnlyCollection< string >	userRoles,
		CancellationToken	cancellationToken
	)

Asynchronously determines whether the folder has any subfolders.

Parameters

aclRepository	A ACL repository.
userRoles	A collection of user roles.
cancellationToken	A cancellation token.

Returns

True if folder has subfolder, false otherwise.

IsHidden()

bool IsHidden

(

)

Checks if folder is hidden on the ResourceType.

Returns

True if folder is hidden, false otherwise.

ListAsync()

Task<IReadOnlyCollection<INode> > ListAsync

(

CancellationToken

cancellationToken

)

Asynchronously lists folder contents.

Parameters

cancellationToken

Returns

A collection of folder Nodes.

ListFilesAsync()

Task<IReadOnlyCollection<IFile> > ListFilesAsync

(

CancellationToken

cancellationToken

)

Asynchronously lists folder contents.

Parameters

cancellationToken

Returns

A collection of files.

ListFoldersAsync()

Task<IReadOnlyCollection<IFolder> > ListFoldersAsync

(

CancellationToken

cancellationToken

)

Asynchronously lists folder contents.

Parameters

cancellationToken

Returns

A collection of subfolders.

MoveAsync()

Task MoveAsync	(	IFolder	destinationFolder,
		CancellationToken	cancellationToken
	)

Asynchronously moves folder.

Folders can't be moved across resources.

If destinationFolder ResourceType is different than this folder ResourceType a NotSupportedException will be thrown.

A root folder (a one which Path is /) can't be moved.

Parameters

destinationFolder	A destination folder.
cancellationToken	A cancellation token.

Property Documentation

FullPath

string FullPath

get

Gets the absolute path to the folder.

Name

string Name

get

Gets the folder name.

ParentFolder

IFolder ParentFolder

get

Gets parent folder instance.

May be null if this is the root folder.

Path

string Path

get

Gets ResourceType relative path to the folder.

ResourceType

ResourceType ResourceType

get

Gets the ResourceType.

---

The documentation for this interface was generated from the following file:

• IFolder.cs