firebase user provider data? #196

Author: EddyVerbruggen

docs/AUTHENTICATION.md

@@ -13,6 +13,21 @@ You can sign in a user either
 
 Each of these login mechanisms need to be enabled in your Firebase console at the 'Login & Auth' tab.
 
+## What's returned when logging in?
+All login functions below, as well as `getCurrentUser` return a 'User' object with these properties:
+
+|param|optional|description
+|---|---|---
+|`uid`|no|The Firebase User ID
+|`email`|yes|Not all providers require an email address
+|`emailVerified`|no|You can send an email with a verification link which this refers to
+|`name`|yes|The name stored at the provider
+|`anonymous`|no|Whether or not the user logged in anonymously
+|`profileImageURL`|yes|A string containing a link to a user image on the web
+|`refreshToken`|yes|iOS only
+|`providers`|no|An array of {id: value} objects, where value can be 'facebook.com', etc
+
+
 ## Functions
 
 ### Listening to auth state changes
@@ -57,6 +72,29 @@ If - for some reason - you want more control over the listener you can use these
   firebase.hasAuthStateListener(listener);
 ```
 
+### Get Current User
+Once the user is logged in you can retrieve the currently logged in user.
+
+##### JavaScript
+```js
+  firebase.getCurrentUser().then(
+    function (result) {
+      console.log(JSON.stringify(result));
+    },
+    function (errorMessage) {
+      console.log(errorMessage);
+    }
+  );
+```
+
+##### TypeScript
+```js
+  firebase.getCurrentUser().then((user) => {
+      alert("User uid: " + user.uid);
+  }, (error) => {
+      alert("Trouble in paradise: " + error);
+  });
+```
 
 ### Anonymous login
 Don't forget to enable anonymous login in your firebase instance.
@@ -67,14 +105,12 @@ Don't forget to enable anonymous login in your firebase instance.
     type: firebase.LoginType.ANONYMOUS
   }).then(
       function (result) {
-        // the result object has these properties ('undefined', depending on the login type):
-        // uid, provider, expiresAtUnixEpochSeconds, profileImageURL, token
-        JSON.stringify(result);
+        console.log(JSON.stringify(result));
       },
       function (errorMessage) {
         console.log(errorMessage);
       }
-  )
+  );
 ```
 
 ##### TypeScript
@@ -98,13 +134,12 @@ Don't forget to enable email-password login in your firebase instance.
     password: 'theirpassword'
   }).then(
       function (result) {
-        // the result object has these properties: uid, provider, expiresAtUnixEpochSeconds, profileImageURL, token
         JSON.stringify(result);
       },
       function (errorMessage) {
         console.log(errorMessage);
       }
-  )
+  );
 ```
 
 #### Managing email-password accounts
@@ -128,7 +163,7 @@ Don't forget to enable email-password login in your firebase instance.
           okButtonText: "OK, got it"
         })
       }
-  )
+  );
 ```
 
 #### Resetting a password
@@ -143,7 +178,7 @@ Don't forget to enable email-password login in your firebase instance.
       function (errorMessage) {
         console.log(errorMessage);
       }
-  )
+  );
 ```
 
 #### Changing a password
@@ -159,7 +194,7 @@ Don't forget to enable email-password login in your firebase instance.
       function (errorMessage) {
         console.log(errorMessage);
       }
-  )
+  );
 ```
 
 ### Custom login
@@ -173,13 +208,12 @@ Use this login type to authenticate against firebase using a token generated by
     token: token
   }).then(
       function (result) {
-        // the result object has these properties: uid, provider, expiresAtUnixEpochSeconds, profileImageURL, token
         JSON.stringify(result);
       },
       function (errorMessage) {
         console.log(errorMessage);
       }
-  )
+  );
 ```
 
 ### Facebook login
@@ -199,7 +233,7 @@ Then add the following lines to your code and check for setup instructions for y
       function (errorMessage) {
         console.log(errorMessage);
       }
-  )
+  );
 ```
 
 For a complete list of the available scope permissions, visit Facebook's documentation: https://developers.facebook.com/docs/facebook-login/permissions. 
@@ -251,7 +285,7 @@ Then add the following lines to your code and check for setup instructions for y
       function (errorMessage) {
         console.log(errorMessage);
       }
-  )
+  );
 ```
 
 #### iOS
@@ -296,7 +330,6 @@ a Firebase auth token for the currently logged in user.
         console.log("Auth token retrieval error: " + errorMessage);
       }
   );
-
 ```
 
 ### logout