API Lua
API Lua

firebase

Version: stable

FUNCTIONS
firebase.initialize()
firebase.get_installation_auth_token()
firebase.set_callback()
firebase.get_installation_id()
CONSTANTS
MSG_ERROR
MSG_INITIALIZED
MSG_INSTALLATION_AUTH_TOKEN
MSG_INSTALLATION_ID

Functions

firebase.initialize()

firebase.initialize(options)

Initialise Firebase

PARAMETERS

options table
 Optional table with initialisation parameters to use instead of those specified in google-services.xml/plist When passing this, disable creation of the default Firebase App by specifying firebase.no_auto_init in game.project Valid keys in the table are api_key, app_id, database_url, messaging_sender_id, project_id, storage_bucket. All values are strings.

firebase.get_installation_auth_token()

firebase.get_installation_auth_token()

Get the Firebase Installation auth token

PARAMETERS

None

firebase.set_callback()

firebase.set_callback(callback)

Sets a callback function for receiving events from the SDK. Call `firebase.set_callback(nil)` to remove callback

PARAMETERS

callback function
 Callback function that is executed on any event in the SDK.
self object
 The calling script instance
message_id number
 One of message types: `firebase.MSG_INITIALIZED` `firebase.MSG_INSTALLATION_AUTH_TOKEN` `firebase.MSG_INSTALLATION_ID` `firebase.MSG_ERROR`
message table
 A table holding the data
token number
 for MSG_INSTALLATION_AUTH_TOKEN
id number
 for MSG_INSTALLATION_ID
error string
 The error message (if an error occurred or `nil` otherwise)

firebase.get_installation_id()

firebase.get_installation_id()

Get the Firebase Installation id

PARAMETERS

None

Constants

MSG_ERROR

MSG_INITIALIZED

MSG_INSTALLATION_AUTH_TOKEN

MSG_INSTALLATION_ID