WebDAV Client

https://pub.dev/packages/webdav_client
Admin
A Dart WebDAV client library with null-safety support that enables common WebDAV operations...
Tokens:1,954
Snippets:15
Trust Score:9.9
Update:8 months ago
Show doc for...
Tokens:
Raw
### Initialize WebDAV Client

Source: https://pub.dev/packages/webdav_client/index

Creates a new instance of the WebDAV client. Requires the base URL of the WebDAV server, and optionally accepts username, password, and a debug flag for verbose logging.

```dart
var client = newClient(
    'http://localhost:6688/',
    user: 'flyzero',
    password: '123456',
    debug: true,
  );
```

--------------------------------

### Create Folders

Source: https://pub.dev/packages/webdav_client/index

Creates a new folder on the WebDAV server. The `mkdir` function creates a single folder, while `mkdirAll` can create nested folders recursively.

```dart
await client.mkdir('/新建文件夹');

    // Recursively create folders
    await client.mkdirAll('/new folder/new folder2');
```

--------------------------------

### Initialize WebDAV Client and Read Directory in Flutter

Source: https://pub.dev/packages/webdav_client/example

This Dart code snippet demonstrates how to initialize a WebDAV client using the webdav_client package and then read the contents of a directory. It includes error handling for missing credentials and displays the directory contents in a Flutter ListView. Dependencies include 'flutter/material.dart' and 'webdav_client/webdav_client.dart'.

```dart
import 'package:flutter/material.dart';
import 'package:webdav_client/webdav_client.dart' as webdav;

void main() {
  runApp(const MyApp());
}

class MyApp extends StatelessWidget {
  const MyApp({Key? key}) : super(key: key);

  @override
  Widget build(BuildContext context) {
    return MaterialApp(
      title: 'Flutter Demo',
      theme: ThemeData(
        primarySwatch: Colors.blue,
      ),
      home: const MyHomePage(),
    );
  }
}

class MyHomePage extends StatefulWidget {
  const MyHomePage({Key? key}) : super(key: key);

  @override
  MyHomePageState createState() => MyHomePageState();
}

class MyHomePageState extends State<MyHomePage> {
  // webdav
  late webdav.Client client;

  // TODO need change your test url && user && pwd
  // if you use browser and received 'XMLHttpRequest error'  you need check cors!!!
  // https://stackoverflow.com/questions/65630743/how-to-solve-flutter-web-api-cors-error-only-with-dart-code
  final url = '';
  final user = '';
  final pwd = '';
  final dirPath = '/';

  @override
  void initState() {
    super.initState();

    // init client
    client = webdav.newClient(
      url,
      user: user,
      password: pwd,
      debug: true,
    );
  }

  @override
  Widget build(BuildContext context) {
    if (url.isEmpty || user.isEmpty || pwd.isEmpty) {
      return const Center(child: Text("you need add url || user || pwd"));
    }
    return Scaffold(
      body: FutureBuilder(
          future: _getData(),
          builder: (BuildContext context,
              AsyncSnapshot<List<webdav.File>> snapshot) {
            switch (snapshot.connectionState) {
              case ConnectionState.none:
              case ConnectionState.active:
              case ConnectionState.waiting:
                return const Center(child: CircularProgressIndicator());
              case ConnectionState.done:
                if (snapshot.hasError) {
                  return Center(child: Text('Error: ${snapshot.error}'));
                }
                return _buildListView(context, snapshot.data ?? []);
            }
          }),
    );
  }

  Future<List<webdav.File>> _getData() {
    return client.readDir(dirPath);
  }

  Widget _buildListView(BuildContext context, List<webdav.File> list) {
    return ListView.builder(
        itemCount: list.length,
        itemBuilder: (context, index) {
          final file = list[index];
          return ListTile(
            leading: Icon(
                file.isDir == true ? Icons.folder : Icons.file_present_rounded),
            title: Text(file.name ?? ''),
            subtitle: Text(file.mTime.toString()),
          );
        });
  }
}

```

--------------------------------

### Add webdav_client Dependency (Dart)

Source: https://pub.dev/packages/webdav_client/install

This command adds the webdav_client package as a dependency to your Dart project. It ensures that the package is downloaded and available for use in your project.

```bash
$ dart pub add webdav_client
```

--------------------------------

### Add webdav_client Dependency (Flutter)

Source: https://pub.dev/packages/webdav_client/install

This command adds the webdav_client package as a dependency to your Flutter project. It is similar to the Dart command but is specific to Flutter projects.

```bash
$ flutter pub add webdav_client
```

--------------------------------

### Configure WebDAV Client Settings

Source: https://pub.dev/packages/webdav_client/index

Allows setting common request headers, connection timeout, send timeout, and receive timeout for the WebDAV client. It also includes a method to ping the server to test connectivity.

```dart
// Set the public request headers
    client.setHeaders({'accept-charset': 'utf-8'});

    // Set the connection server timeout time in milliseconds.
    client.setConnectTimeout(8000);

    // Set send data timeout time in milliseconds.
    client.setSendTimeout(8000);

    // Set transfer data time in milliseconds.
    client.setReceiveTimeout(8000);

    // Test whether the service can connect
    try {
      await client.ping();
    } catch (e) {
      print('$e');
    }
```

--------------------------------

### Copy Files or Folders

Source: https://pub.dev/packages/webdav_client/index

Copies a file or folder from a source path to a destination path on the WebDAV server. Copying a folder recursively copies all its contents. Be aware that some services might delete the original contents of the destination folder.

```dart
// Copy all the contents of folderA to folder B
    await client.copy('/folder/folderA/', '/folder/folderB/', true);

    // Copy file
    await client.copy('/folder/aa.png', '/folder/bb.png', true);
```

--------------------------------

### Add webdav_client to pubspec.yaml

Source: https://pub.dev/packages/webdav_client/install

This snippet shows how the webdav_client dependency is added to your project's pubspec.yaml file. This is the standard way to manage dependencies in Dart and Flutter projects.

```yaml
dependencies:
  webdav_client: ^1.2.2
```

--------------------------------

### Download Files

Source: https://pub.dev/packages/webdav_client/index

Downloads a file from the WebDAV server. It supports downloading the file content as bytes with progress updates, or directly to a local file using streams, also with progress callbacks.

```dart
// download bytes
    await client.read('/folder/folder/openvpn.exe', onProgress: (c, t) {
        print(c / t);
      });

    // download 2 local file with stream 
    await client.read2File(
          '/folder/vpn.exe', 'C:/Users/xxx/vpn2.exe', onProgress: (c, t) {
        print(c / t);
      });
```

--------------------------------

### Read Directory Contents

Source: https://pub.dev/packages/webdav_client/index

Retrieves a list of files and subfolders within a specified directory on the WebDAV server. The function returns a list of `File` objects, each containing the name and path of the item.

```dart
var list = await client.readDir('/');
    list.forEach((f) {
        print('${f.name} ${f.path}');
      });

    // can sub folder
    var list2 = await client.readDir('/sub/sub/folder');
    list2.forEach((f) {
        print('${f.name} ${f.path}');
      });
```

--------------------------------

### Import webdav_client in Dart Code

Source: https://pub.dev/packages/webdav_client/install

This import statement allows you to use the functionalities provided by the webdav_client package in your Dart code. Ensure this line is at the top of your Dart file.

```dart
import 'package:webdav_client/webdav_client.dart';
```

--------------------------------

### Upload Files

Source: https://pub.dev/packages/webdav_client/index

Uploads a local file to the WebDAV server. This method streams the file content to the remote destination and provides progress updates. It also supports cancellation via a `CancelToken`.

```dart
// upload local file 2 remote file with stream
    CancelToken c = CancelToken();
    await client.writeFromFile(
        'C:/Users/xxx/vpn.exe', '/f/vpn2.exe', onProgress: (c, t) {
        print(c / t);
      }, cancelToken: c);
```

--------------------------------

### Cancel WebDAV Requests

Source: https://pub.dev/packages/webdav_client/index

Allows for cancelling ongoing WebDAV operations, such as creating directories, uploading, or downloading files. A `CancelToken` instance is used to manage and trigger the cancellation.

```dart
CancelToken cancel = CancelToken();

    // Supports most methods
    client.mkdir('/新建文件夹', cancel)
    .catchError((err) {
      prints(err.toString());
    });

    // in other
    cancel.cancel('reason')
```

--------------------------------

### Rename Folders or Files

Source: https://pub.dev/packages/webdav_client/index

Renames a folder or file on the WebDAV server. Similar to removal, renaming folders might require a trailing slash. The `true` parameter indicates a recursive rename if applicable.

```dart
// Rename folder
    await client.rename('/新建文件夹/', '/新建文件夹2/', true);

    // Rename file
    await client.rename('/新建文件夹2/test.dart', '/新建文件夹2/test2.dart', true);
```

--------------------------------

### Remove Folders or Files

Source: https://pub.dev/packages/webdav_client/index

Deletes a specified folder or file from the WebDAV server. Note that for folders, some WebDAV services may require a trailing slash ('/') in the path.

```dart
// Delete folder
    await client.remove('/new folder/new folder2/');

    // Delete file
    await client.remove('/new folder/新建文本文档.txt');
```
Tokens:
Raw