analytics

Version: stable

FUNCTION
analytics.init()
analytics.log_string()
analytics.log_int()
analytics.log_number()
analytics.log_table()
analytics.set_screen()
analytics.set_user_id()
analytics.set_user_property()
analytics.reset()
analytics.get_id()

Functions

analytics.init()

analytics.init()

Initialise analytics

PARAMETERS

None

analytics.log_string()

analytics.log_string(name,PARAMeter_name,PARAMeter_value)

Log an event with one string parameter. (Official docs https://firebase.google.com/docs/reference/cpp/namespace/firebase/logevent)

PARAMETERS

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

analytics.log_int()

analytics.log_int(name,PARAMeter_name,PARAMeter_value)

Log an event with one integer parameter. (Official docs https://firebase.google.com/docs/reference/cpp/namespace/firebase/logevent_4)

PARAMETERS

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

analytics.log_number()

analytics.log_number(name,PARAMeter_name,PARAMeter_value)

Log an event with one float parameter. (Official docs https://firebase.google.com/docs/reference/cpp/namespace/firebase/logevent_2)

PARAMETERS

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

analytics.log_table()

analytics.log_table(name,PARAMeters_table)

Log an event with table parameters. (Official docs https://firebase.google.com/docs/reference/cpp/namespace/firebase/logevent_6)

PARAMETERS

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

analytics.set_screen()

analytics.set_screen()

DEPRECATED. Use log_string(analytics.EVENT_SCREENVIEW, "screen name", "screen class").

PARAMETERS

None

analytics.set_user_id()

analytics.set_user_id(user_id)

Sets the user ID property. (Official docs https://firebase.google.com/docs/reference/cpp/namespace/firebase/setuserid)

PARAMETERS

user_id string User ID property

analytics.set_user_property()

analytics.set_user_property(name,property)

Set a user property to the given value. (Official docs https://firebase.google.com/docs/reference/cpp/namespace/firebase/setuserproperty)

PARAMETERS

name string User property name
property string User property value

analytics.reset()

analytics.reset()

Clears all data for this app from the device and resets the app instance id. (Official docs https://firebase.google.com/docs/reference/cpp/namespace/firebase/resetata)

PARAMETERS

None

analytics.get_id()

analytics.get_id(callback)

Get the instance ID from the service. (Official docs https://firebase.google.com/docs/reference/cpp/namespace/firebase/getnstanceid)

PARAMETERS

callback function Function to invoke with the id (self, id)