Extension-firebase-analytics

Functions and constants for interacting with Firebase

Namespace: firebase
Include: #include <>
CONSTANTS
MSG_ERROR
MSG_INSTANCE_ID
FUNCTIONS
void firebase.analytics.initialize()
void firebase.analytics.set_callback(function callback)
void firebase.analytics.log(string name)
void firebase.analytics.log_string(string name, string PARAMeter_name, string PARAMeter_value)
void firebase.analytics.log_int(string name, string PARAMeter_name, number PARAMeter_value)
void firebase.analytics.log_number(string name, string PARAMeter_name, number PARAMeter_value)
void firebase.analytics.log_table(string name, table parameters_table)
void firebase.analytics.set_default_event_params(table default_params)
void firebase.analytics.set_user_id(string user_id)
void firebase.analytics.set_user_property(string name, string property)
void firebase.analytics.reset()
void firebase.analytics.get_id()
void firebase.analytics.set_enabled(boolean key)

Functions

firebase.analytics.initialize

void firebase.analytics.initialize()

Initialise analytics

PARAMETERS

firebase.analytics.set_callback

void firebase.analytics.set_callback(function callback)

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

PARAMETERS

function callback Callback function that is executed on any event in the SDK.

firebase.analytics.log

void firebase.analytics.log(string name)

Log an event without parameters.

PARAMETERS

string name Event name

firebase.analytics.log_string

void firebase.analytics.log_string(string name, string PARAMeter_name, string PARAMeter_value)

Log an event with one string parameter.

PARAMETERS

string name Event name
string PARAMeter_name Parameter name
string PARAMeter_value Parameter value

firebase.analytics.log_int

void firebase.analytics.log_int(string name, string PARAMeter_name, number PARAMeter_value)

Log an event with one integer parameter.

PARAMETERS

string name Event name
string PARAMeter_name Parameter name
number PARAMeter_value Parameter value

firebase.analytics.log_number

void firebase.analytics.log_number(string name, string PARAMeter_name, number PARAMeter_value)

Log an event with one float parameter.

PARAMETERS

string name Event name
string PARAMeter_name Parameter name
number PARAMeter_value Parameter value

firebase.analytics.log_table

void firebase.analytics.log_table(string name, table parameters_table)

Log an event with table parameters.

PARAMETERS

string name Event name
table parameters_table Table with parameters (key-value pairs)

firebase.analytics.set_default_event_params

void firebase.analytics.set_default_event_params(table default_params)

Log an event with table parameters.

PARAMETERS

table default_params Table with default parameters (key-value pairs)

firebase.analytics.set_user_id

void firebase.analytics.set_user_id(string user_id)

Sets the user ID property.

PARAMETERS

string user_id User ID property

firebase.analytics.set_user_property

void firebase.analytics.set_user_property(string name, string property)

Set a user property to the given value.

PARAMETERS

string name User property name
string property User property value

firebase.analytics.reset

void firebase.analytics.reset()

Clears all data for this app from the device and resets the app instance id.

PARAMETERS

firebase.analytics.get_id

void firebase.analytics.get_id()

Get the instance ID from the service. Returned in callback with MSG_INSTANCE_ID message_id.

PARAMETERS

firebase.analytics.set_enabled

void firebase.analytics.set_enabled(boolean key)

Sets whether analytics collection is enabled for this app on this device.

PARAMETERS

boolean key The value

Constants

MSG_ERROR

Event generated when an error occurred.

MSG_INSTANCE_ID

Event generated when instance_id ready after `firebase.analytics.get_id()` call