Ecosyste.ms: Awesome
An open API service indexing awesome lists of open source software.
https://github.com/edricwilliem/unity-firebase-realtime-database
Unity Firebase Realtime Database REST
https://github.com/edricwilliem/unity-firebase-realtime-database
csharp firebase firebase-database firebase-realtime-database firebase-rest firebase-rest-api rest rest-api unity unity-3d unity-asset unity-plugin unity-scripts unity3d unity3d-plugin
Last synced: 2 months ago
JSON representation
Unity Firebase Realtime Database REST
- Host: GitHub
- URL: https://github.com/edricwilliem/unity-firebase-realtime-database
- Owner: edricwilliem
- License: mit
- Created: 2019-07-01T15:34:43.000Z (over 5 years ago)
- Default Branch: master
- Last Pushed: 2023-11-06T15:28:48.000Z (about 1 year ago)
- Last Synced: 2024-10-29T23:55:29.227Z (3 months ago)
- Topics: csharp, firebase, firebase-database, firebase-realtime-database, firebase-rest, firebase-rest-api, rest, rest-api, unity, unity-3d, unity-asset, unity-plugin, unity-scripts, unity3d, unity3d-plugin
- Language: C#
- Homepage: https://edricwilliem.github.io/unity-firebase-realtime-database/
- Size: 96.7 KB
- Stars: 42
- Watchers: 5
- Forks: 4
- Open Issues: 3
-
Metadata Files:
- Readme: README.md
- License: LICENSE
Awesome Lists containing this project
README
# Unity Firebase Realtime Database REST API
Write, Read, Remove and Streaming data using [Firebase's database REST API](https://firebase.google.com/docs/reference/rest/database)
This is not firebase's official plugins library.
Tested on Android and WebGL platform. should work well on other platforms too since most of the implementation is only a simple http REST request.
Contributions to this project are welcome!.
## Sample Usage
### Setting Firebase
Before using the library you need to setup some settings in `FirebaseSettings.cs`
```
DATABASE_URL = "https://example.firebaseio.com/";
WEB_API = "[WEB_API_KEY]";
```
### Write Data
Set Value:
```
DatabaseReference reference = FirebaseDatabase.Instance.GetReference("path/to/save");
reference.SetValueAsync("mydata", 10,(res) =>
{
if (res.success)
{
Debug.Log("Write success");
}
else
{
Debug.Log("Write failed : " + res.message);
}
});
reference.SetRawJsonValueAsync("{\"key\":\"value\"}", 10,(res) =>
{
if (res.success)
{
Debug.Log("Write success");
}
else
{
Debug.Log("Write failed : " + res.message);
}
});
```
Update Child Value:
```
DatabaseReference reference = FirebaseDatabase.Instance.GetReference("path/to/save");
reference.UpdateValueAsync(new Dictionary(){
{"child1","value1"},{"child2","value2"}
}, 10, (res) =>
{
if (res.success)
{
Debug.Log("Write success");
}
else
{
Debug.Log("Write failed : " + res.message);
}
});
```
Push Value:
```
DatabaseReference reference = FirebaseDatabase.Instance.GetReference("path/to/save");
reference.Push("mydata, 10, (res)=>{
if(res.success){
Debug.Log("Pushed with id: " + res.data);
}
else{
Debug.Log("Push failed : " + res.message);
}
});
```
### Read Data
Get Value:
```
DatabaseReference reference = FirebaseDatabase.Instance.GetReference("path/to/query");
reference.GetValueAsync(10, (res) =>
{
if (res.success)
{
Debug.Log("Success fetched data : " + res.data.GetRawJsonValue());
}
else
{
Debug.Log("Fetch data failed : " + res.message);
}
});
```
Query & Order :
* OrderByChild
* OrderByKey
* OrderByValue
* StartAt
* EndAt
* LimitAtFirst
* LimitAtLast
```
DatabaseReference reference = FirebaseDatabase.Instance.GetReference("path/to/query");
reference.OrderByChild("age").StartAt(12).EndAt(20).LimitAtFirst(5).GetValueAsync(10,(res)=>{
if (res.success)
{
Debug.Log("Success fetched data : " +res.data.GetRawJsonValue());
}
else
{
Debug.Log("Fetch data failed : " + res.message);
}
});
```
### Delete Data
```
DatabaseReference reference = FirebaseDatabase.Instance.GetReference("path/to/delete");
reference.RemoveValueAsync(10, (e) =>
{
if (e.success)
{
Debug.Log("Delete data success");
}
else{
Debug.Log("Delete data failed : " + res.message);
}
});
```
### Streaming Data
```
DatabaseReference reference = FirebaseDatabase.Instance.GetReference("path/to/stream");
reference.ValueChanged += (sender, e) =>
{
Debug.Log(e.Snapshot.GetRawJsonValue());
};
reference.DatabaseError += (sender,e)=>{
Debug.Log(e.DatabaseError.Message);
Debug.Log("Streaming connection closed");
};
```
### Authentication
Set the credential using saved tokens
```
FirebaseAuth.Instance.TokenData = new TokenData()
{
refreshToken = savedRefreshToken,
idToken = savedAccessToken
};
```
or Sign In
```
FirebaseAuth.Instance.SignInWithEmail("[email protected]", "example", 10, (res) =>
{
if (res.success)
{
Debug.Log("Access token : " + res.data.idToken);
}
else
{
Debug.Log("Signed Failed");
}
});
```
after signed in, the `FirebaseAuth.Instance.TokenData` will be automatically set
`FirebaseAuth.Instance.TokenData` will be used for authentication on every database's request.
## License
MIT