nextcloud 6.1.0

A Nextcloud API client written in Dart supporting all maintained Nextcloud server versions.

nextcloud

A Nextcloud API client written in Dart.

Usage

Authentication

There are multiple ways to authenticate.
First there is HTTP Basic auth which works with the normal user credentials (e-mail and other identifiers also work):

final client = NextcloudClient(
    Uri.parse('http://localhost'),
    loginName: 'admin',
    password: 'admin',
);

Secondly there is Http Bearer auth which works with app passwords:

final client = NextcloudClient(
    Uri.parse('http://localhost'),
    loginName: 'admin',
    appPassword: 'xxxxx-xxxxx-xxxxx-xxxx-xxxxx',
);

Not all endpoints work with just HTTP Basic auth, so it is advised to use app passwords obtained either directly in the Web UI by the user or using the login flow.
Some endpoints do not need any authentication at all or provide extended information when the request is optionally authenticated.

Endpoints

It is not guaranteed that an API request will work unless the app is installed and enabled on the server (and has a supported version).

To get an easier overview of the available endpoints you can browse the server OpenAPI documentation, but be aware that the package might not be in sync with it.
Alternatively you can also go to https://pub.dev/documentation/nextcloud/latest.

The endpoints are grouped by app and most apps also group their endpoints again. They can be accessed using getters on the NextcloudClient.

For an example checkout the example.

Development

Except for WebDAV all client code is generated using OpenAPI specifications which can be found in the lib/src/api/ folder.
These OpenAPI specifications are generated from the PHP source code.

Compatibility/Support policy

Component	Supported versions (1)
Server (2)	27 - 29
News app	22 - 25
Notes app	4.7 - 4.10
Notifications app	27 - 29
Talk app	17 - 19
NextPush app	1.4
User account deletion app	2.3 - 2.5

1: Other versions might be supported too or at least mostly working, but we do not test against those.
2: Server includes the following apps: comments, core, dashboard, dav, files, files_external, files_reminders, files_sharing, files_trashbin, files_versions, provisioning_api, settings, sharebymail, systemtags, theming, updatenotification, user_ldap, user_status, weather_status and WebDAV.

We aim to support all currently maintained server versions and all app versions that support those server versions. The currently maintained server versions can be found here: https://github.com/nextcloud/server/wiki/Maintenance-and-Release-Schedule Once a server version becomes EOL the support for it will be removed.

To ensure this package is compatible with the supported server versions we run API unit tests. Since we do not cover all endpoints we can not claim compatibility for endpoints we do not test against. Even if there are unit tests for an endpoint we can not guarantee that it will work fine in every scenario.

Please report any compatibility problems (if you are using a compatible server version) and feel free to add unit tests for endpoints you depend on. This will increase our test coverage and enables everyone to work more confidently with the endpoints.