Skip to content
Merged
Show file tree
Hide file tree
Changes from all commits
Commits
File filter

Filter by extension

Filter by extension


Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
27 changes: 16 additions & 11 deletions README.md
Original file line number Diff line number Diff line change
@@ -1,7 +1,7 @@
# Appwrite .NET SDK

![License](https://img.shields.io/github/license/appwrite/sdk-for-dotnet.svg?style=flat-square)
![Version](https://img.shields.io/badge/api%20version-1.3.2-blue.svg?style=flat-square)
![Version](https://img.shields.io/badge/api%20version-1.3.7-blue.svg?style=flat-square)
[![Build Status](https://img.shields.io/travis/com/appwrite/sdk-generator?style=flat-square)](https://travis-ci.com/appwrite/sdk-generator)
[![Twitter Account](https://img.shields.io/twitter/follow/appwrite?color=00acee&label=twitter&style=flat-square)](https://twitter.com/appwrite)
[![Discord](https://img.shields.io/discord/564160730845151244?label=discord&style=flat-square)](https://appwrite.io/discord)
Expand All @@ -17,17 +17,17 @@ Appwrite is an open-source backend as a service server that abstract and simplif
Add this reference to your project's `.csproj` file:

```xml
<PackageReference Include="Appwrite" Version="0.4.1" />
<PackageReference Include="Appwrite" Version="0.4.2" />
```

You can install packages from the command line:

```powershell
# Package Manager
Install-Package Appwrite -Version 0.4.1
Install-Package Appwrite -Version 0.4.2

# or .NET CLI
dotnet add package Appwrite --version 0.4.1
dotnet add package Appwrite --version 0.4.2
```


Expand All @@ -39,12 +39,13 @@ Once you have installed the package, it is extremely easy to get started with th

```csharp
using Appwrite;
using Appwrite.Services;
using Appwrite.Models;

var client = new Client()
.SetEndpoint("http://cloud.appwrite.io/v1") // Make sure your endpoint is accessible
.SetEndpoint("http://cloud.appwrite.io/v1")
.SetProject("5ff3379a01d25") // Your project ID
.SetKey("cd868db89") // Your secret API key
.SetSelfSigned(); // Use only on dev mode with a self-signed SSL cert
.SetKey("cd868db89"); // Your secret API key

var users = new Users(client);

Expand All @@ -58,18 +59,21 @@ Console.WriteLine(user.ToMap());
```

### Error Handling
The Appwrite .NET SDK raises an `AppwriteException` object with `message`, `code` and `response` properties. You can handle any errors by catching `AppwriteException` and present the `message` to the user or handle it yourself based on the provided error information. Below is an example.
The Appwrite .NET SDK raises an `AppwriteException` object with `message`, `code`, and `response` properties. You can handle any errors by catching `AppwriteException` and presenting the `message` to the user or handling it yourself based on the provided error information. Below is an example.

```csharp
var users = new Users(client);

try {
try
{
var user = await users.Create(
userId: ID.Unique(),
email: "email@example.com",
password: "password",
name: "name");
} catch (AppwriteException e) {
}
catch (AppwriteException e)
{
Console.WriteLine(e.Message);
}
```
Expand All @@ -79,7 +83,8 @@ You can use the following resources to learn more and get help
- 🚀 [Getting Started Tutorial](https://appwrite.io/docs/getting-started-for-server)
- 📜 [Appwrite Docs](https://appwrite.io/docs)
- 💬 [Discord Community](https://appwrite.io/discord)
- 🚂 [Appwrite Dart Playground](https://github.com/appwrite/playground-for-dotnet)
- 🚂 [Appwrite .NET Playground](https://github.com/appwrite/playground-for-dotnet)


## Contribution

Expand Down
1 change: 1 addition & 0 deletions docs/examples/account/create-phone-verification.md
Original file line number Diff line number Diff line change
@@ -1,4 +1,5 @@
using Appwrite;
using Appwrite.Services;
using Appwrite.Models;

var client = new Client()
Expand Down
1 change: 1 addition & 0 deletions docs/examples/account/create-recovery.md
Original file line number Diff line number Diff line change
@@ -1,4 +1,5 @@
using Appwrite;
using Appwrite.Services;
using Appwrite.Models;

var client = new Client()
Expand Down
1 change: 1 addition & 0 deletions docs/examples/account/create-verification.md
Original file line number Diff line number Diff line change
@@ -1,4 +1,5 @@
using Appwrite;
using Appwrite.Services;
using Appwrite.Models;

var client = new Client()
Expand Down
1 change: 1 addition & 0 deletions docs/examples/account/delete-session.md
Original file line number Diff line number Diff line change
@@ -1,4 +1,5 @@
using Appwrite;
using Appwrite.Services;
using Appwrite.Models;

var client = new Client()
Expand Down
1 change: 1 addition & 0 deletions docs/examples/account/delete-sessions.md
Original file line number Diff line number Diff line change
@@ -1,4 +1,5 @@
using Appwrite;
using Appwrite.Services;
using Appwrite.Models;

var client = new Client()
Expand Down
1 change: 1 addition & 0 deletions docs/examples/account/get-prefs.md
Original file line number Diff line number Diff line change
@@ -1,4 +1,5 @@
using Appwrite;
using Appwrite.Services;
using Appwrite.Models;

var client = new Client()
Expand Down
1 change: 1 addition & 0 deletions docs/examples/account/get-session.md
Original file line number Diff line number Diff line change
@@ -1,4 +1,5 @@
using Appwrite;
using Appwrite.Services;
using Appwrite.Models;

var client = new Client()
Expand Down
1 change: 1 addition & 0 deletions docs/examples/account/get.md
Original file line number Diff line number Diff line change
@@ -1,4 +1,5 @@
using Appwrite;
using Appwrite.Services;
using Appwrite.Models;

var client = new Client()
Expand Down
1 change: 1 addition & 0 deletions docs/examples/account/list-logs.md
Original file line number Diff line number Diff line change
@@ -1,4 +1,5 @@
using Appwrite;
using Appwrite.Services;
using Appwrite.Models;

var client = new Client()
Expand Down
1 change: 1 addition & 0 deletions docs/examples/account/list-sessions.md
Original file line number Diff line number Diff line change
@@ -1,4 +1,5 @@
using Appwrite;
using Appwrite.Services;
using Appwrite.Models;

var client = new Client()
Expand Down
1 change: 1 addition & 0 deletions docs/examples/account/update-email.md
Original file line number Diff line number Diff line change
@@ -1,4 +1,5 @@
using Appwrite;
using Appwrite.Services;
using Appwrite.Models;

var client = new Client()
Expand Down
1 change: 1 addition & 0 deletions docs/examples/account/update-name.md
Original file line number Diff line number Diff line change
@@ -1,4 +1,5 @@
using Appwrite;
using Appwrite.Services;
using Appwrite.Models;

var client = new Client()
Expand Down
1 change: 1 addition & 0 deletions docs/examples/account/update-password.md
Original file line number Diff line number Diff line change
@@ -1,4 +1,5 @@
using Appwrite;
using Appwrite.Services;
using Appwrite.Models;

var client = new Client()
Expand Down
1 change: 1 addition & 0 deletions docs/examples/account/update-phone-verification.md
Original file line number Diff line number Diff line change
@@ -1,4 +1,5 @@
using Appwrite;
using Appwrite.Services;
using Appwrite.Models;

var client = new Client()
Expand Down
1 change: 1 addition & 0 deletions docs/examples/account/update-phone.md
Original file line number Diff line number Diff line change
@@ -1,4 +1,5 @@
using Appwrite;
using Appwrite.Services;
using Appwrite.Models;

var client = new Client()
Expand Down
1 change: 1 addition & 0 deletions docs/examples/account/update-prefs.md
Original file line number Diff line number Diff line change
@@ -1,4 +1,5 @@
using Appwrite;
using Appwrite.Services;
using Appwrite.Models;

var client = new Client()
Expand Down
1 change: 1 addition & 0 deletions docs/examples/account/update-recovery.md
Original file line number Diff line number Diff line change
@@ -1,4 +1,5 @@
using Appwrite;
using Appwrite.Services;
using Appwrite.Models;

var client = new Client()
Expand Down
1 change: 1 addition & 0 deletions docs/examples/account/update-session.md
Original file line number Diff line number Diff line change
@@ -1,4 +1,5 @@
using Appwrite;
using Appwrite.Services;
using Appwrite.Models;

var client = new Client()
Expand Down
1 change: 1 addition & 0 deletions docs/examples/account/update-status.md
Original file line number Diff line number Diff line change
@@ -1,4 +1,5 @@
using Appwrite;
using Appwrite.Services;
using Appwrite.Models;

var client = new Client()
Expand Down
1 change: 1 addition & 0 deletions docs/examples/account/update-verification.md
Original file line number Diff line number Diff line change
@@ -1,4 +1,5 @@
using Appwrite;
using Appwrite.Services;
using Appwrite.Models;

var client = new Client()
Expand Down
1 change: 1 addition & 0 deletions docs/examples/avatars/get-browser.md
Original file line number Diff line number Diff line change
@@ -1,4 +1,5 @@
using Appwrite;
using Appwrite.Services;
using Appwrite.Models;

var client = new Client()
Expand Down
1 change: 1 addition & 0 deletions docs/examples/avatars/get-credit-card.md
Original file line number Diff line number Diff line change
@@ -1,4 +1,5 @@
using Appwrite;
using Appwrite.Services;
using Appwrite.Models;

var client = new Client()
Expand Down
1 change: 1 addition & 0 deletions docs/examples/avatars/get-favicon.md
Original file line number Diff line number Diff line change
@@ -1,4 +1,5 @@
using Appwrite;
using Appwrite.Services;
using Appwrite.Models;

var client = new Client()
Expand Down
1 change: 1 addition & 0 deletions docs/examples/avatars/get-flag.md
Original file line number Diff line number Diff line change
@@ -1,4 +1,5 @@
using Appwrite;
using Appwrite.Services;
using Appwrite.Models;

var client = new Client()
Expand Down
1 change: 1 addition & 0 deletions docs/examples/avatars/get-image.md
Original file line number Diff line number Diff line change
@@ -1,4 +1,5 @@
using Appwrite;
using Appwrite.Services;
using Appwrite.Models;

var client = new Client()
Expand Down
1 change: 1 addition & 0 deletions docs/examples/avatars/get-initials.md
Original file line number Diff line number Diff line change
@@ -1,4 +1,5 @@
using Appwrite;
using Appwrite.Services;
using Appwrite.Models;

var client = new Client()
Expand Down
1 change: 1 addition & 0 deletions docs/examples/avatars/get-q-r.md
Original file line number Diff line number Diff line change
@@ -1,4 +1,5 @@
using Appwrite;
using Appwrite.Services;
using Appwrite.Models;

var client = new Client()
Expand Down
1 change: 1 addition & 0 deletions docs/examples/databases/create-boolean-attribute.md
Original file line number Diff line number Diff line change
@@ -1,4 +1,5 @@
using Appwrite;
using Appwrite.Services;
using Appwrite.Models;

var client = new Client()
Expand Down
1 change: 1 addition & 0 deletions docs/examples/databases/create-collection.md
Original file line number Diff line number Diff line change
@@ -1,4 +1,5 @@
using Appwrite;
using Appwrite.Services;
using Appwrite.Models;

var client = new Client()
Expand Down
1 change: 1 addition & 0 deletions docs/examples/databases/create-datetime-attribute.md
Original file line number Diff line number Diff line change
@@ -1,4 +1,5 @@
using Appwrite;
using Appwrite.Services;
using Appwrite.Models;

var client = new Client()
Expand Down
1 change: 1 addition & 0 deletions docs/examples/databases/create-document.md
Original file line number Diff line number Diff line change
@@ -1,4 +1,5 @@
using Appwrite;
using Appwrite.Services;
using Appwrite.Models;

var client = new Client()
Expand Down
1 change: 1 addition & 0 deletions docs/examples/databases/create-email-attribute.md
Original file line number Diff line number Diff line change
@@ -1,4 +1,5 @@
using Appwrite;
using Appwrite.Services;
using Appwrite.Models;

var client = new Client()
Expand Down
1 change: 1 addition & 0 deletions docs/examples/databases/create-enum-attribute.md
Original file line number Diff line number Diff line change
@@ -1,4 +1,5 @@
using Appwrite;
using Appwrite.Services;
using Appwrite.Models;

var client = new Client()
Expand Down
1 change: 1 addition & 0 deletions docs/examples/databases/create-float-attribute.md
Original file line number Diff line number Diff line change
@@ -1,4 +1,5 @@
using Appwrite;
using Appwrite.Services;
using Appwrite.Models;

var client = new Client()
Expand Down
1 change: 1 addition & 0 deletions docs/examples/databases/create-index.md
Original file line number Diff line number Diff line change
@@ -1,4 +1,5 @@
using Appwrite;
using Appwrite.Services;
using Appwrite.Models;

var client = new Client()
Expand Down
1 change: 1 addition & 0 deletions docs/examples/databases/create-integer-attribute.md
Original file line number Diff line number Diff line change
@@ -1,4 +1,5 @@
using Appwrite;
using Appwrite.Services;
using Appwrite.Models;

var client = new Client()
Expand Down
1 change: 1 addition & 0 deletions docs/examples/databases/create-ip-attribute.md
Original file line number Diff line number Diff line change
@@ -1,4 +1,5 @@
using Appwrite;
using Appwrite.Services;
using Appwrite.Models;

var client = new Client()
Expand Down
1 change: 1 addition & 0 deletions docs/examples/databases/create-relationship-attribute.md
Original file line number Diff line number Diff line change
@@ -1,4 +1,5 @@
using Appwrite;
using Appwrite.Services;
using Appwrite.Models;

var client = new Client()
Expand Down
1 change: 1 addition & 0 deletions docs/examples/databases/create-string-attribute.md
Original file line number Diff line number Diff line change
@@ -1,4 +1,5 @@
using Appwrite;
using Appwrite.Services;
using Appwrite.Models;

var client = new Client()
Expand Down
1 change: 1 addition & 0 deletions docs/examples/databases/create-url-attribute.md
Original file line number Diff line number Diff line change
@@ -1,4 +1,5 @@
using Appwrite;
using Appwrite.Services;
using Appwrite.Models;

var client = new Client()
Expand Down
1 change: 1 addition & 0 deletions docs/examples/databases/create.md
Original file line number Diff line number Diff line change
@@ -1,4 +1,5 @@
using Appwrite;
using Appwrite.Services;
using Appwrite.Models;

var client = new Client()
Expand Down
1 change: 1 addition & 0 deletions docs/examples/databases/delete-attribute.md
Original file line number Diff line number Diff line change
@@ -1,4 +1,5 @@
using Appwrite;
using Appwrite.Services;
using Appwrite.Models;

var client = new Client()
Expand Down
1 change: 1 addition & 0 deletions docs/examples/databases/delete-collection.md
Original file line number Diff line number Diff line change
@@ -1,4 +1,5 @@
using Appwrite;
using Appwrite.Services;
using Appwrite.Models;

var client = new Client()
Expand Down
1 change: 1 addition & 0 deletions docs/examples/databases/delete-document.md
Original file line number Diff line number Diff line change
@@ -1,4 +1,5 @@
using Appwrite;
using Appwrite.Services;
using Appwrite.Models;

var client = new Client()
Expand Down
1 change: 1 addition & 0 deletions docs/examples/databases/delete-index.md
Original file line number Diff line number Diff line change
@@ -1,4 +1,5 @@
using Appwrite;
using Appwrite.Services;
using Appwrite.Models;

var client = new Client()
Expand Down
1 change: 1 addition & 0 deletions docs/examples/databases/delete.md
Original file line number Diff line number Diff line change
@@ -1,4 +1,5 @@
using Appwrite;
using Appwrite.Services;
using Appwrite.Models;

var client = new Client()
Expand Down
1 change: 1 addition & 0 deletions docs/examples/databases/get-attribute.md
Original file line number Diff line number Diff line change
@@ -1,4 +1,5 @@
using Appwrite;
using Appwrite.Services;
using Appwrite.Models;

var client = new Client()
Expand Down
1 change: 1 addition & 0 deletions docs/examples/databases/get-collection.md
Original file line number Diff line number Diff line change
@@ -1,4 +1,5 @@
using Appwrite;
using Appwrite.Services;
using Appwrite.Models;

var client = new Client()
Expand Down
1 change: 1 addition & 0 deletions docs/examples/databases/get-document.md
Original file line number Diff line number Diff line change
@@ -1,4 +1,5 @@
using Appwrite;
using Appwrite.Services;
using Appwrite.Models;

var client = new Client()
Expand Down
1 change: 1 addition & 0 deletions docs/examples/databases/get-index.md
Original file line number Diff line number Diff line change
@@ -1,4 +1,5 @@
using Appwrite;
using Appwrite.Services;
using Appwrite.Models;

var client = new Client()
Expand Down
1 change: 1 addition & 0 deletions docs/examples/databases/get.md
Original file line number Diff line number Diff line change
@@ -1,4 +1,5 @@
using Appwrite;
using Appwrite.Services;
using Appwrite.Models;

var client = new Client()
Expand Down
1 change: 1 addition & 0 deletions docs/examples/databases/list-attributes.md
Original file line number Diff line number Diff line change
@@ -1,4 +1,5 @@
using Appwrite;
using Appwrite.Services;
using Appwrite.Models;

var client = new Client()
Expand Down
1 change: 1 addition & 0 deletions docs/examples/databases/list-collections.md
Original file line number Diff line number Diff line change
@@ -1,4 +1,5 @@
using Appwrite;
using Appwrite.Services;
using Appwrite.Models;

var client = new Client()
Expand Down
Loading