app_check

App Check

Reference: Firebase App Check

This module adds support for Firebase App Check to your game.

App Check is a Firebase feature used to make sure that requests originate from an authentic instance of your app or from an authentic, untampered device. It works by attaching an attestation to every request made to the Firebase APIs. Requests from clients without a valid attestation will be rejected, as will any request originating from an app or platform you haven't authorised.

Warning

The Debug providers should only be used in debug builds and should never be used in a production version of your game!

Guides

These are the guides for the App Check extension:

• App Check Guide

Functions

These are the functions in the App Check module:

• FirebaseAppCheck_GetToken
• FirebaseAppCheck_LimitedUseToken

---

Back To Top

FirebaseAppCheck_GetToken

This function requests a Firebase App Check token.

Note

This method should be used only if you need to authorise requests to a non-Firebase backend. Requests to Firebase backends are authorised automatically if configured.

This function operates asynchronously, which means that it does not immediately return the requested result. Instead, upon completion of the task, it will trigger the Social Async Event.

Syntax:

FirebaseAppCheck_GetToken(force_refresh)

Argument	Type	Description
force_refresh	Boolean	Whether the token should be refreshed automatically

Returns:

N/A

Triggers:

Social Async Event

Key	Type	Description
type	String	The string "FirebaseAppCheck_GetToken"
success	Boolean	Whether a token could be retrieved successfully
token	String	The token string (only present when success is true)

---

Back To Top

FirebaseAppCheck_LimitedUseToken

This function gets a limited use App Check token intended for use with non-Firebase backend endpoints that are protected with Replay Protection.

This method does not affect the token generation behaviour of the FirebaseAppCheck_GetToken function.

Note

This method should be used only if you need to authorise requests to a non-Firebase backend. Requests to Firebase backends are authorised automatically if configured.

This function operates asynchronously, which means that it does not immediately return the requested result. Instead, upon completion of the task, it will trigger the Social Async Event.

Syntax:

FirebaseAppCheck_LimitedUseToken()

Returns:

N/A

Triggers:

Social Async Event

Key	Type	Description
type	String	The string "FirebaseAppCheck_LimitedUseToken"
success	Boolean	Whether a token could be retrieved successfully
token	String	The token string (only present when success is true)