WebDavClient class

WebDavClient class.

Constructors

WebDavClient(Uri baseURL, {Client? httpClient, List<DynamiteAuthentication>? authentications, bool useCSRFClient = true})
Creates a new WebDavClient.
WebDavClient.fromClient(DynamiteClient client)
Creates a new WebDavClient from another client.

Properties

authentications List<DynamiteAuthentication>?
The available authentications for this client.
finalinherited
baseURL Uri
The base server url used to build the request uri.
finalinherited
hashCode int
The hash code for this object.
no setterinherited
httpClient → Client
The base http client.
finalinherited
runtimeType Type
A representation of the runtime type of the object.
no setterinherited

Methods

copy(PathUri sourcePath, PathUri destinationPath, {bool overwrite = false}) Future<StreamedResponse>
Copies the resource from sourcePath to destinationPath.
copy_Request(PathUri sourcePath, PathUri destinationPath, {bool overwrite = false}) → Request
Returns a request to copy the resource from sourcePath to destinationPath.
delete(PathUri path) Future<StreamedResponse>
Deletes the resource at path.
delete_Request(PathUri path) → Request
Returns a request to delete the resource at path.
get(PathUri path) Future<Uint8List>
Retrieves the content of the file at path.
get_Request(PathUri path) → Request
Returns a request to get the content of the file at path.
getFile(PathUri path, File file, {void onProgress(double progress)?}) Future<void>
Retrieves the content of the file at path.
getStream(PathUri path, {void onProgress(double progress)?}) Future<Stream<List<int>>>
Retrieves the content of the file at path.
mkcol(PathUri path, {WebDavProp? set}) Future<StreamedResponse>
Creates a collection at path.
mkcol_Request(PathUri path, {WebDavProp? set}) → Request
Returns a request to create a collection at path.
move(PathUri sourcePath, PathUri destinationPath, {bool overwrite = false}) Future<StreamedResponse>
Moves the resource from sourcePath to destinationPath.
move_Request(PathUri sourcePath, PathUri destinationPath, {bool overwrite = false}) → Request
Returns a request to move the resource from sourcePath to destinationPath.
noSuchMethod(Invocation invocation) → dynamic
Invoked when a nonexistent method or property is accessed.
inherited
options() Future<WebDavOptions>
Queries the WebDAV capabilities of the server.
options_Request() → Request
Returns a request to query the WebDAV capabilities of the server.
propfind(PathUri path, {WebDavPropWithoutValues? prop, WebDavDepth? depth}) Future<WebDavMultistatus>
Retrieves the prop for the resource at path.
propfind_Request(PathUri path, {WebDavPropWithoutValues? prop, WebDavDepth? depth}) → Request
Returns a request to retrieve the prop for the resource at path.
proppatch(PathUri path, {WebDavProp? set, WebDavPropWithoutValues? remove}) Future<bool>
Updates the props of the resource at path.
proppatch_Request(PathUri path, {WebDavProp? set, WebDavPropWithoutValues? remove}) → Request
Returns a request to update the props of the resource at path.
put(Uint8List localData, PathUri path, {DateTime? lastModified, DateTime? created, String? checksum}) Future<StreamedResponse>
Puts a new file at path with localData as content.
put_Request(Uint8List localData, PathUri path, {DateTime? lastModified, DateTime? created, String? checksum}) → Request
Returns a request to put a new file at path with localData as content.
putFile(File file, FileStat fileStat, PathUri path, {DateTime? lastModified, DateTime? created, String? checksum, void onProgress(double progress)?}) Future<StreamedResponse>
Puts a new file at path with file as content.
putFile_Request(File file, FileStat fileStat, PathUri path, {DateTime? lastModified, DateTime? created, String? checksum, void onProgress(double progress)?}) → StreamedRequest
Returns a request to put a new file at path with file as content.
putStream(Stream<List<int>> localData, PathUri path, {required int contentLength, DateTime? lastModified, DateTime? created, String? checksum, void onProgress(double progress)?}) Future<StreamedResponse>
Puts a new file at path with localData as content.
putStream_Request(Stream<List<int>> localData, PathUri path, {required int contentLength, DateTime? lastModified, DateTime? created, String? checksum, void onProgress(double progress)?}) → StreamedRequest
Returns a request to put a new file at path with localData as content.
report(PathUri path, WebDavOcFilterRules filterRules, {WebDavPropWithoutValues? prop}) Future<WebDavMultistatus>
Runs the filter-files report with the filterRules on the resource at path.
report_Request(PathUri path, WebDavOcFilterRules filterRules, {WebDavPropWithoutValues? prop}) → Request
Returns a request to run the filter-files report with the filterRules on the resource at path.
toString() String
A string representation of this object.
inherited

Operators

operator ==(Object other) bool
The equality operator.
inherited