Firebase SDK

Last Updated: 07/10/2021

ACTIONS

General

  • Load SDK
    Starts the process of loading and connecting to Firebase.
    NOTE: This action is not required if Auto Start Load Property is enabled.


  • Disconnect
    Disconnects Firebase.


  • Reconnect
    Reconnects Firebase if it was disconnected using the Disconnect action.


CONDITIONS

General

  • On Load Success
    Triggers when Firebase has been loaded successfully.
    NOTE: This condition is required even if Auto Start Load Property is enabled.


  • On Disconnect
    Triggers when Firebase has been disconnected successfully.


  • On Reconnect
    Triggers when Firebase has been reconnected successfully.


  • On Timeout
    Triggers when Firebase could not be loaded within the specified value of the Timeout property


PROPERTIES

General

  • Enable Debug
    Enabling Debug Mode will log event messages and errors.
    NOTE: See this Guide to know how to debug.


  • Allow Scripting
    If enabled, this will allow you to access Firebase functions and objects using JavaScript.


  • Primary SDK Object
    If you are using multiple Firebase Projects (or multiple Firebase SDK Objects) in one C3 Project, choose your Primary SDK Object. Otherwise, ignore this property.
    NOTE: See Handling Multiple Firebase Project.c3p Example to see how it works.

SDK Load Options

Settings for Loading SDK

  • Timeout (s)
    Enter time in seconds. If Loading SDK takes more time than this value, the ➜ On Timeout condition will get triggered.


  • Auto Start Load
    If enabled, starts Loading SDK automatically, before the start of layout. If timed-out, it will re-attempt to Load SDK automatically. (Recommended to enable in most cases)

SDK Configuration

Set up Firebase SDK Keys and IDs

NOTE: See this Guide to get started with SDK Configuration


  • apiKey
    Enter apiKey


  • projectID
    Enter projectID


  • databaseURL SubDomain
    Enter databaseURL SubDomain


  • databaseURL Domain
    Choose databaseURL Domain


  • messagingSenderId
    Enter messagingSenderId


  • appId
    Enter appId


  • Firebase Version
    Enter the Firebase API Version

Firebase Services

Choose the required Firebase Services

  • Enable Auth
    Enables Firebase Authentication service


  • Enable Database
    Enables Firebase Realtime-Database service


  • Enable Storage
    Enables Firebase Cloud Storage service


  • Enable Firestore
    Enables Firebase Firestore service
    NOTE: This is only for users who have enabled Allow Scripting property. Requires JavaScript to manage.


  • Enable Analytics
    Enables Firebase Analytics
    NOTE: This is only for users who have enabled Allow Scripting property. Requires JavaScript to manage.

Firebase App Check

Set up Firebase App Check feature

NOTE:
1
. See this Guide to get started with Firebase App Check Configuration
2
. This feature works in Browser/HTML5 only


  • Enable AppCheck
    Enables AppCheck using reCAPTCHA.


  • reCAPTCHA Site Key
    Enter your reCAPTCHA Site Key