Interface IWebDavClass1

Interface for WebDAV class 1 support

Inherited Members
Namespace:FubarDev.WebDavServer.Dispatchers
Assembly:FubarDev.WebDavServer.dll
Syntax
public interface IWebDavClass1 : IWebDavClass

Methods

| Improve this Doc View Source

CopyAsync(String, Uri, CancellationToken)

Copies from the source to the destination

Declaration
[NotNull]
[ItemNotNull]
Task<IWebDavResult> CopyAsync([NotNull] string path, [NotNull] Uri destination, CancellationToken cancellationToken)
Parameters
Type Name Description
String path

The source to copy
Uri destination

The destination to copy to
CancellationToken cancellationToken

The cancellation token
Returns
Type Description
Task<IWebDavResult>

The result of the operation
| Improve this Doc View Source

DeleteAsync(String, CancellationToken)

Deletes the element at the given path

Declaration
[NotNull]
[ItemNotNull]
Task<IWebDavResult> DeleteAsync([NotNull] string path, CancellationToken cancellationToken)
Parameters
Type Name Description
String path

The path to the element to delete
CancellationToken cancellationToken

The cancellcation token
Returns
Type Description
Task<IWebDavResult>

The result of the operation
| Improve this Doc View Source

GetAsync(String, CancellationToken)

Gets the element at the given path

Declaration
[NotNull]
[ItemNotNull]
Task<IWebDavResult> GetAsync([NotNull] string path, CancellationToken cancellationToken)
Parameters
Type Name Description
String path

The path to the element to get
CancellationToken cancellationToken

The cancellcation token
Returns
Type Description
Task<IWebDavResult>

The result of the operation
| Improve this Doc View Source

HeadAsync(String, CancellationToken)

Gets the information about an element at the given path

Declaration
[NotNull]
[ItemNotNull]
Task<IWebDavResult> HeadAsync([NotNull] string path, CancellationToken cancellationToken)
Parameters
Type Name Description
String path

The path to the element to get the information for
CancellationToken cancellationToken

The cancellcation token
Returns
Type Description
Task<IWebDavResult>

The result of the operation
| Improve this Doc View Source

MkColAsync(String, CancellationToken)

Creates a collection at the given path

Declaration
[NotNull]
[ItemNotNull]
Task<IWebDavResult> MkColAsync([NotNull] string path, CancellationToken cancellationToken)
Parameters
Type Name Description
String path

The path to the collection to create
CancellationToken cancellationToken

The cancellcation token
Returns
Type Description
Task<IWebDavResult>

The result of the operation
| Improve this Doc View Source

MoveAsync(String, Uri, CancellationToken)

Moves from the source to the destination

Declaration
[NotNull]
[ItemNotNull]
Task<IWebDavResult> MoveAsync([NotNull] string path, [NotNull] Uri destination, CancellationToken cancellationToken)
Parameters
Type Name Description
String path

The source to move
Uri destination

The destination to move to
CancellationToken cancellationToken

The cancellation token
Returns
Type Description
Task<IWebDavResult>

The result of the operation
| Improve this Doc View Source

OptionsAsync(String, CancellationToken)

Queries the options for a given path.

Declaration
[NotNull]
[ItemNotNull]
Task<IWebDavResult> OptionsAsync([NotNull] string path, CancellationToken cancellationToken)
Parameters
Type Name Description
String path

The root-relataive file system path to query the options for
CancellationToken cancellationToken

The cancellcation token
Returns
Type Description
Task<IWebDavResult>

The result of the operation
Remarks

This is used to identify the WebDAV capabilities at a given URL.

| Improve this Doc View Source

PropFindAsync(String, propfind, CancellationToken)

Queries properties (dead or live) for a given path.

Declaration
[NotNull]
[ItemNotNull]
Task<IWebDavResult> PropFindAsync([NotNull] string path, [CanBeNull] propfind request, CancellationToken cancellationToken)
Parameters
Type Name Description
String path

The path to query the properties for
propfind request

Some information about the properties to query
CancellationToken cancellationToken

The cancellcation token
Returns
Type Description
Task<IWebDavResult>

The result of the operation
| Improve this Doc View Source

PropPatchAsync(String, propertyupdate, CancellationToken)

Patches (sets or removes) properties from the given path

Declaration
[NotNull]
[ItemNotNull]
Task<IWebDavResult> PropPatchAsync([NotNull] string path, [NotNull] propertyupdate request, CancellationToken cancellationToken)
Parameters
Type Name Description
String path

The path to patch the properties for
propertyupdate request

The properties to patch
CancellationToken cancellationToken

The cancellcation token
Returns
Type Description
Task<IWebDavResult>

The result of the operation
| Improve this Doc View Source

PutAsync(String, Stream, CancellationToken)

Creates or updates a document at the given path

Declaration
[NotNull]
[ItemNotNull]
Task<IWebDavResult> PutAsync([NotNull] string path, [NotNull] Stream data, CancellationToken cancellationToken)
Parameters
Type Name Description
String path

The path where to create or update the document
Stream data

The data to write to the new or existing document
CancellationToken cancellationToken

The cancellcation token
Returns
Type Description
Task<IWebDavResult>

The result of the operation