Skip to content

dracoon/dracoon-csharp-sdk

Repository files navigation

Build Status GitHub license NuGet NuGet downloads GitHub issues

DRACOON C# SDK

A library to access the DRACOON REST API.

Setup

Minimum Requirements

.NET Standard 2.0 API version: 5.0.0

Download

NuGet

In nuget, you can find the DRACOON SDK here.

If you are using NuGet with package management "Packages.config", then edit your project's "packages.config" and add this to the packages section:

<package id="Dracoon.Sdk" version="5.2.0" />

If you are using Visual Studio 2017 (or higher) and you are using NuGet with package management "PackageReference" then edit your .csproj file and add this to the package dependency group:

<PackageReference Include="Dracoon.Sdk" Version="5.2.0" />

Example

A full example of the SDK usage can be found here.
A full example of the OAuth usage can be found here.

The following example shows how simple the SDK can be used. It shows how to get all root rooms.

DracoonAuth auth = new DracoonAuth("access-token");

DracoonClient client = new DracoonClient(new Uri("https://dracoon.team"), auth);

NodeList resultList = client.Nodes.GetNodes();
foreach (Node currentNode in resultList.Items) {
	Console.WriteLine("NodeId: " + currentNode.Id + "; NodeName: " + currentNode.Name);
}

Documentation

Documentation of all public classes and methods are provided through the standard <summary></summary> xml tags. The easiest way to view these is through Visual Studio's built in "Object Browser" (VIEW -> Object Browser, or CTRL+W, J).

Contribution

If you would like to contribute code, fork the repository and send a pull request. We don't use the GitHub Flow, so please create a feature branch of the main branch and make your changes there.

Copyright and License

Copyright ©2021 Dracoon GmbH. All rights reserved.

Licensed under the Apache License, verison 2.0 (the "License"); you may not use this file except in compliance with the License. You may optain a copy of the License at

http://www.apache.org/licenses/LICENSE-2.0

Unless required by applicable law or agreed to in writing, software distributed under the License is distributed on an "AS IS" BASIS, WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. See the License for the specific language governing permissions and limitations under the License.