GMEXT-Firebase

https://github.com/yoyogames/gmext-firebase
Admin
GMEXT-Firebase is a GameMaker extension that integrates various Firebase services, including...
Tokens:143,669
Snippets:834
Trust Score:8.2
License:Apache-2.0
Update:1 year ago
Show doc for...
Tokens:
Raw
### Initialize Firebase Project

Source: https://github.com/yoyogames/gmext-firebase/wiki/setup_cloud_functions

Initializes a new Firebase project for cloud functions. Requires the Firebase CLI to be installed. The command prompts for project selection and language preferences.

```bash
cd $Path
firebase init
```

--------------------------------

### Install Firebase Tools Globally

Source: https://github.com/yoyogames/gmext-firebase/wiki/setup_cloud_functions

Installs the Firebase command-line interface tools globally on your system. This is a prerequisite for using Firebase commands like 'firebase init' and 'firebase deploy'. NodeJS must be installed prior to this command.

```bash
npm install -g firebase-tools
```

--------------------------------

### Configure Firebase Realtime Database

Source: https://github.com/yoyogames/gmext-firebase/wiki/Guides_Realtime

Steps to create and configure a new Firebase Realtime Database in the Firebase Console. This involves selecting 'Create Database', choosing a location, and starting in test mode.

```text
1. On your Firebase project, click on **Realtime Database** and select **Create Database** .
2. Select your database location and click on **Next** .
3. Select **Start in**  **test mode**  and click on Next .
4. You are now ready to start using Firebase Realtime Database extension.
```

--------------------------------

### Basic HelloWorld Cloud Function

Source: https://github.com/yoyogames/gmext-firebase/wiki/setup_cloud_functions

An example of a basic 'helloWorld' function in JavaScript for Firebase Cloud Functions. It is exported and configured to respond to HTTP requests, receiving a request object and sending back a response.

```javascript
const functions = require("firebase-functions");

exports.helloWorld = functions.https.onRequest((request, response) => {
  functions.logger.info("Hello logs!", {structuredData: true});
  response.send("Hello from Firebase!");
});
```

--------------------------------

### Initialize Firebase Functions Project (CLI)

Source: https://github.com/yoyogames/gmext-firebase/blob/main/docs/Setup_Cloud_Functions.md

This command initializes a Firebase project for Cloud Functions. It prompts the user to select a Firebase project, choose a language (JavaScript/TypeScript), and configure settings like ESLint. It installs necessary dependencies.

```bash
firebase init
```

--------------------------------

### GameMaker REST API Setup for Firebase

Source: https://github.com/yoyogames/gmext-firebase/wiki/Guides_Realtime

Instructions to configure the GameMaker project to use the Firebase Realtime Database REST API. This involves copying the database URL from Firebase and pasting it into the YYFirebaseRealtime script in GameMaker.

```text
1. On your Firebase project's dashboard, click on **Realtime Database** and copy your database's link.
2. In your GameMaker project, open the script **YYFirebaseRealTime** and paste your link **in the Database URL** field (1) at the bottom of the window also change the config value to use the REST API (2).
3. You now have the Firebase Realtime extension configured to use the REST API.
```

--------------------------------

### Initialize Firebase Functions Project

Source: https://github.com/yoyogames/gmext-firebase/blob/main/source/Firebase_gml/extensions/FirebaseSetup/docs/setup_cloud_functions.html

This snippet shows the command-line process for initializing a Firebase project specifically for Cloud Functions. It involves navigating to the project directory, running 'firebase init', selecting 'Functions', choosing a project, and selecting JavaScript as the language. Dependencies are installed.

```bash
cd $Path
firebase init
# Select Functions
# Choose existing Firebase project
# Enter Project ID
# Select JavaScript
# Select N for ESLint (optional)
# Select Y for installing dependencies
```

--------------------------------

### iOS Firebase Configuration Download

Source: https://github.com/yoyogames/gmext-firebase/blob/main/source/Firebase_gml/extensions/FirebaseSetup/docs/platform_setup.html

This step involves downloading the GoogleService-info.plist file, which contains essential configuration details for Firebase services on iOS. This file is crucial for the Firebase SDK to connect to your Firebase project. Ensure this file is saved securely and not shared publicly.

```text
GoogleService-info.plist
```

--------------------------------

### Get Local Player Info: New GameMaker GameCenter Version

Source: https://github.com/yoyogames/gmext-firebase/blob/main/source/Firebase_gml/extensions/GameCenter/docs/quick_start_guide.html

Illustrates how to retrieve information about the locally authenticated player using the GameCenter extension. The returned JSON string can be parsed into a struct for detailed player information.

```gml
var playerInfoJSON = GameCenter_LocalPlayer_GetInfo();
var playerInfo = json_parse(playerInfoJSON);
```

--------------------------------

### Show Leaderboards (Old vs. New GML)

Source: https://github.com/yoyogames/gmext-firebase/blob/main/source/Firebase_gml/extensions/GameCenter/docs/quick_start_guide.html

Demonstrates the difference between the old and new GameMaker Language functions for displaying leaderboards to the user. The old version used a single function `achievement_show_leaderboards()`. The new version offers flexibility with `GameCenter_PresentView_Leaderboard` for a specific leaderboard and `GameCenter_PresentView_Leaderboards` for all leaderboards.

```gml
// Old Version
achievement_show_leaderboards();

// New Version - Show all leaderboards
GameCenter_PresentView_Leaderboards();

// New Version - Show a specific leaderboard
GameCenter_PresentView_Leaderboard(leaderboardId, timeScope, playerScope);
```

--------------------------------

### GameMaker: Firebase Performance Trace Management Example

Source: https://github.com/yoyogames/gmext-firebase/blob/main/source/Firebase_gml/extensions/FirebaseSetup/docs/performance.html

This example demonstrates the lifecycle of a Firebase Performance trace in GameMaker. It covers creating a trace, adding attributes, setting and incrementing metrics, retrieving metric values, starting the trace, and finally stopping it after a period. This is useful for profiling specific game loops or events.

```gml
var TraceName = "MyGameTrace";

FirebasePerformance_Trace_Create(TraceName);
FirebasePerformance_Trace_Attribute_Put(TraceName,"key1","value1");
FirebasePerformance_Trace_Attribute_Put(TraceName,"key2","value2");
show_debug_message(FirebasePerformance_Trace_Attribute_Get(TraceName,"key1"));
show_debug_message(FirebasePerformance_Trace_Attribute_GetAll(TraceName));
FirebasePerformance_Trace_Metric_Put(TraceName,"key3",10);
FirebasePerformance_Trace_Metric_Increment(TraceName,"key3",1);
show_debug_message(FirebasePerformance_Trace_Metric_GetLong(TraceName,"key3"));
FirebasePerformance_Trace_Start(TraceName);

//After some time...
FirebasePerformance_Trace_Stop(TraceName);
```

--------------------------------

### Deploy Firebase Cloud Functions

Source: https://github.com/yoyogames/gmext-firebase/wiki/setup_cloud_functions

Deploys your locally configured Firebase Cloud Functions to the Firebase servers. This command should be run from the root of your Firebase project directory.

```bash
firebase deploy
```

--------------------------------

### Sign In/Out: Old GameMaker GameCenter Version

Source: https://github.com/yoyogames/gmext-firebase/blob/main/source/Firebase_gml/extensions/GameCenter/docs/quick_start_guide.html

Demonstrates how to check the achievement login status and initiate login in the older version of the GameCenter extension. This triggers a Social Async Event with 'achievement_our_info' ID.

```gml
if (!achievement_login_status()) {
    achievement_login();
}
```

--------------------------------

### Sign In/Out: New GameMaker GameCenter Version

Source: https://github.com/yoyogames/gmext-firebase/blob/main/source/Firebase_gml/extensions/GameCenter/docs/quick_start_guide.html

Shows how to check if the local player is authenticated and authenticate them using the new GameCenter extension functions. Successful authentication triggers a Social Async Event with 'GameCenter_Authenticate' type and a 'success' key.

```gml
if (!GameCenter_LocalPlayer_IsAuthenticated()) {
    GameCenter_LocalPlayer_Authenticate();
}
```

--------------------------------

### Manage Achievements (Old vs. New GML)

Source: https://github.com/yoyogames/gmext-firebase/blob/main/source/Firebase_gml/extensions/GameCenter/docs/quick_start_guide.html

Illustrates the evolution of GameMaker Language functions for managing in-game achievements. This includes reporting progress, revealing hidden achievements, and displaying the achievements interface. The old functions like `achievement_reveal`, `achievement_post`, `achievement_increment`, and `achievement_show_achievements` are compared to their new counterparts such as `GameCenter_Achievement_Report`, `GameCenter_Achievement_ResetAll`, and `GameCenter_PresentView_Achievements`.

```gml
// Old Version
achievement_reveal(achievementId);
achievement_post(achievementId, percent);
achievement_increment(incrementalAchievementId, amount);
achievement_show_achievements();

// New Version Equivalents (Refer to specific function mappings for exact usage)
// GameCenter_Achievement_Report(achievementId, value);
// GameCenter_Achievement_ResetAll();
// GameCenter_PresentView_Achievements();
// GameCenter_PresentView_Achievement(achievementId);
```

--------------------------------

### Save Game Functionality

Source: https://github.com/yoyogames/gmext-firebase/blob/main/source/Firebase_gml/extensions/GameCenter/docs/quick_start_guide.html

This section details the GameCenter saved games functionality, which requires the user's iOS device to have iCloud Drive enabled and the developer's project to have a dedicated CloudKit container. The code examples illustrate saving, deleting, fetching, and retrieving game data.

```gml
// Save a slot
GameCenter_SavedGames_Save(slot_data, slot_name);

// Delete a slot
GameCenter_SavedGames_Delete(slot_id);

// Fetch all saved slots
GameCenter_SavedGames_Fetch();

// Get data for a specific slot
GameCenter_SavedGames_GetData(slot_id);
```

--------------------------------

### Submit Score to Leaderboard (Old vs. New GML)

Source: https://github.com/yoyogames/gmext-firebase/blob/main/source/Firebase_gml/extensions/GameCenter/docs/quick_start_guide.html

Compares the old and new methods for submitting a score to a GameCenter leaderboard using GameMaker Language. The old method used `achievement_post_score` and triggered a Social Async Event. The new method uses `GameCenter_Leaderboard_Submit` and also triggers a Social Async Event upon completion.

```gml
// Old Version
achievement_post_score(global.leaderboardId, score);

// New Version
GameCenter_Leaderboard_Submit(global.leaderboardId, score);
```

--------------------------------

### FirebasePerformance_Trace_Start

Source: https://github.com/yoyogames/gmext-firebase/blob/main/source/Firebase_gml/extensions/FirebaseSetup/docs/performance.html

Starts a performance trace. This function initiates the timing for a specific trace.

```APIDOC
## FirebasePerformance_Trace_Start

### Description
Starts the trace. This function initiates the timing for a specific trace.

### Method
Not Applicable (GML function)

### Endpoint
Not Applicable (GML function)

### Parameters
#### Path Parameters
None

#### Query Parameters
None

#### Request Body
None

### Request Example
```gml
FirebasePerformance_Trace_Start(TraceName);
```

### Response
#### Success Response (200)
N/A

#### Response Example
N/A
```

--------------------------------

### Example: Firebase Performance HTTP Metric Usage (GML)

Source: https://github.com/yoyogames/gmext-firebase/wiki/Performance

Demonstrates the usage of various Firebase Performance Monitoring functions in GML, including creating an HTTP metric, setting request/response details, starting and stopping the metric, and managing attributes.

```gml
FirebasePerformance_HttpMetric_Create(httpMetric,"gamemaker.io","GET");
FirebasePerformance_HttpMetric_Attribute_Put(httpMetric,"key1","value1");
FirebasePerformance_HttpMetric_Attribute_Put(httpMetric,"key2","value2");
show_debug_message(FirebasePerformance_HttpMetric_Attribute_Get(httpMetric));
FirebasePerformance_HttpMetric_SetRequestPayloadSize(httpMetric,100);
FirebasePerformance_HttpMetric_SetResponseContentType(httpMetric,"text/html");//, application/json, etc.
FirebasePerformance_HttpMetric_SetResponsePayloadSize(httpMetric,100);
FirebasePerformance_HttpMetric_SetHttpResponseCode(httpMetric,200);
FirebasePerformance_HttpMetric_Start(httpMetric);

//After some time
FirebasePerformance_HttpMetric_Stop(httpMetric);
```

--------------------------------

### Apple Authentication

Source: https://github.com/yoyogames/gmext-firebase/blob/main/source/Firebase_gml/extensions/FirebaseSetup/docs/logins_authentication.html

Guides users through setting up Apple authentication, including prerequisites, necessary parameters, and available functions.

```APIDOC
## Apple Authentication

This guide will get you up and running using Apple authentication.

### Prerequisites

These are the requirements for this setup:

*   **AppleSignIn** extension (download from the [marketplace](https://marketplace.gamemaker.io/assets/8598/apple-sign-in))

### Parameters

You will need to obtain these parameters:

*   **token:** Obtained from the callback of `AppleSignIn_CrossPlatform_AuthoriseUser` function (included in the Apple SignIn extension) 
*   **provider:** `"apple.com"`
*   **token_kind:** `"id_token"`
*   **redirect_uri** **:** `"https://**.firebaseapp.com/__/auth/handler"` , this value can be obtained from the [Firebase Console](https://console.firebase.google.com/) → Authentication → Sign-In Method → Sign-In Providers → Apple

### Functions

The following functions are provided for signing-in / linking / re-authenticating the user:

*   [FirebaseAuthentication_SignIn_OAuth](authentication.html#firebaseauthentication_signin_oauth) (if the user is logged out)
*   [FirebaseAuthentication_LinkWithOAuthCredential](authentication.html#firebaseauthentication_linkwithoauthcredential) (if the user is logged in but has no provider)
*   [FirebaseAuthentication_ReauthenticateWithOAuth](authentication.html#firebaseauthentication_reauthenticatewithoauth) (if the user is logged in and already linked to the Apple provider)
```

--------------------------------

### GameMaker: Start Firebase Performance Trace

Source: https://github.com/yoyogames/gmext-firebase/blob/main/source/Firebase_gml/extensions/FirebaseSetup/docs/performance.html

Initiates a Firebase Performance trace. Any metrics or attributes added before starting the trace will be associated with it. This function is essential for beginning the data collection period for a specific operation or code segment you wish to profile.

```gml
FirebasePerformance_Trace_Start(TraceName);
```

--------------------------------

### <dbEntryRef>.StartAt

Source: https://github.com/yoyogames/gmext-firebase/wiki/Realtime

Filters a database query to return entries starting from the specified value.

```APIDOC
## POST /realtime/dbEntryRef/startAt

### Description
This function is a filter that should be used when performing a Read operation or creating a Listener that is ordered in some way. The filter assures that the returned results start at a specific value.

### Method
POST

### Endpoint
/realtime/dbEntryRef/startAt

### Parameters
#### Query Parameters
- **value** (Real or String) - Required - The value to start the query at.

### Request Example
```json
{
  "value": 10
}
```

### Response
#### Success Response (200)
- **dbEntryRef** (object) - The filtered database entry reference.

#### Response Example
```json
{
  "listenerId": "some_listener_id"
}
```
```

--------------------------------

### iOS Firebase Project Setup for GameMaker

Source: https://github.com/yoyogames/gmext-firebase/wiki/platform_setup

This section details the process of setting up Firebase for iOS within a GameMaker project. It involves downloading the GoogleService-Info.plist file from the Firebase console and configuring it within the GameMaker extension. CocoaPods setup is also mentioned as a requirement unless only the REST API is used.

```plaintext
1. Download GoogleService-Info.plist from Firebase console.
2. In GameMaker, open the FirebaseSetup extension asset.
3. Fill in the path for the iOS GoogleService-Info.plist file in the extension options.
4. Ensure CocoaPods is set up for your project (unless using only REST API).
```

--------------------------------

### Manage Trace Attributes and Metrics in Firebase Performance Monitoring (Android/GML)

Source: https://github.com/yoyogames/gmext-firebase/wiki/Performance

This GML example showcases various operations for Firebase Performance Monitoring traces, specifically on Android. It includes creating a trace, adding and retrieving attributes, getting all attributes, putting and incrementing metrics, and starting and stopping the trace. This demonstrates comprehensive trace management.

```gml
FirebasePerformance_Trace_Create(TraceName);
FirebasePerformance_Trace_Attribute_Put(TraceName,"key1","value1");
FirebasePerformance_Trace_Attribute_Put(TraceName,"key2","value2");
show_debug_message(FirebasePerformance_Trace_Attribute_Get(TraceName,"key1"));
show_debug_message(FirebasePerformance_Trace_Attribute_GetAll(TraceName));
FirebasePerformance_Trace_Metric_Put(TraceName,"key3",10);
FirebasePerformance_Trace_Metric_Increment(TraceName,"key3",1);
show_debug_message(FirebasePerformance_Trace_Metric_GetLong(TraceName,"key3"));
FirebasePerformance_Trace_Start(TraceName);

//After some time...
FirebasePerformance_Trace_Stop(TraceName);
```

--------------------------------

### Example GameCenter Leaderboard Load Function Call (GML)

Source: https://github.com/yoyogames/gmext-firebase/blob/main/source/Firebase_gml/extensions/GameCenter/docs/leaderboard.html

An example demonstrating how to call a GameCenter leaderboard loading function in GameMaker Language. This specific example shows loading a leaderboard named 'YYLeaderboard1' for all time, considering friends only, and specifying a player index and count.

```gml
GameCenter_Leaderboard_LoadFriendsOnly("YYLeaderboard1", GameCenter_Leaderboard_TimeScope_AllTime, 1, 5);
```

--------------------------------

### Enabling Firebase Crashlytics in Firebase Console

Source: https://github.com/yoyogames/gmext-firebase/blob/main/source/Firebase_gml/extensions/FirebaseSetup/docs/guides_crashlytics.html

This guide explains how to enable Firebase Crashlytics within the Firebase console and trigger a test crash. It is necessary for monitoring game crash logs after the initial setup.

```text
1. On your Firebase console, select **Crashlytics** under "Release & Monitor"; then **select your Android** / **iOS** project **and click on Enable Crashlytics**.
   ![](assets/crashlyticsEnable.png)
2. On this screen, the Firebase console will wait for a test crash from your app. To skip this screen you need to build a project (see [Building on iOS](guides_crashlytics.html#building-on-ios) if you are building for the iOS target), unplug your device and run a call to the included [FirebaseCrashlytics_Crash](crashlytics.html#firebasecrashlytics_crash) function.
   ![](assets/crashlyticsWaiting.png)
3. You are now all set to monitor your game crash logs.
```

--------------------------------

### Start Firebase Performance Trace - GML

Source: https://github.com/yoyogames/gmext-firebase/wiki/Performance

Starts a Firebase Performance trace with the given name. This function is essential for beginning the timing and data collection for a specific operation or screen. Requires the trace name as a string argument.

```gml
FirebasePerformance_Trace_Start(name)
```

--------------------------------

### FirebaseFirestore.StartAt

Source: https://github.com/yoyogames/gmext-firebase/blob/main/source/Firebase_gml/extensions/FirebaseSetup/docs/firestore.html

Filters query results to start at a specific value, used in conjunction with OrderBy.

```APIDOC
## FirebaseFirestore.StartAt

### Description
Filters query results to start at a specific value, used in conjunction with OrderBy. The queried documents will start from the value specified, relative to the field used in OrderBy.

### Method
This is a method called on a dbReference object, typically chained before .Query().

### Endpoint
N/A (Client-side function)

### Parameters
#### Arguments
- **value** (Real or String) - Required - The value to start the query at. The type should match the field type being ordered by.

### Request Example
```javascript
listenerId = FirebaseFirestore("myCollection").OrderBy("Points", "ASCENDING").StartAt(10).Query();
```

### Response
#### Returns
- **dbReference**: The modified dbReference object with the filter applied, allowing further chaining of methods.

#### Response Example
(This method modifies the dbReference and does not return a direct response payload. The response is handled by the .Query() method.)
```

--------------------------------

### Report Game Center Achievements

Source: https://github.com/yoyogames/gmext-firebase/blob/main/source/Firebase_gml/extensions/GameCenter/docs/quick_start_guide.html

This code snippet demonstrates how to report achievement completion and display achievement views using the GameCenter API. It utilizes functions like GameCenter_Achievement_Report to update progress and GameCenter_PresentView_* to show achievement information to the player. These actions trigger Social Async Event callbacks with relevant completion data.

```gml
GameCenter_Achievement_Report(achievementId, percent);
GameCenter_PresentView_Achievement(achievementId); // Show single
GameCenter_PresentView_Achievements(); // Show all
```

--------------------------------

### Google Play Services Authentication

Source: https://github.com/yoyogames/gmext-firebase/wiki/LogIns_Authentication

Guide to setting up and using Google Play Services authentication.

```APIDOC
## Google Play Services Authentication

### Description
This guide covers the setup and usage of Google Play Services authentication for your application.

### Prerequisites

*   Google Play Services extension installed.
*   A `webClientID` obtained from Google Cloud Console.

### Key Function

*   `GooglePlayServices_RequestServerSideAccess`: Call this function with your `webClientID` to obtain an authorization code from the Google server.

### Parameters for Authentication

*   **token:** Obtained from `GooglePlayServices_RequestServerSideAccess`.
*   **provider:** Must be set to `"playgames.google.com"`.
*   **token_kind:** Must be set to `"serverAuthCode"`.
*   **redirect_uri:** Should be an empty string `""`.
```

--------------------------------

### Google Authentication

Source: https://github.com/yoyogames/gmext-firebase/blob/main/source/Firebase_gml/extensions/FirebaseSetup/docs/logins_authentication.html

Guide to setting up and using Google Authentication with Firebase. Requires the GoogleSignIn extension and a webClientID from Google Cloud Console.

```APIDOC
## Google Authentication

### Description
This guide provides steps to integrate Google authentication into your project using the GoogleSignIn extension.

### Prerequisites
* GoogleSignIn extension
* webClientID from Google Cloud Console

### Parameters
* **token**: Obtained from the callback of `GoogleSignIn_Show`.
* **provider**: "google.com"
* **token_kind**: "id_token"
* **redirect_uri**: ""

### Functions
* `FirebaseAuthentication_SignIn_OAuth`: For users who are logged out.
* `FirebaseAuthentication_LinkWithOAuthCredential`: For logged-in users without a provider.
* `FirebaseAuthentication_ReauthenticateWithOAuth`: For logged-in users already linked to a phone provider.
```

--------------------------------

### GooglePlayServices_SignIn API

Source: https://github.com/yoyogames/gmext-firebase/blob/main/source/Firebase_gml/extensions/GooglePlayServices/docs/general.html

Manually requests that your game sign in with Play Games Services. This is useful if the automatic sign-in attempt at game start fails.

```APIDOC
## GooglePlayServices_SignIn

### Description
Manually requests that your game sign in with Play Games Services. This is useful if the automatic sign-in attempt at game start fails.

### Method
N/A (This is a function call within the game engine)

### Endpoint
N/A

### Parameters
#### Path Parameters
N/A

#### Query Parameters
N/A

#### Request Body
N/A

### Request Example
```javascript
GooglePlayServices_SignIn()
```

### Response
#### Triggers
- **Social Async Event**
  - **type** (String) - The string "GooglePlayServices_SignIn"
  - **success** (Boolean) - Whether or not the function request succeeded
  - **isAuthenticated** (Boolean) - Whether or not player is authenticated

#### Response Example
```javascript
if(async_load[? "type"] == "GooglePlayServices_SignIn")
{
    if(!async_load[?"success"])
       exit

    if(async_load[?"isAuthenticated"])
       // Player is authenticated
}
```
```

--------------------------------

### Filter Data Starting At Specific Value in GML

Source: https://github.com/yoyogames/gmext-firebase/wiki/Realtime

The StartAt function is a filter for ordered read operations or listeners. It specifies the starting value for the query, returning results that are greater than or equal to this value. It accepts a Real or String and returns a dbEntryRef.

```gml
listenerId = FirebaseRealTime().Path("players/healthList").OrderByValue().StartAt(10).Read();
```

--------------------------------

### Phone Authentication

Source: https://github.com/yoyogames/gmext-firebase/blob/main/source/Firebase_gml/extensions/FirebaseSetup/docs/logins_authentication.html

Guide to setting up and using Phone Authentication with Firebase, involving reCAPTCHA verification and SMS code confirmation.

```APIDOC
## Phone Authentication

### Description
This guide details the 5 steps required for implementing phone number authentication using Firebase.

### Steps
1. Get `recaptchaSiteKey` from `FirebaseAuthentication_RecaptchaParams` callback.
2. Solve the reCAPTCHA puzzle by hosting a website.
3. Pass the `recaptchaToken` to your game.
4. Send the verification code using `FirebaseAuthentication_SendVerificationCode` and get `sessionInfo`.
5. Obtain the SMS code from the user and use it with `sessionInfo`.

### Functions
* `FirebaseAuthentication_SignInWithPhoneNumber`: For users who are logged out.
* `FirebaseAuthentication_LinkWithPhoneNumber`: For logged-in users without a provider.
```

--------------------------------

### <dbEntryRef>.Listener

Source: https://github.com/yoyogames/gmext-firebase/blob/main/source/Firebase_gml/extensions/FirebaseSetup/docs/realtime.html

Starts listening for changes to a specific database entry. This is an asynchronous operation that triggers the Social Async Event upon completion.

```APIDOC
## <dbEntryRef>.Listener

### Description
Listens for changes to a given entry in the database. This is an asynchronous function that triggers the Social Async Event when changes occur.

### Method
Various (Method of dbEntryRef)

### Endpoint
N/A (GML Function)

### Parameters
#### Path Parameters
None

#### Query Parameters
None

#### Request Body
None

### Request Example
```gml
var _listenerId = FirebaseRealTime("players/hero").Listener();

// Inside a Social Async Event:
if (async_load[? "type"] == "FirebaseRealTime_Listener") {
    if (async_load[? "status"] == 200) {
        show_debug_message("Changes detected in database entry.");
    } else {
        var _errorMessage = async_load[? "errorMessage"];
        show_debug_message("Error: " + _errorMessage);
    }
}
```

### Response
#### Success Response (Triggers Async Event)
- **type** (String) - Always \"FirebaseRealTime_Listener\".
- **listener** (Real) - The asynchronous listener ID.
- **path** (String) - The path of the database reference being listened to.
- **status** (Real) - The HTTP status response code.
- **value** (Real or String or Struct) - The new value of the entry.
- **errorMessage** (String) - A readable error message if an error occurred.

#### Response Example
(Data is returned via the Social Async Event, not directly from the function call. Example shown in Request Example.)
```

--------------------------------

### Create Firebase Performance Trace (GML)

Source: https://github.com/yoyogames/gmext-firebase/wiki/Performance

Creates a Firebase Performance trace object with a specified name. This function initializes a trace that can then be started, stopped, and have attributes or metrics added to it.

```gml
FirebasePerformance_Trace_Create(name)
```

--------------------------------

### Realtime Database Overview

Source: https://github.com/yoyogames/gmext-firebase/blob/main/source/Firebase_gml/extensions/FirebaseSetup/docs/realtime.html

The Firebase Realtime Database is a cloud-hosted NoSQL database that synchronizes data in real time across all connected clients. This section outlines the general setup and available functions for interacting with the database.

```APIDOC
## Realtime Database

### Description
The Firebase Realtime Database is a cloud-hosted database. Data is stored as JSON and synchronized in real time to every connected client. All clients share one instance and automatically receive updates.

### Setup
Before using the extension, follow these steps:
1. Create a Firebase Project (if you don't have one).
2. Enable Firebase Realtime Database in the Firebase Console.
3. Configure SDKs or REST API for your target platform.

### Core Functions
The extension uses a fluent API with the `FirebaseRealTime` function as the entry point, returning a `dbEntryRef`.

- **`FirebaseRealTime()`**: Initializes interaction with the Realtime Database.
- **`<dbEntryRef>.Child(path)`**: Accesses a child node at the specified path.
- **`<dbEntryRef>.Delete()`**: Deletes the data at the current reference.
- **`<dbEntryRef>.Exists()`**: Checks if data exists at the current reference.
- **`<dbEntryRef>.Listener()`**: Sets up a real-time listener for data changes.
- **`<dbEntryRef>.ListenerRemove()`**: Removes a specific data listener.
- **`<dbEntryRef>.ListenerRemoveAll()`**: Removes all data listeners.
- **`<dbEntryRef>.Parent()`**: Gets the parent reference of the current node.
- **`<dbEntryRef>.Path()`**: Gets the full path of the current reference.
- **`<dbEntryRef>.Push(data)`**: Adds data to the database with a unique key.
- **`<dbEntryRef>.Set(data)`**: Sets or overwrites data at the current reference.
- **`<dbEntryRef>.Read()`**: Reads data from the current reference.

### Filter Functions (for `Read()`)
These functions are used to filter data when reading from the database:

- **`<dbEntryRef>.EndAt(value)`**: Includes results that are less than or equal to the specified value.
- **`<dbEntryRef>.EqualTo(value)`**: Includes results that are exactly equal to the specified value.
- **`<dbEntryRef>.LimitToFirst(limit)`**: Limits the results to the first specified number of items.
- **`<dbEntryRef>.LimitToLast(limit)`**: Limits the results to the last specified number of items.
- **`<dbEntryRef>.OrderByChild(key)`**: Orders results by the value of a specified child key.
- **`<dbEntryRef>.OrderByKey()`**: Orders results by their keys.
- **`<dbEntryRef>.OrderByValue()`**: Orders results by their values.
- **`<dbEntryRef>.StartAt(value)`**: Includes results that are greater than or equal to the specified value.

### Structs
- **`dbEntryRef`**: Represents a reference to a location in the Realtime Database, allowing for data manipulation and querying.
```

--------------------------------

### MkDocs Commands

Source: https://github.com/yoyogames/gmext-firebase/blob/main/source/Firebase_gml/extensions/GooglePlayServices/docs/index.html

Common commands for using MkDocs to create, serve, and build documentation sites. MkDocs is a fast, simple, and downright gorgeous static site generator that's geared towards building project documentation.

```bash
mkdocs new [dir-name]
mkdocs serve
mkdocs build
mkdocs -h
```

--------------------------------

### Firebase Realtime Database Initialization

Source: https://github.com/yoyogames/gmext-firebase/blob/main/source/Firebase_gml/extensions/FirebaseSetup/docs/realtime.html

Initializes the Firebase Realtime Database extension. This is the entry point for all database operations. It returns a dbEntryRef object that allows for further interaction with the database.

```gml
var db = FirebaseRealTime();
```

--------------------------------

### Start and Stop HTTP Metric Collection

Source: https://github.com/yoyogames/gmext-firebase/blob/main/source/Firebase_gml/extensions/FirebaseSetup/docs/performance.html

The `FirebasePerformance_HttpMetric_Start` function marks the beginning of a network request's measurement, and `FirebasePerformance_HttpMetric_Stop` marks its end, queuing the metric for transmission. These are essential for accurately timing and reporting network activity.

```gml
FirebasePerformance_HttpMetric_Create(httpMetric,"gamemaker.io","GET");
FirebasePerformance_HttpMetric_Start(httpMetric);

//After some time
FirebasePerformance_HttpMetric_Stop(httpMetric);
```

--------------------------------

### Firebase OAuth Sign-in/Link/Re-authenticate

Source: https://github.com/yoyogames/gmext-firebase/blob/main/docs/LogIns_Authentication.md

These functions facilitate Firebase user authentication using OAuth credentials. They handle scenarios for new sign-ins, linking existing accounts, and re-authenticating users already logged in.

```gml
FirebaseAuthentication_SignIn_OAuth();
FirebaseAuthentication_LinkWithOAuthCredential();
FirebaseAuthentication_ReauthenticateWithOAuth();
```

--------------------------------

### Get Firebase App Check Tokens (GameMaker)

Source: https://github.com/yoyogames/gmext-firebase/blob/main/docs/guides_app_check.md

Functions to retrieve Firebase App Check tokens for use with non-Firebase backends. These functions allow your game to obtain necessary tokens for verification purposes.

```gml
FirebaseAppCheck_GetToken();
FirebaseAppCheck_LimitedUseToken();
```

--------------------------------

### JavaScript Initialization for Sphinx Theme

Source: https://github.com/yoyogames/gmext-firebase/blob/main/source/Firebase_gml/extensions/GooglePlayServices/docs/_footer.html

Initializes the Sphinx Real-Time Documentation theme navigation. This JavaScript code is typically found in documentation build processes to enable interactive elements.

```javascript
var base_url = ".";
jQuery(function () {
    SphinxRtdTheme.Navigation.enable(true);
});
```

--------------------------------

### GameMaker: Get Firebase App Check Token

Source: https://github.com/yoyogames/gmext-firebase/wiki/guides_app_check

Retrieves the App Check token for use with non-Firebase backends. This function is available within the GameMaker environment and requires the YYFirebaseAppCheck extension to be included in the project.

```gml
var token = FirebaseAppCheck_GetToken();
// Use the token as needed
```

--------------------------------

### GameMaker: Get Limited Use Firebase App Check Token

Source: https://github.com/yoyogames/gmext-firebase/wiki/guides_app_check

Retrieves a limited-use App Check token for specific use cases with non-Firebase backends. This function is part of the GameMaker integration and relies on the YYFirebaseAppCheck extension.

```gml
var limited_token = FirebaseAppCheck_LimitedUseToken();
// Use the limited token as needed
```

--------------------------------

### Trigger a Test Crash with FirebaseCrashlytics_Crash

Source: https://github.com/yoyogames/gmext-firebase/blob/main/docs/Guides_Crashlytics.md

This function is used to trigger a test crash, which is necessary for verifying the Firebase Crashlytics setup. It's essential for the Firebase console to detect a crash report. Ensure you unplug your device before running this to avoid issues.

```gml
FirebaseCrashlytics_Crash();
```

--------------------------------

### Initialize Firebase Extension (JavaScript)

Source: https://github.com/yoyogames/gmext-firebase/blob/main/source/Firebase_gml/extensions/FirebaseSetup/docs/404.html

This snippet demonstrates how to initialize the Firebase extension within a GameMaker project using JavaScript. It typically involves setting up the base URL for the extension's assets.

```javascript
var base_url = "/";
jQuery(function () {
    SphinxRtdTheme.Navigation.enable(true);
});
```

--------------------------------

### Enable Navigation

Source: https://github.com/yoyogames/gmext-firebase/blob/main/source/Firebase_gml/extensions/GooglePlayServices/docs/404.html

This JavaScript code snippet initializes the navigation functionality for the Sphinx documentation theme. It's commonly found in themes built with Sphinx and Read the Docs.

```javascript
var base_url = "/"; jQuery(function () { SphinxRtdTheme.Navigation.enable(true); });
```

--------------------------------

### FirebaseFirestore Constructor

Source: https://github.com/yoyogames/gmext-firebase/blob/main/source/Firebase_gml/extensions/FirebaseSetup/docs/firestore.html

Initializes a database reference for Firebase Firestore. This is the entry point for all database interactions and returns a dbReference object that supports chained method calls.

```APIDOC
## FirebaseFirestore()

### Description
This function is the entry point for database interactions using the Firebase Firestore extension. It returns a [dbReference](firestore.html#dbreference) that can further be modified and configured using chained methods.

### Method
Constructor

### Endpoint
N/A (Constructor)

### Parameters
#### Path Parameters
None

#### Query Parameters
None

#### Request Body
None

### Request Example
```javascript
// Example of creating a dbReference to a specific path
var _dbRef = FirebaseFirestore("users/user123");
```

### Response
#### Success Response
- **dbReference** (object) - A reference object pointing to the specified database path.
```

--------------------------------

### Initialize Firebase Realtime Database and Set Data - GML

Source: https://github.com/yoyogames/gmext-firebase/blob/main/source/Firebase_gml/extensions/FirebaseSetup/docs/realtime.html

Initializes the Firebase Realtime Database and sets a value at a specified path. It utilizes a fluent API for chaining operations. Dependencies include the Firebase extension. It takes an optional database URL and a path, returning a dbEntryRef that can be further manipulated.

```gml
FirebaseRealTime().Path("players/hero/hp").Set(100);

FirebaseRealTime(dbUrl).Path("players/hero/hp").Set(100);
```

--------------------------------

### Filtering Data: Start At

Source: https://github.com/yoyogames/gmext-firebase/blob/main/source/Firebase_gml/extensions/FirebaseSetup/docs/realtime.html

Sets a filter to retrieve data that starts at a specific value. This is used in conjunction with `OrderBy` functions for querying ranges of data.

```gml
dbEntryRef.StartAt(value);
```

--------------------------------

### Setting Up a Realtime Listener

Source: https://github.com/yoyogames/gmext-firebase/blob/main/source/Firebase_gml/extensions/FirebaseSetup/docs/realtime.html

Establishes a listener to receive real-time updates for data at the current reference. The provided callback function will be executed whenever the data changes. Multiple listeners can be active simultaneously.

```gml
dbEntryRef.Listener(callback_function);
```

--------------------------------

### Send Unsent Reports if Previous Crash - Example (GML)

Source: https://github.com/yoyogames/gmext-firebase/wiki/Crashlytics

An example demonstrating how to check if a previous crash occurred and, if so, send all pending crash reports to the Crashlytics servers. This uses FirebaseCrashlytics_DidCrashOnPreviousExecution and FirebaseCrashlytics_UnsentReports_Send.

```gml
if (FirebaseCrashlytics_DidCrashOnPreviousExecution()) {
     FirebaseCrashlytics_UnsentReports_Send();
}
```

--------------------------------

### Path

Source: https://github.com/yoyogames/gmext-firebase/blob/main/source/Firebase_gml/extensions/FirebaseSetup/docs/realtime.html

Attaches a path reference to the current database entry.

```APIDOC
## POST /firebase/realtime/path

### Description
This method attaches a path reference to the current database's `<dbEntryRef>` struct. Paths are a representation of references in the database (e.g., the path to get 'Opera X YoYoGames' is 'Testing/String').

### Method
POST

### Endpoint
/firebase/realtime/path

### Parameters
#### Path Parameters
None

#### Query Parameters
None

#### Request Body
- **path** (String) - Required - The path reference to the database entry.

### Request Example
```json
{
  "path": "Testing/String"
}
```

### Response
#### Success Response (200)
- **dbEntryRef** (Object) - The updated dbEntryRef struct with the attached path.

#### Response Example
```json
{
  "dbEntryRef": {
    "path": "Testing/String"
  }
}
```
```

--------------------------------

### Example: Toggle Crashlytics Data Collection (GML)

Source: https://github.com/yoyogames/gmext-firebase/wiki/Crashlytics

This example demonstrates how to check the current status of Crashlytics automatic data collection using FirebaseCrashlytics_CrashlyticsCollectionEnabled_Check() and then disable it if it is currently enabled using FirebaseCrashlytics_CrashlyticsCollectionEnabled_Set(false).

```gml
if (FirebaseCrashlytics_CrashlyticsCollectionEnabled_Check())
{
    FirebaseCrashlytics_CrashlyticsCollectionEnabled_Set(false);
}
```

--------------------------------

### Stop Firebase Performance Trace (GameMaker Language)

Source: https://github.com/yoyogames/gmext-firebase/blob/main/source/Firebase_gml/extensions/FirebaseSetup/docs/performance.html

This function stops a Firebase performance trace that was previously started. It requires the trace name as a string argument. Ensure the trace is started before attempting to stop it. This function does not return any value.

```gml
FirebasePerformance_Trace_Stop(TraceName);
```

--------------------------------

### FirebaseStorage_Download Function

Source: https://github.com/yoyogames/gmext-firebase/wiki/cloud_storage

Details on how to use the FirebaseStorage_Download function, including its syntax, parameters, return values, and triggered events.

```APIDOC
## FirebaseStorage_Download

### Description
This function is used to download files from a remote path and returns a listener identifier that can be used for tracking progress on the request. This function operates asynchronously and will trigger the Social Async Event upon completion.

> [!WARNING]
> This function is not available on the Web target.

### Method
N/A (GML Function)

### Endpoint
N/A (GML Function)

### Parameters
#### Path Parameters
None

#### Query Parameters
None

#### Request Body
None

### Parameters Table
|Argument|Type|Description|
|----|----|----|
|localPath|String|The local path where the files will be downloaded|
|firebasePath|String|The remote path on the Firebase Cloud Storage server|
|bucket|String|Other Firebase Storage bucket|

### Request Example
```gml
var _uid = FirebaseAuthentication_GetUID();
listenerId = FirebaseStorage_Download("profilePic.png", "UserProfiles/" + _uid + "/img.png");
```

### Response
#### Success Response (200)
Returns a Real number representing the asynchronous listener ID.

#### Response Example
```gml
listenerId = 12345;
```

### Triggers
#### Social Async Event
This event is triggered upon completion of the download. The `async_load` map will contain the following keys:

|Key|Type|Description|
|----|----|----|
|type|String|The string \"FirebaseStorage_Download\"|
|listener|Real|The asynchronous listener ID.|
|path|String|The remote file path.|
|localPath|String|The local file path.|
|success|Boolean|Whether or not the download succeeded (if finished)|
|error|String|A string describing the error that occurred (if any)|
|transferred|Real|Number of transferred bytes (if NOT finished)|
|total|Real|Total number of bytes (if NOT finished)|

### Example Usage in Async Event
```gml
if (async_load[? "type"] == "FirebaseStorage_Download")
{
    if (ds_map_exists(async_load[? "success"]))
    {
        if (async_load[? "success"])
        {
            global.percent = 100;
            img = sprite_add(async_load[?"localPath"], 0, 0, 0, 0, 0);
            show_message_async("Download SUCCESS");
        }
        else
        {
            global.percent = 0;
            show_message_async("Download FAILED");
        }
    }
    else
    {
        global.percent = 100 * async_load[? "transferred"] / async_load[? "total"];
    }
}
```

> [!NOTE]
> Always remember to free sprites added this way when you no longer need them (using `sprite_delete`), otherwise it can lead to memory leaks.
```

--------------------------------

### Firebase Configuration Struct (JavaScript)

Source: https://github.com/yoyogames/gmext-firebase/blob/main/docs/Platform_Setup.md

This is the structure for your Firebase configuration, which needs to be pasted into the Firebase Config Struct extension option. It contains various keys like apiKey, authDomain, and projectId. Ensure all double quotes are replaced with single quotes before pasting.

```javascript
{
  apiKey: 'xxxxxxxx',
  authDomain: 'xxxxxxxx.firebaseapp.com',
  databaseURL: 'xxxxxxxx',
  projectId: 'xxxxxxxx',
  storageBucket: 'xxxxxxxx',
  messagingSenderId: 'xxxxxxxx',
  appId: 'xxxxxxxx',
  measurementId: 'xxxxxxxx'
}
```

--------------------------------

### Example: Log Current Room Name (GML)

Source: https://github.com/yoyogames/gmext-firebase/wiki/Crashlytics

This example shows how to log the name of the current room to the Crashlytics report. This can be useful for pinpointing the context of an error. The message is created by concatenating a string literal with the result of room_get_name(room).

```gml
FirebaseCrashlytics_Log("Entered the " + room_get_name(room) + " room");
```

--------------------------------

### Filter Firestore Query Results to Start At a Specific Value

Source: https://github.com/yoyogames/gmext-firebase/wiki/Firestore

Applies a filter to a Firebase Firestore query to specify the starting value for the results. This method is used in conjunction with .OrderBy() to ensure that the query returns documents from a certain point onwards, based on the specified field and order.

```gml
listenerId = FirebaseFirestore("myCollection").OrderBy("Points", "ASCENDING").StartAt(10).Query();
```

--------------------------------

### Sign up a new user with email and password using Firebase Authentication

Source: https://github.com/yoyogames/gmext-firebase/blob/main/source/Firebase_gml/extensions/FirebaseSetup/docs/authentication.html

This function signs up a new user with an email and password for email-based authentication. It returns a listener identifier to track the request's progress. The function operates asynchronously, triggering a Social Async Event when complete. It requires the user's email and a chosen password.

```GML
FirebaseAuthentication_SignUp_Email(email, pass);
```

--------------------------------

### Manage HTTP Metrics Attributes and State

Source: https://github.com/yoyogames/gmext-firebase/blob/main/source/Firebase_gml/extensions/FirebaseSetup/docs/performance.html

These functions allow you to manage attributes for HTTP metrics, set payload sizes, response content types, HTTP response codes, and control the start and stop times of HTTP metric collection. Attributes are key-value pairs associated with a metric. The start and stop functions are crucial for timing network requests.

```gml
FirebasePerformance_HttpMetric_Attribute_Put(httpMetric,"key1","value1");
FirebasePerformance_HttpMetric_Attribute_Put(httpMetric,"key2","value2");
show_debug_message(FirebasePerformance_HttpMetric_Attribute_Get(httpMetric));
FirebasePerformance_HttpMetric_SetRequestPayloadSize(httpMetric,100);
FirebasePerformance_HttpMetric_SetResponseContentType(httpMetric,"text/html"); //, application/json, etc.
FirebasePerformance_HttpMetric_SetResponsePayloadSize(httpMetric,100);
FirebasePerformance_HttpMetric_SetHttpResponseCode(httpMetric,200);
FirebasePerformance_HttpMetric_Start(httpMetric);

//After some time
FirebasePerformance_HttpMetric_Stop(httpMetric);
```

--------------------------------

### Firebase Realtime Database Initialization and Set

Source: https://github.com/yoyogames/gmext-firebase/wiki/Realtime

Initializes a database entry reference and sets its value. It can use a default database or a custom URL. The function utilizes chained methods for path specification and value setting.

```gml
FirebaseRealTime().Path("players/hero/hp").Set(100);

// Using a custom database URL
FirebaseRealTime(dbUrl).Path("players/hero/hp").Set(100);
```

--------------------------------

### GooglePlayServices_Leaderboard_LoadPlayerCenteredScores

Source: https://github.com/yoyogames/gmext-firebase/blob/main/source/Firebase_gml/extensions/GooglePlayServices/docs/leaderboards.html

Starts a query for player-centered leaderboard entries. Results are handled in the Social Async Event.

```APIDOC
## GooglePlayServices_Leaderboard_LoadPlayerCenteredScores

### Description
This function starts a query for player-centered leaderboard entries. The results are caught in the Social Async Event.

### Method
`GooglePlayServices_Leaderboard_LoadPlayerCenteredScores`

### Endpoint
N/A (Function Call)

### Parameters
#### Path Parameters
None

#### Query Parameters
None

#### Request Body
None

### Request Example
```
GooglePlayServices_Leaderboard_LoadPlayerCenteredScores(Leaderboard1, Leaderboard_TIME_SPAN_ALL_TIME, Leaderboard_COLLECTION_PUBLIC, 5, true)
```

### Response
#### Success Response (Async Event)
- **type** (String) - The string "GooglePlayServices_Leaderboard_LoadPlayerCenteredScores"
- **ind** (Real) - The id of the request this callback refers to.
- **data** (String) - A JSON formatted string of an array of LeaderboardEntryJSON. This can be parsed using `json_parse`.

#### Response Example
```json
{
  "type": "GooglePlayServices_Leaderboard_LoadPlayerCenteredScores",
  "ind": 0,
  "data": "[\n  {\"displayRank\": \"1\", \"displayScore\": \"1000\", \"rank\": 1, \"rawScore\": 1000, \"scoreHolder\": \"player1_id\", \"scoreHolderDisplayName\": \"PlayerOne\", \"scoreHolderHiResImageUri\": \"uri_hires\", \"scoreHolderIconImageUri\": \"uri_icon\", \"timestampMillis\": 1678886400000}\n]"
}
```
```

--------------------------------

### Initialize MkDocs Page Variables

Source: https://github.com/yoyogames/gmext-firebase/blob/main/source/Firebase_gml/extensions/GoogleSignIn/docs/_footer.html

These JavaScript variables are used by MkDocs to manage the current page's metadata, including its name, input path, and URL. They are essential for MkDocs to correctly render and navigate the documentation site.

```javascript
var mkdocs_page_name = " footer";
var mkdocs_page_input_path = "_footer.md";
var mkdocs_page_url = null;
```

--------------------------------

### Set

Source: https://github.com/yoyogames/gmext-firebase/blob/main/source/Firebase_gml/extensions/FirebaseSetup/docs/firestore.html

Creates or overwrites a document on the database. Operates asynchronously.

```APIDOC
## Set

### Description
This method creates or overwrites a document on the database. If <dbReference> is a collection, a document with an auto-generated name will be created. This function returns a listener identifier and operates asynchronously, triggering the Social Async Event upon completion.

### Method
Call

### Endpoint
N/A (Method Call on dbReference)

### Parameters
#### Request Body
- **json** (String) - A JSON formatted string representing the data to set.

### Request Example
```javascript
// Example for setting a document
var dataToSet = {
    "name": "John Doe",
    "age": 30
};
FirebaseFirestore("users/user123").Set(json_encode(dataToSet));

// Example for creating a document in a collection (auto-generated ID)
var newData = {
    "product": "Laptop",
    "price": 1200
};
FirebaseFirestore("products").Set(json_encode(newData));
```

### Response
#### Success Response (200)
Returns a Real (listener identifier).

#### Response Example
```javascript
// listenerId is a Real number
```

### Triggers
[Social Async Event](https://manual.gamemaker.io/monthly/en/The_Asset_Editors/Object_Properties/Async_Events/Social.htm)

#### Async Event Data
- **type** (String): "FirebaseFirestore_Document_Write" or "FirebaseFirestore_Collection_Write"
- **listener** (Real): The asynchronous listener ID.
- **path** (String): The path of the database reference.
- **status** (Real): The HTTP status response code.
- **errorMessage** (String): A readable error message.
```
Tokens:
Raw