Interface IRemoteTargetActions

The interface defining the remote target actions

Inherited Members
Namespace:FubarDev.WebDavServer.Engines.Remote
Assembly:FubarDev.WebDavServer.dll
Syntax
public interface IRemoteTargetActions : ITargetActions<RemoteCollectionTarget, RemoteDocumentTarget, RemoteMissingTarget>, IDisposable

Methods

| Improve this Doc View Source

CreateCollectionAsync(RemoteCollectionTarget, String, CancellationToken)

Create a remote collection

Declaration
[NotNull]
[ItemNotNull]
Task<RemoteCollectionTarget> CreateCollectionAsync([NotNull] RemoteCollectionTarget targetCollection, [NotNull] string name, CancellationToken cancellationToken)
Parameters
Type Name Description
RemoteCollectionTarget targetCollection

The parent collection target
String name

The name of the new collection
CancellationToken cancellationToken

The cancellation token
Returns
Type Description
Task<RemoteCollectionTarget>

The newly created remote collection target
| Improve this Doc View Source

DeleteAsync(RemoteCollectionTarget, CancellationToken)

Delete the remote collection target

Declaration
[NotNull]
Task DeleteAsync([NotNull] RemoteCollectionTarget target, CancellationToken cancellationToken)
Parameters
Type Name Description
RemoteCollectionTarget target

The remote collection target
CancellationToken cancellationToken

The cancellation token
Returns
Type Description
Task

The async task
| Improve this Doc View Source

DeleteAsync(RemoteDocumentTarget, CancellationToken)

Delete the remote document target

Declaration
[NotNull]
Task DeleteAsync([NotNull] RemoteDocumentTarget target, CancellationToken cancellationToken)
Parameters
Type Name Description
RemoteDocumentTarget target

The remote document target
CancellationToken cancellationToken

The cancellation token
Returns
Type Description
Task

The async task
| Improve this Doc View Source

GetAsync(RemoteCollectionTarget, String, CancellationToken)

Gets the child of a remote collection target

Declaration
[NotNull]
[ItemNotNull]
Task<ITarget> GetAsync([NotNull] RemoteCollectionTarget collection, [NotNull] string name, CancellationToken cancellationToken)
Parameters
Type Name Description
RemoteCollectionTarget collection

The remote collection target to get the child target for
String name

The name of the child target
CancellationToken cancellationToken

The cancellation token
Returns
Type Description
Task<ITarget>

The found child target (or remote missing target)
| Improve this Doc View Source

SetPropertiesAsync(RemoteCollectionTarget, IEnumerable<IUntypedWriteableProperty>, CancellationToken)

Sets the properties on a remote target

Declaration
[NotNull]
[ItemNotNull]
Task<IReadOnlyCollection<XName>> SetPropertiesAsync([NotNull] RemoteCollectionTarget target, [NotNull, ItemNotNull] IEnumerable<IUntypedWriteableProperty> properties, CancellationToken cancellationToken)
Parameters
Type Name Description
RemoteCollectionTarget target

The remote collection target
IEnumerable<IUntypedWriteableProperty> properties

The properties to set on the target
CancellationToken cancellationToken

The cancellation token
Returns
Type Description
Task<IReadOnlyCollection<XName>>

The list of property names that couldn't be set
| Improve this Doc View Source

SetPropertiesAsync(RemoteDocumentTarget, IEnumerable<IUntypedWriteableProperty>, CancellationToken)

Sets the properties on a remote target

Declaration
[NotNull]
[ItemNotNull]
Task<IReadOnlyCollection<XName>> SetPropertiesAsync([NotNull] RemoteDocumentTarget target, [NotNull, ItemNotNull] IEnumerable<IUntypedWriteableProperty> properties, CancellationToken cancellationToken)
Parameters
Type Name Description
RemoteDocumentTarget target

The remote document target
IEnumerable<IUntypedWriteableProperty> properties

The properties to set on the target
CancellationToken cancellationToken

The cancellation token
Returns
Type Description
Task<IReadOnlyCollection<XName>>

The list of property names that couldn't be set