Authentication

The Firebase Authentication module in GodotFirebaseAndroid supports anonymous login, email/password login, Google login, and account management. Each method emits signals to indicate success or failure.

Signals

  • auth_success(current_user_data: Dictionary) Emitted when a user successfully signs in. The dictionary contains user information such as UID, email, etc.

  • auth_failure(error_message: String) Emitted when an authentication operation fails.

  • sign_out_success(success: bool) Emitted after a sign-out operation. true indicates success.

  • password_reset_sent(success: bool) Emitted after attempting to send a password reset email.

  • email_verification_sent(success: bool) Emitted after attempting to send an email verification email.

  • user_deleted(success: bool) Emitted after an attempt to delete the current user.

Methods

sign_in_anonymously()

Signs in the user anonymously.

Emits: auth_success or auth_failure.

Firebase.auth.sign_in_anonymously()

create_user_with_email_password(email: String, password: String)

Creates a new user with the given email and password.

Emits: auth_success or auth_failure.

Firebase.auth.create_user_with_email_password("testuser@email.com", "password123")

sign_in_with_email_password(email: String, password: String)

Signs in a user using email and password credentials.

Emits: auth_success or auth_failure.

Firebase.auth.sign_in_with_email_password("testuser@email.com", "password123")

send_password_reset_email(email: String)

Sends a password reset email to the specified address.

Emits: password_reset_sent. It also emits auth_failure on failure.

Firebase.auth.send_password_reset_email("testuser@email.com")

send_email_verification()

Sends an email verification to the currently signed-in user.

Emits: email_verification_sent. It also emits auth_failure on failure.

Firebase.auth.send_email_verification()

sign_in_with_google()

Signs in the user using Google. Ensure Google Sign-In is properly configured in the Firebase console.

Emits: auth_success or auth_failure.

Firebase.auth.sign_in_with_google()

get_current_user_data() -> Dictionary

If no user is signed in, returns an dictionary with error.

Returns a dictionary containing the currently signed-in user’s data.

Firebase.auth.get_current_user_data()

delete_current_user()

Deletes the currently signed-in user.

Emits: user_deleted. It also emits auth_failure on failure.

Firebase.auth.delete_current_user()

is_signed_in() -> bool

Returns true if a user is currently signed in, otherwise false.

Firebase.auth.is_signed_in()

sign_out()

Signs out the current user.

Emits: sign_out_success. It also emits auth_failure on failure.

Firebase.auth.sign_out()