https://github.com/rageagainstthepixel/com.rest.firebase.storage

A non-official Firebase RESTful Storage Client for Unity (UPM)
https://github.com/rageagainstthepixel/com.rest.firebase.storage

firebase firebase-storage openupm unity unity-asset unity-scripts unity3d upm upm-package upm-publisher

Last synced: about 1 month ago
JSON representation

A non-official Firebase RESTful Storage Client for Unity (UPM)

• Host: GitHub
• URL: https://github.com/rageagainstthepixel/com.rest.firebase.storage
• Owner: RageAgainstThePixel
• License: mit
• Created: 2021-06-16T03:46:27.000Z (over 3 years ago)
• Default Branch: main
• Last Pushed: 2024-04-11T19:06:18.000Z (7 months ago)
• Last Synced: 2024-09-24T12:28:45.845Z (about 2 months ago)
• Topics: firebase, firebase-storage, openupm, unity, unity-asset, unity-scripts, unity3d, upm, upm-package, upm-publisher
• Language: C#
• Homepage:
• Size: 269 KB
• Stars: 5
• Watchers: 1
• Forks: 1
• Open Issues: 1
• Metadata Files:
  • Readme: README.md
  • Funding: .github/FUNDING.yml
  • License: LICENSE.md
  • Codeowners: .github/CODEOWNERS

Awesome Lists containing this project

README

        
# Firebase.Storage

[![Discord](https://img.shields.io/discord/855294214065487932.svg?label=&logo=discord&logoColor=ffffff&color=7389D8&labelColor=6A7EC2)](https://discord.gg/xQgMW9ufN4)

[![openupm](https://img.shields.io/npm/v/com.rest.firebase.storage?label=openupm&registry_uri=https://package.openupm.com)](https://openupm.com/packages/com.rest.firebase.storage/)

A non-official [Firebase](https://firebase.google.com/) RESTful Storage Client for the [Unity](https://unity.com/) Game Engine.

Based on [FirebaseStorage.net](https://github.com/step-up-labs/firebase-storage-dotnet)

***All copyrights, trademarks, logos, and assets are the property of their respective owners.***

## Installing

### Via Unity Package Manager and OpenUPM

- Open your Unity project settings

- Add the OpenUPM package registry:

  - `Name: OpenUPM`

  - `URL: https://package.openupm.com`

  - `Scope(s):`

    - `com.rest.firebase`

    - `com.utilities`

![scoped-registries](Firebase.Storage/Packages/com.rest.firebase.storage/Documentation~/images/package-manager-scopes.png)

- Open the Unity Package Manager window

- Change the Registry from Unity to `My Registries`

- Add the `Firebase.Storage` package

### Via Unity Package Manager and Git url

- Open your Unity Package Manager

- Add package from git url: `https://github.com/RageAgainstThePixel/com.rest.firebase.storage.git#upm`

  > Note: this repo has dependencies on other repositories! You are responsible for adding these on your own.

  - [com.rest.firebase.authentication](https://github.com/RageAgainstThePixel/com.rest.firebase.authentication)

  - [com.utilities.async](https://github.com/RageAgainstThePixel/com.utilities.async)

---

## Documentation

```csharp

// Create a firebase authentication client

var firebaseClient = new FirebaseAuthenticationClient();

// Create a firebase storage client

var firebaseStorageClient = new FirebaseStorageClient(firebaseClient);

// Sign the user in

await firebaseClient.SignInWithEmailAndPasswordAsync(email, password);

// Get a reference to the resource using a path.

var resource = firebaseStorageClient.Resource("root/test.json");

var json = "{\"value\":\"42\"}";

string downloadUrl;

using (var stream = new MemoryStream(Encoding.UTF8.GetBytes(json)))

{

    // Upload content to storage

    downloadUrl = await resource.UploadAsync(stream, new Progress(progress => Debug.Log(progress.Percentage)));

}

// Get content public download url (doesn't require authentication)

var knownUrl = await resource.GetDownloadUrlAsync();

Assert.IsTrue(downloadUrl == knownUrl);

// Download content

var httpClient = new HttpClient();

var response = await httpClient.GetAsync(knownUrl);

var responseData = await response.Content.ReadAsStringAsync();

Assert.IsTrue(responseData == json);

// Delete storage content

await resource.DeleteAsync();

```

## Additional Packages

- [Firebase.Authentication](https://github.com/RageAgainstThePixel/com.rest.firebase.authentication)

- [Firebase.Firestore](https://github.com/RageAgainstThePixel/com.rest.firebase.firestore)

- [Firebase.Realtime-Database](https://github.com/RageAgainstThePixel/com.rest.firebase.realtime-database)