firebase

Version: stable

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

Functions

init()

init()

Initialise Firebase

PARAMETERS


analytics.log()

analytics.log(name)

Log an event with no parameters. (Official docs https://firebase.google.com/docs/reference/cpp/namespace/firebase/analytics#logevent_5)

PARAMETERS

name Event name

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/analytics#logevent)

PARAMETERS

name Event name
parameter_name Parameter name
parameter_value 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/analytics#logevent_4)

PARAMETERS

name Event name
parameter_name Parameter name
parameter_value 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/analytics#logevent_2)

PARAMETERS

name Event name
parameter_name Parameter name
parameter_value 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/analytics#logevent_6)

PARAMETERS

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

analytics.set_screen()

analytics.set_screen(screen_name,screen_name)

Sets the current screen name and screen class, which specifies the current visual context in your app. (Official docs https://firebase.google.com/docs/reference/cpp/namespace/firebase/analytics#setcurrentscreen)

PARAMETERS

screen_name Screen name
screen_name Screen class

analytics.set_minimum_session_duration()

analytics.set_minimum_session_duration(milliseconds)

Sets the minimum engagement time required before starting a session. (Official docs https://firebase.google.com/docs/reference/cpp/namespace/firebase/analytics#setminimumsessionduration)

PARAMETERS

milliseconds Minimum engagement

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/analytics#setuserid)

PARAMETERS

user_id 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/analytics#setuserproperty)

PARAMETERS

name User property name
property User property value

analytics.reset()

analytics.reset()

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

PARAMETERS


analytics.get_id()

analytics.get_id()

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

PARAMETERS