You signed in with another tab or window. Reload to refresh your session.You signed out in another tab or window. Reload to refresh your session.You switched accounts on another tab or window. Reload to refresh your session.Dismiss alert
> **Note:** Use this plugin with the [@nativescript/firebase-core](../firebase-core/) plugin to initialize Firebase in your app.
8
28
9
-
### What does it do?
10
29
11
-
Firebase Authentication provides backend services & easy-to-use SDKs to authenticate users to your app. It supports authentication using passwords, phone numbers, popular federated identity providers like Google, Facebook and Twitter, and more.
@@ -25,7 +48,7 @@ import '@nativescript/firebase-auth'; // only needs to be imported 1x
25
48
const auth =firebase().auth();
26
49
```
27
50
28
-
By default, this allows you to interact with Firebase Auth using the default Firebase App used whilst installing Firebase on your platform. If however you'd like to use a secondary Firebase App, pass the secondary app instance when calling the auth method:
51
+
By default, this allows you to interact with Firebase Auth using the default Firebase App used whilst installing Firebase on your platform. If, however, you'd like to use a secondary Firebase App, call the `auth` method with the `FirebaseApp` instance.
Email/Password is a common user sign in method for most applications. This requires the user to provide an email address and secure password. Users can register new accounts with a method called createUserWithEmailAndPassword() or sign in to an existing account with signInWithEmailAndPassword().
97
+
### Create a user account with email and password
79
98
80
-
### Ensure the "Email/Password" sign-in provider is enabled on the Firebase Console.
99
+
> **Note** To authenticate a user with email and password, enable `Email/Password` sign-in provider Firebase Console following the steps below: <br> 1. Go to Firebase Console. <br> 2. Click on your project. <br> 3. On the left sidebar, select `Authentication`. <br> 4. Click on the `Sign-in method` tab. <br> 5. Click on the `Email\password` provider. <br> 5. Turn `Enable` switch on.
81
100
82
-
### Registration
101
+
Next, to create a user account with an email and password, call the `createUserWithEmailAndPassword` method on the FirebaseAuth instance(`firebase().auth()`) passing it the user's email and secure password.
To sign in a user with their registered email and password, call `signInWithEmailAndPassword` method, with the email and password, on `firebase().auth()`
To send an email to the user to request them to verify their email, call the `sendEmailVerification` method on `User` object.
109
132
110
133
```ts
111
134
const user =firebase().auth().currentUser;
@@ -115,7 +138,8 @@ if (user && !user.emailVerified) {
115
138
}
116
139
```
117
140
118
-
### Signing Out
141
+
### Sign a user out
142
+
To sign a user out, call the `signOut` method on `firebase().auth()`.
119
143
120
144
```ts
121
145
firebase().auth().signOut()
@@ -132,26 +156,21 @@ firebase().auth().signOut()
132
156
let signedOut =awaitfirebase().auth().signOut();
133
157
```
134
158
135
-
### Other sign-in methods
136
-
137
-
-[Apple Sign-In.](#Apple)
138
-
-[Facebook Sign-In.](#Facebook)
139
-
-[Twitter Sign-In.](#Twitter)
140
-
-[Google Sign-In.](#Google)
141
-
-[Phone Number Sign-In.](#Phone)
142
-
143
-
#### Apple
159
+
### Sign in a user with Apple
144
160
145
161
Apple announced that any applications using 3rd party login services (such as Facebook, Twitter, Google etc) must also have an Apple Sign-In method. Apple Sign-In is not required for Android devices.
146
162
147
-
Before you begin [configure Sign In with Apple](https://firebase.google.com/docs/auth/ios/apple#configure-sign-in-with-apple) and [enable Apple as a sign-in provider](https://firebase.google.com/docs/auth/ios/apple#enable-apple-as-a-sign-in-provider).
163
+
-Before you begin [configure Sign In with Apple](https://firebase.google.com/docs/auth/ios/apple#configure-sign-in-with-apple) and [enable Apple as a sign-in provider](https://firebase.google.com/docs/auth/ios/apple#enable-apple-as-a-sign-in-provider).
148
164
149
-
Next, ensure that your app have the "Sign in with Apple" capability.
165
+
- Next, ensure that the app has the [Sign in with Apple capability](https://developer.apple.com/documentation/xcode/configuring-sign-in-with-apple#Add-the-Sign-in-with-Apple-capability-to-your-app).
166
+
167
+
- Install the `@nativescript/apple-sign-in` plugin. Use the `signIn` method from the plugin to get the user's credentials from Apple.
168
+
- Create an AuthCredential instance from the user's credentials. Call the `signInWithCredential` method passing it the Apple credentials.
Before getting started setup your [Facebook Developer App](https://developers.facebook.com/apps/) and follow the setup process to enable Facebook Login.
189
+
-Before getting started, follow the steps at [Facebook Developer App](https://developers.facebook.com/apps/)to enable Facebook login and obtain the Facebook `App ID` and `App secret` that you need for setting the Facebook sign-in provider.
172
190
173
-
Ensure the "Facebook" sign-in provider is enabled on the [Firebase Console](https://console.firebase.google.com/u/0/project/_/authentication/providers). with the Facebook App ID and Secret set.
191
+
- Enable the `Facebook sign-in provider` by following the steps below:
192
+
1. Go to [Firebase Console](https://console.firebase.google.com).
193
+
2. Click on your project.
194
+
3. On the left sidebar, select `Authentication`.
195
+
4. Click on the `Sign-in method` tab.
196
+
5. Click on the `Facebook` provider.
197
+
6. Switch on `Enable`
198
+
7. Enter your `App ID` and `App secret`, and click on `Save`.
174
199
175
-
A 3rd party library is required to both install the Facebook SDK and trigger the authentication flow.
200
+
- Install the `@nativescript/facebook` plugin and call the `logInWithPermissions` method on the `LoginManager` class to get the user's credentials from Facabook that you pass to Firebase.
> **Note:** Firebase will not set the User.emailVerified property to true if your user logs in with Facebook. Should your user login using a provider that verifies email (e.g. Google sign-in) then this will be set to true.
198
223
199
-
#### Twitter
224
+
###Sign in with Twitter account
200
225
201
-
Ensure the "Twitter" sign-in provider is enabled on the Firebase Console with an API Key and API Secret set.
226
+
- Before you authenticate the user with their Twitter account, follow steps `1-5` at [Before you begin](https://firebase.google.com/docs/auth/android/twitter-login?hl=en&authuser=0#before_you_begin) to enable the `Twitter` sign-in provider.
202
227
203
-
A 3rd party library is required to both install the Twitter SDK and trigger the authentication flow.
228
+
- Install the `@nativescript/twitter` plugin and call the `logIn` method on the `TwitterSignIn` class to get the user's credentials from Twitter, as shown below, that you pass to Firebase.
Ensure that you have setup an OAuth App from your GitHub Developer Settings and that the "GitHub" sign-in provider is enabled on the Firebase Console with the Client ID and Secret are set, with the callback URL set in the GitHub app.
249
+
- Set up a GitHub OAuth App from your GitHub Developer Settings and enable `GitHub` sign-in provider by following steps 1-5 at [Before you begin using GitHub](https://firebase.google.com/docs/auth/android/github-auth?hl=en&authuser=0#before_you_begin)
250
+
A 3rd party library is required to both install the GitHub SDK and trigger the authentication flow. The `credential` method of the `GithubAuthProvider` class achieves that.
225
251
226
-
A 3rd party library is required to both install the GitHub SDK and trigger the authentication flow.
252
+
- Call the `signInWithCredential` method on `firebase().auth()` passing it the GitHub credentials.
Most configuration is already setup when using Google Sign-In with Firebase, however you need to ensure your machine's SHA1 key has been configured for use with Android. You can see how to generate the key on the [Authenticating Your Client documentation](https://developers.google.com/android/guides/client-auth).
264
+
Most configuration is already set up when using Google Sign-In with Firebase. However, you need to ensure your machine's SHA1 key has been configured for use with Android. You can see how to generate the key on the [Authenticating Your Client documentation](https://developers.google.com/android/guides/client-auth).
239
265
266
+
- Install the `nativescript/google-signin` plugin, configure Google Sign-in by calling the `configure` method, sign in the user to their Google account to obtain the ID and access tokens. Pass the obtained tokens to Firebase.
Phone authentication allows users to sign in to Firebase using their phone as the authenticator. An SMS message is sent to the user (using the provided phone number) containing a unique code. Once the code has been authorized, the user is able to sign into Firebase.
283
+
Phone authentication allows users to sign in to Firebase using their phone as the authenticator. An SMS message containing a unique code is sent to the user (using the provided phone number). Once the code has been authorized, the user can sign in into Firebase.
257
284
258
-
> **Note:** Phone numbers that end users provide for authentication will be sent and stored by Google to improve spam and abuse prevention across Google service, including to, but not limited to Firebase. Developers should ensure they have the appropriate end-user consent prior to using the Firebase Authentication phone number sign-in service.authentication
285
+
> **Note:** Phone numbers that end users provide for authentication will be sent and stored by Google to improve spam and abuse prevention across Google services, including , but not limited to Firebase. Developers should ensure they have the appropriate end-user consent prior to using the Firebase Authentication phone number sign-in service.
259
286
260
287
Firebase Phone Authentication is not supported in all countries. Please see their [FAQs](https://firebase.google.com/support/faq/#develop) for more information.
261
288
262
-
#### Setup
289
+
#### Phone number auth setup
263
290
264
291
Before starting with Phone Authentication, ensure you have followed these steps:
265
292
266
293
1. Enable Phone as a Sign-In method in the [Firebase console](https://console.firebase.google.com/u/0/project/_/authentication/providers).
267
294
2.**Android**: If you haven't already set your app's SHA-1 hash in the [Firebase console](https://console.firebase.google.com/), do so. See [Authenticating Your Client](https://developers.google.com/android/guides/client-auth) for information about finding your app's SHA-1 hash.
268
295
3.**iOS**: In Xcode, [enable push notifications](http://help.apple.com/xcode/mac/current/#/devdfd3d04a1) for your project & ensure your APNs authentication key is [configured with Firebase Cloud Messaging (FCM)](https://firebase.google.com/docs/cloud-messaging/ios/certs). To view an in-depth explanation of this step, view the [Firebase iOS Phone Auth](https://firebase.google.com/docs/auth/ios/phone-auth) documentation.
269
296
270
-
**Note**; Phone number sign-in is only available for use on real devices and the web. To test your authentication flow on device emulators, please see Testing.
297
+
**Note**; Phone number sign-in is only available for use on real devices and the web. To test your authentication flow on device emulators, please see [Testing](#testing).
271
298
272
-
### Usage
273
299
274
-
#### verifyPhoneNumber
300
+
#### Sign in user with phone number
275
301
276
-
The user's phone number must be first verified and then the user can either sign-in or link their account with a PhoneAuthCredential.
302
+
The user's phone number must be first verified before the user can either signin or link their account with a PhoneAuthCredential. Verify the phone number by calling the `verifyPhoneNumber` method with the number. Once the number is verified, pass the verification id and code to Firebase.
Firebase provides support for locally testing phone numbers:
293
319
294
-
On the Firebase Console, select the "Phone" authentication provider and click on the "Phone numbers for testing" dropdown.
295
-
Enter a new phone number (e.g. +44 7444 555666) and a test code (e.g. 123456).
296
-
If providing a test phone number to either the verifyPhoneNumber or signInWithPhoneNumber methods, no SMS will actually be sent. You can instead provide the test code directly to the PhoneAuthProvider or with signInWithPhoneNumbers confirmation result handler.
320
+
- On the Firebase Console, enable the "Phone" authentication provider and click on the "Phone numbers for testing" dropdown by following the steps at []().
321
+
322
+
- Enter a new phone number (e.g. +44 7444 555666) and a test code (e.g. 123456).
323
+
If providing a test phone number to either the `verifyPhoneNumber` or `signInWithPhoneNumber` methods, no SMS will be sent. You can instead provide the test code directly to the `PhoneAuthProvider` or with `signInWithPhoneNumbers` confirmation result handler.
0 commit comments