Client class

WebDav Client

Constructors

Client({required String uri, required WdDio c, required Auth auth, bool debug = false})

Properties

auth Auth
Auth Mode (noAuth/basic/digest)
getter/setter pair
c WdDio
Wrapped http client
getter/setter pair
debug bool
debug
getter/setter pair
hashCode int
The hash code for this object.
no setterinherited
runtimeType Type
A representation of the runtime type of the object.
no setterinherited
uri String
WebDAV url
final

Methods

copy(String oldPath, String newPath, bool overwrite, [CancelToken? cancelToken]) Future<void>
Copy a file / folder from A to B If copied the folder (A > B), it will copy all the contents of folder A to folder B. Some webdav services have been tested and found to delete the original contents of the B folder!!!
mkdir(String path, [CancelToken? cancelToken]) Future<void>
Create a folder
mkdirAll(String path, [CancelToken? cancelToken]) Future<void>
Recursively create folders
noSuchMethod(Invocation invocation) → dynamic
Invoked when a nonexistent method or property is accessed.
inherited
ping([CancelToken? cancelToken]) Future<void>
Test whether the service can connect
read(String path, {void onProgress(int count, int total)?, CancelToken? cancelToken}) Future<List<int>>
Read the bytes of a file It is best not to open debug mode, otherwise the byte data is too large and the output results in IDE cards, 😄
read2File(String path, String savePath, {void onProgress(int count, int total)?, CancelToken? cancelToken}) Future<void>
Read the bytes of a file with stream and write to a local file
readDir(String path, [CancelToken? cancelToken]) Future<List<File>>
Read all files in a folder
readProps(String path, [CancelToken? cancelToken]) Future<File>
Read a single files properties
remove(String path, [CancelToken? cancelToken]) Future<void>
Remove a folder or file If you remove the folder, some webdav services require a '/' at the end of the path.
removeAll(String path, [CancelToken? cancelToken]) Future<void>
Remove files
rename(String oldPath, String newPath, bool overwrite, [CancelToken? cancelToken]) Future<void>
Rename a folder or file If you rename the folder, some webdav services require a '/' at the end of the path.
setConnectTimeout(int timeout) → void
Set the connection server timeout time in milliseconds.
setHeaders(Map<String, dynamic> headers) → void
Set the public request headers
setReceiveTimeout(int timeout) → void
Set transfer data time in milliseconds.
setSendTimeout(int timeout) → void
Set send data timeout time in milliseconds.
toString() String
A string representation of this object.
inherited
write(String path, Uint8List data, {void onProgress(int count, int total)?, CancelToken? cancelToken}) Future<void>
Write the bytes to remote path
writeFromFile(String localFilePath, String path, {void onProgress(int count, int total)?, CancelToken? cancelToken}) Future<void>
Read local file stream and write to remote file

Operators

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