Ecosyste.ms: Awesome

An open API service indexing awesome lists of open source software.

Awesome Lists | Featured Topics | Projects

https://github.com/bugthesystem/FireSharp

An asynchronous cross-platform .Net library for Firebase
https://github.com/bugthesystem/FireSharp

c-sharp firebase mono streaming xamarin

Last synced: 3 months ago
JSON representation

An asynchronous cross-platform .Net library for Firebase

Awesome Lists containing this project

README

        

# **Fire#**

![](https://raw.githubusercontent.com/ziyasal/FireSharp/master/misc/logo.png)

Firebase REST API wrapper for the .NET & Xamarin.

Changes are sent to all subscribed clients automatically, so you can
update your clients **in realtime** from the backend.

[![AppVeyor Build status](https://ci.appveyor.com/api/projects/status/bj2sdp2a0w5095sv?svg=true)](https://ci.appveyor.com/project/lablabla/firesharp) [![Coverage Status](https://coveralls.io/repos/github/ziyasal/FireSharp/badge.svg?branch=master)](https://coveralls.io/github/ziyasal/FireSharp?branch=master)

**IMPORTANT :** [**v1 docs**](https://github.com/ziyasal/FireSharp/wiki/v1-Docs) moved [here](https://github.com/ziyasal/FireSharp/wiki/v1-Docs).

#### Installation (NuGet)
```csharp
//**Install v2**
Install-Package FireSharp

//**Install v1**
Install-Package FireSharp -Version 1.1.0
```
### Usage
[FirebaseClient](https://github.com/ziyasal/FireSharp/blob/master/FireSharp/FirebaseClient.cs) uses [Newtonsoft.Json](https://github.com/JamesNK/Newtonsoft.Json) by default.

#### How can I configure FireSharp?
------------------------------

```csharp
IFirebaseConfig config = new FirebaseConfig
{
AuthSecret = "your_firebase_secret",
BasePath = "https://yourfirebase.firebaseio.com/"
};
````
```csharp
IFirebaseClient client = new FirebaseClient(config);
```
So far, supported methods are :

#### Set
```csharp

var todo = new Todo {
name = "Execute SET",
priority = 2
};
SetResponse response = await _client.SetAsync("todos/set", todo);
Todo result = response.ResultAs(); //The response will contain the data written
```
#### Push
```csharp

var todo = new Todo {
name = "Execute PUSH",
priority = 2
};
PushResponse response =await _client.PushAsync("todos/push", todo);
response.Result.name //The result will contain the child name of the new data that was added
```
#### Get
```csharp

FirebaseResponse response = await _client.GetAsync("todos/set");
Todo todo=response.ResultAs(); //The response will contain the data being retreived
```
#### Update
```csharp
var todo = new Todo {
name = "Execute UPDATE!",
priority = 1
};

FirebaseResponse response =await _client.UpdateAsync("todos/set", todo);
Todo todo = response.ResultAs(); //The response will contain the data written
```
#### Delete
```csharp

FirebaseResponse response =await _client.DeleteAsync("todos"); //Deletes todos collection
Console.WriteLine(response.StatusCode);
```
#### Listen **Streaming from the REST API**
```csharp
EventStreamResponse response = await _client.OnAsync("chat", (sender, args, context) => {
System.Console.WriteLine(args.Data);
});

//Call dispose to stop listening for events
response.Dispose();
```

## Release Notes
**5.0**
- Firesharp now supports .NET5

**2.1**
- Firesharp now is a Net Standard library, so it's available for every platform.

**2.0**
- Use Microsoft HTTP Client Libraries instead of RestSharp
- FireSharp is now Portable Library
- Supports Streaming from the REST API (Firebase REST endpoints support the EventSource / Server-Sent Events protocol.)
- It is fully asynchronous and designed to be non-blocking

More information about Firebase and the Firebase API is available at the
[official website](http://www.firebase.com/).