Categories > Firebase > rex_firebase_storage

Introduction

Files storage in firebase.

Links

• Plugin
• ACE table
• Discussion thread

Dependence

• rex_firebase_apiv3

Usage

File

Upload

Brief flow

1. Uploading

   • Action:Upload from data URL (sample capx)
   • Action:Upload from sprite (sample capx)
   • Action:Upload from file chooser (sample capx)

2. Callback

   • Success : Condition:On complete

     • Expression:LastDownloadURL

     • Expression:LastMetadata, returns metadata in JSON string

       • Expression:LastMetadata( key ), returns a key
       • Expression:LastMetadata( key, defaultValue ), retruns defaultValue if key is not existed

   • Failed : Condition:On error

     • Error : Expression:LastErrorMessage, Expression:LastErrorCode (reference)

Complete flow

• State: Idle

  • Upload starting

    • Action:Upload from data URL (sample capx)

    • Action:Upload from sprite (sample capx)

    • Action:Upload from file chooser (sample capx)

    • Parameter Metadata

    • Condition:On starting

      • Expression:Progress, Expression:TransferredBytes, Expression:TotalBytes

    • Go to State: Uploading

• State: Uploading

  • Failed event

    • Condition:On upload error

      • Expression:LastErrorMessage, Expression:LastErrorCode (reference)
      • Expression:Progress, Expression:TransferredBytes, Expression:TotalBytes

    • Go to State: Idle

  • Completed event

    • Condition:On upload complete

      • Expression:LastDownloadURL

      • Expression:LastMetadata, returns metadata in JSON string

        • Expression:LastMetadata( key ), returns a key
        • Expression:LastMetadata( key, defaultValue ), retruns defaultValue if key is not existed

      • Expression:Progress, Expression:TransferredBytes, Expression:TotalBytes

    • Go to State: Idle

  • Action:Cancel

    • Condition:On canceled

      • Expression:Progress, Expression:TransferredBytes, Expression:TotalBytes

    • Go to State: Idle

  • Action:Pause

    • Condition:On paused

      • Expression:Progress, Expression:TransferredBytes, Expression:TotalBytes

    • Go to State: Paused

  • Condition:On upload progress

    • Expression:Progress, Expression:TransferredBytes, Expression:TotalBytes

  • Condition:Is uploading returns true

• State: Paused

  • Action:Resume

    • Condition:On resmue

      • Expression:Progress, Expression:TransferredBytes, Expression:TotalBytes

    • Go to State: Uploading

Multiple files uploding

Put or create this rex_firebase_storage object for each file uploading.

Download

Access control allow origin

Follows these steps to allow loading images to sprite from firebase storage.

1. Install gsutil

2. Add cors.json file in local (d:\cors.json)

    
   xxxxxxxxxx
   [
     {
       "origin": ["*"],
       "method": ["GET"],
       "maxAgeSeconds": 3600
     }
   ]
   

   replace * by your domain of application.

3. Type command

   gsutil cors set d:\cors.json gs://exampleproject.appspot.com

   in command line window. Replace exampleproject.appspot.com by your storageBucket link.

Delete

Reference

1. Action:Detete

2. Callback

   • Success : Condition:On deleted

   • Failed : Condition:On deleted error

     • Error : Expression:LastErrorMessage, Expression:LastErrorCode (reference)

Metadata

Reference

Set value

Sample capx

set metadata before uploading file.

• Action:Set value
• Action:Remove key
• Action:Load JSON

Metadata will be cleaned after uploading.

Custom metadata

Custom metadata is an object containing string->string mappings. For example,

Set `customMetadata.version to 0.1.3.4 will add key version, value 0.1.3.4 in customMetadata.

Get

1. Action:Get metadata

2. Callback

   • Success : Condition:On get metadata

     • `Expression:LastMetadata, returns metadata in JSON string

       • Expression:LastMetadata( key ), returns a key
       • Expression:LastMetadata( key, defaultValue ), retruns defaultValue if key is not existed

   • Failed : Condition:On get metadata error

     • Error : Expression:LastErrorMessage, Expression:LastErrorCode (reference)

Update

1. Action:Update metadata

2. Callback

   • Success : Condition:On get metadata

     • `Expression:LastMetadata, returns metadata in JSON string

       • Expression:LastMetadata( key ), returns a key
       • Expression:LastMetadata( key, defaultValue ), retruns defaultValue if key is not existed

   • Failed : Condition:On get metadata error

     • Error : Expression:LastErrorMessage, Expression:LastErrorCode (reference)

Security rules

Reference