FirebaseAuth

The FirebaseAuth item allows user registration and authentication with the email/password authentication provider. More...

Import Statement: import VPlayPlugins 1.0
Inherits:

PluginItem

Properties

Signals

Methods

Detailed Description

Note: Check out the Firebase Plugin page for more examples!

Property Documentation

authenticated : bool

Readonly property returning true if the user is authenticated, false otherwise.


config : FirebaseConfig

This property defines the account configuration to use for this item. It includes the Firebase project ID, app ID, API key, database URL and more.

To use the default Firebase account defined in google-services.json and GoogleService-info.plist, do not assign this property or assign null.


email : string

Readonly property returning the email address of the user, if authenticated.


userId : string

Readonly property returning the userId of the authenticated user.


userToken : string

Readonly property returning the ID token of the authenticated user.


Signal Documentation

loggedIn(bool success, string message)

This signal gets emitted after the loginUser request has finished.

The success parameter is true, if the login succeeds. Otherwise, it's false. In this case, the message parameter contains an error description.

See also FirebaseAuth::loginUser.


passwordResetEmailSent(bool success, string message)

This signal gets emitted after the sendPasswordResetEmail request has finished.

The success parameter is true, if the E-Mail was successfully sent. Otherwise, it's false. In this case, the message parameter contains an error description.

See also FirebaseAuth::sendPasswordResetEmail.


userRegistered(bool success, string message)

This signal gets emitted after the registerUser request has finished.

The success parameter is true, if the registration succeeds. Otherwise, it's false. In this case, the message parameter contains an error description.

See also FirebaseAuth::registerUser.


Method Documentation

void loginUser(string email, string password)

Logs in a user with the provided email and password. After completion, the FirebaseAuth::loggedIn signal gets emitted.

See also FirebaseAuth::loggedIn.


void logoutUser()

Logs a user out. This method always succeeds.


void registerUser(string email, string password)

Registers a user with the provided email and password. After completion, the FirebaseAuth::userRegistered signal gets emitted.

See also FirebaseAuth::userRegistered.


void sendPasswordResetEmail(string email)

Sends an e-mail to the user with a link to reset the password. The password-reset process is handled by Firebase.

To customize the content of the e-mail, go to the the Firebase Console, open your app and click Authentication -> E-Mail Templates.


Voted #1 for:

  • Easiest to learn
  • Most time saving
  • Best support

Develop Cross-Platform Apps and Games 50% Faster!

  • Voted the best supported, most time-saving and easiest to learn cross-platform development tool
  • Based on the Qt framework, with native performance and appearance on all platforms including iOS and Android
  • Offers a variety of plugins to monetize, analyze and engage users
FREE!
create apps
create games
cross platform
native performance
3rd party services
game network
multiplayer
level editor
easiest to learn
biggest time saving
best support