Giter VIP home page Giter VIP logo

firesharp's Introduction

Fire# for Firebase

.NET wrapper for the Firebase REST API.

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

####Installation (NuGet)

Install-Package FireSharp

Usage

FirebaseClient uses RestSharp JsonSerializer by default but there are other options such as ServiceStack.Text and Json.Net Set FirebaseConfig Serializer property for register custom serializer.

Enable Json.Net Serializer (optional)

Install-Package FireSharp.Serialization.JsonNet

Enable ServiceStack.Text Serializer (optional)

Install-Package FireSharp.Serialization.ServiceStack
IFirebaseConfig config = new FirebaseConfig { AuthSecret = "**your firebase auth secret**", 
                                              BasePath = "**your firebase path**" };
                                              
config.Serializer=new ServiceStackJsonSerializer(); //Register ServiceStack.Text
config.Serializer=new JsonNetSerializer();          //Register Json.Net

IFirebaseClient  client = new FirebaseClient(config);

So far, supported methods are :

client.Set(path, data)
client.Get(path)
client.Push(path, data)
client.Delete(path)
client.Update(path,data)
    
client.SetTaskAsync(path, data)
client.GetTaskAsync(path)
client.PushTaskAsync(path, data)
client.DeleteTaskAsync(path)
client.UpdateTaskAsync(path,data)

####Set

var todo = new Todo {
                name = "Execute SET",
                priority = 2
            };
SetResponse response = _client.Set("todos/set", todo);
Todo result = response.ResultAs<Todo>(); //The response will contain the data written

####Push

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

####Get

 FirebaseResponse response = _client.Get("todos/set");
 Todo todo=response.ResultAs<Todo>(); //The response will contain the data being retreived

####Update

var todo = new Todo {
                name = "Execute UPDATE!",
                priority = 1
            };

FirebaseResponse response = _client.Update("todos/set", todo);
Todo todo = response.ResultAs<Todo>(); //The response will contain the data written

####Delete

DeleteResponse response = _client.Delete("todos"); //Deletes todos collection
response.Success; //Delete success flag

####PushTaskAsync

var todo = new Todo {
                name = "Do your homework!",
                priority = 1
            };

PushResponse response = await _client.PushTaskAsync("todos", todo);
response.Result.Name //The result will contain the child name of the new data that was added

More features and documentation are coming soon.

More information about Firebase and the Firebase API is available at the official website.

License

Code and documentation are available according to the MIT License (see LICENSE).

firesharp's People

Contributors

bugthesystem avatar

Watchers

James Cloos avatar  avatar

Recommend Projects

  • React photo React

    A declarative, efficient, and flexible JavaScript library for building user interfaces.

  • Vue.js photo Vue.js

    ๐Ÿ–– Vue.js is a progressive, incrementally-adoptable JavaScript framework for building UI on the web.

  • Typescript photo Typescript

    TypeScript is a superset of JavaScript that compiles to clean JavaScript output.

  • TensorFlow photo TensorFlow

    An Open Source Machine Learning Framework for Everyone

  • Django photo Django

    The Web framework for perfectionists with deadlines.

  • D3 photo D3

    Bring data to life with SVG, Canvas and HTML. ๐Ÿ“Š๐Ÿ“ˆ๐ŸŽ‰

Recommend Topics

  • javascript

    JavaScript (JS) is a lightweight interpreted programming language with first-class functions.

  • web

    Some thing interesting about web. New door for the world.

  • server

    A server is a program made to process requests and deliver data to clients.

  • Machine learning

    Machine learning is a way of modeling and interpreting data that allows a piece of software to respond intelligently.

  • Game

    Some thing interesting about game, make everyone happy.

Recommend Org

  • Facebook photo Facebook

    We are working to build community through open source technology. NB: members must have two-factor auth.

  • Microsoft photo Microsoft

    Open source projects and samples from Microsoft.

  • Google photo Google

    Google โค๏ธ Open Source for everyone.

  • D3 photo D3

    Data-Driven Documents codes.