FirebasePlus - Authenticate and manage your realtime database

[Patryk_F]

Overview

FirebasePlus is an extension for managing Authentication and the Realtime Database in Google Firebase. This extension does not work with Companion. It can only be used in compiled apps.
The minimum Android API level for this extension is 16 (Android 4.1).
Extension compiled with Rush. Thanks @shreyash .

Any suggestions for new blocks and modifications are welcome. If you encounter any errors, please report them in this thread.

Table of Contents

• Initialization

  • Initiate

• Authentication

  • SignInWithGoogle
  • SignUpWithEmail
  • SignInWithEmail
  • SendVerificationEmail
  • SendPasswordResetEmail
  • SignInWithPhone
  • VerifyPhoneNumberWithCode
  • ResendVerificationSms
  • GetUserData
  • IsSignedIn
  • SignOut
  • ConnectionTags

• Realtime Database

  • AddData
  • SetData
  • UpdateData
  • GetData
  • GetDataWithKeyValue
  • AddBucketChangeListener
  • RemoveBucketChangeListener
  • AddChildChangeListener
  • RemoveChildChangeListener
  • RemoveData

• Events

  • OnError
  • SignedIn
  • EmailSent
  • VeryficationSmsSent
  • SignedOut
  • Saved
  • BucketChanged
  • ChildChanged
  • GotData
  • Removed
  • GotUserData

• Download

Initialization

Summary

To use the FirebasePlus extension, you need to initiate a connection to the database. You'll need to provide the projectId, apiKey, databaseUrl, and oAuthId.

Initiate

Initiate a connection to the database.

• Parameters:
  • projectId (text): The Firebase project ID ("project_id" from google-services.json).
  • apiKey (text): The API key for your Firebase project ("current_key" from google-services.json).
  • databaseUrl (text): The URL of your Firebase Realtime Database ("firebase_url" from google-services.json).
  • oAuthId (text): The OAuth ID for your Firebase project. Only required if signed in with a Google account ("client_id"{"client_type" : 3} from google-services.json).

Authentication

Summary

FirebasePlus provides various methods for user authentication.

SignInWithGoogle

Sign in with a Google account.

• Parameters:
  • (No parameters)

SignUpWithEmail

Create an account using email and password.

• Parameters:
  • email (text): The user's email address.
  • password (text): The user's password.
  • verify (boolean): A flag indicating whether the email should be verified.

SignInWithEmail

Sign in to your account using your email and password.

• Parameters:
  • email (text): The user's email address.
  • password (text): The user's password.

SendVerificationEmail

Sends a verification link to the user's email.

• Parameters:
  • (No parameters)

SendPasswordResetEmail

Send an email with a link to change the user's password.

• Parameters:
  • email (text): The user's email address.

SignInWithPhone

Sign in with the user's phone number.

• Parameters:
  • phoneNumber (text): The user's phone number.

VerifyPhoneNumberWithCode

Verify the user's phone number with the code received via SMS.

• Parameters:
  • code (text): The verification code received via SMS.

ResendVerificationSms

Send the SMS with the verification code again.

• Parameters:
  • (No parameters)

GetUserData

Get registered user details.

• Parameters:
  • (No parameters)

IsSignedIn

Check if the user is signed in.

• Parameters:

  • (No parameters)

• Return Type:

  • boolean

SignOut

Sign out the user.

• Parameters:
  • (No parameters)

ConnectionTags

Adds the user's connection tags to the given bucket ("connected": false, "timeStamp": 1698834723731).

• Parameters:
  • bucket (text): The name of the bucket.

Realtime Database

Summary

FirebasePlus allows you to interact with the Realtime Database.

AddData

Adds data in JSON format in the given bucket, to a randomly generated key.

• Parameters:
  • bucket (text): The path to the bucket.
  • json (text): The JSON data to add.

SetData

Sets the data in JSON format in the provided bucket, removing anything that is not in the data.

• Parameters:
  • bucket (text): The path to the bucket.
  • json (text): The JSON data to set.

UpdateData

Updates the JSON data in the provided bucket without changing anything that is not in the data.

• Parameters:
  • bucket (text): The path to the bucket.
  • json (text): The JSON data to update.

GetData

Get data from the given bucket.

• Parameters:
  • bucket (text): The path to the bucket to retrieve data from.

GetDataWithKeyValue

Get data from the given bucket that contains the given key with the given value.

• Parameters:
  • bucket (text): The path to the bucket to retrieve data from.
  • key (text): The key to search for in the data.
  • value (any): The value to match for the key.

AddBucketChangeListener

Add a listener for the bucket, when changing data, all data from a given bucket will be downloaded.

• Parameters:
  • bucket (text): The path to the bucket to add the listener to.

RemoveBucketChangeListener

Removes a listener in the specified bucket that was added using AddBucketChangeListener.

• Parameters:
  • bucket (text): The path to the bucket to remove the listener from.

AddChildChangeListener

Add a listener for the bucket, when changing data, only the data that has been changed will be downloaded.

• Parameters:
  • bucket (text): The path to the bucket to add the listener to.

RemoveChildChangeListener

Removes a listener in the specified bucket that was added using AddChildChangeListener.

• Parameters:
  • bucket (text): The path to the bucket to remove the listener from.

RemoveData

Deletes data from the given bucket.

• Parameters:
  • bucket (text): The path to the bucket to remove data from.

Events

Summary

FirebasePlus triggers various events that you can listen to.

OnError

Will trigger when an error occurs.

• Parameters:
  • error (text): A message describing the error.

SignedIn

Will be triggered when the user signs in or signs up.

• Parameters:
  • userId (text): The user's unique ID.
  • providerId (text): The provider used for signing in.
  • verified (boolean): A flag indicating whether the user's email is verified.

EmailSent

Will be triggered This text will be hiddenwhen a verification or password reset email is sent.

• Parameters:
  • type (text): The type of email sent (verification or password reset).

VerificationSmsSent

Will be triggered when an SMS with a verification code is sent.

• Parameters:
  • (No parameters)

SignedOut

Will be triggered when the user signs out.

• Parameters:
  • (No parameters)

Saved

Will trigger when data is written using any method.

• Parameters:
  • (No parameters)

BucketChanged

Will trigger when data observed via AddBucketChangeListener is changed.

• Parameters:
  • key (text): The key of the data that changed.
  • value (any): The new value of the data.
  • bucket (text): The name of the bucket where the change occurred.

ChildChanged

Will trigger when data observed via AddChildChangeListener is changed.

• Parameters:
  • key (text): The key of the data that changed.
  • value (any): The new value of the data.
  • bucket (text): The name of the bucket where the change occurred.

GotData

Will trigger when data is retrieved via any method.

• Parameters:
  • value (any): The retrieved data.

Removed

Will trigger when data is successfully removed using the RemoveData method.

• Parameters:
  • (No parameters)

GotUserData

Will be triggered when the signed-in user's data is received.

• Parameters:
  • userId (text): The user's unique ID.
  • email (text): The user's email address.
  • name (text): The user's name.
  • photo (text): The URL of the user's photo.
  • phoneNumber (text): The user's phone number.
  • verified (boolean): A flag indicating whether the user's email is verified.

Download

Version 1.0.0, date 05/11/2023.

AIX

Extension file.

• pl.patryk_f.firebaseplus.aix (2.0 MB)

AIA

Sample project.

[ShanmugaNathan2023]

Thanks for making this extension,

Especially providing it free for all users.

[Patryk_F]

I hope this helps someone. If anyone is missing any methods, please write and I will try to add them.

[TIMAI2]

Firebase Storage: Upload,Download,Delete,List
Firestore

[Patryk_F]

Do you mean file storage support? Storage?

[TIMAI2]

Yes I do

and for Firestore, well that is a whole new world that no-one seems to go near

[Patryk_F]

@TIMAI2

and for Firestore, well that is a whole new world that no-one seems to go near

Cloud Firestore?

[TIMAI2]

Firebase Cloud Firestore

[Patryk_F]

I think I can add support for this database. I just need to read the documentation on how to use this database.

[ShanmugaNathan2023]

@Patryk_F

SignInWithPhone

I tried only Phone Number Sign in as of now, it shows this error.

[Patryk_F]

You didn't show your blocks. Sample project continues to build. You probably didn't initialize the extension using the Initiate block.

[ShanmugaNathan2023]

Made mobile number empty only to show you the blocks

[Patryk_F]

Are you testing in APK?

[ShanmugaNathan2023]

yes,
Do i need to upload google-services.json to assets

[Patryk_F]

No. I tested it and it worked, maybe I messed something up when cleaning the code or the build optimization messed something up. I'll be back here in some time.

[ShanmugaNathan2023]

Yes, Gmail,Email Authentication also have some issues,

@Patryk_F

I messed something up when cleaning the code or the build optimization messed something up

I too think that something messed up as blocks works but not correct

[Patryk_F]

Your IDs, although not fully visible, seem strange. Example identifiers should look like this:

projectId: free-messenger-da78f
apiKey: AIzaSyCUeXrBuskFo5lez3HNUwCMX0AloNYVS-g
databaseUrl: https://free-messenger-da78f-default-rtdb.firebaseio.com/
oAuthId: 424506119191-jo225krnmkl17vb4gmv9a2r3pt021joq.apps.googleusercontent.com

Also, for the phone number method to work, you must add the correct package name of your app and SHA certificate fingerprints in the firebase project. You also need to add appropriate authorization methods in the firebase project.

I tested the extension on android9 and it works fine. I'll test it on Android 10 soon. Unfortunately, I don't have a newer version of Android to test.

[ShanmugaNathan2023]

i can’t DM you,

@Patryk_F

Also, for the phone number method to work, you must add the correct package name of your app and SHA certificate fingerprints in the firebase project. You also need to add appropriate authorization methods in the firebase project.

All above done correctly.

@Patryk_F

oAuthId

This is different what i put, let me know where to get the ID

[Patryk_F]

@Patryk_F

oAuthId (text): The OAuth ID for your Firebase project. Only required if signed in with a Google account ("client_id"{"client_type" : 3} from google-services.json).

If you added the appropriate authorization methods in firebase, you should have this ID in google-services.json

[ShanmugaNathan2023]

Yes it EXITS while calling Any Sign-in methods,

I think you need to update the extension