Added Async suffix to some method names; Updated docs

Author: hiranya911

CHANGELOG.md

@@ -1,7 +1,7 @@
 # Unreleased
 
 - [added] Implemented the `GetUserByEmailAsync()` and `GetUserByPhoneNumberAsync()`
-  APIs in the `FirebaserAuth` class.
+  APIs in the `FirebaseAuth` class.
 
 # v1.5.0
 

FirebaseAdmin/FirebaseAdmin.Tests/Auth/FirebaseUserManagerTest.cs

@@ -45,7 +45,7 @@ public async Task GetUserById()
             };
             var userManager = this.CreateFirebaseUserManager(handler);
 
-            var userRecord = await userManager.GetUserById("user1");
+            var userRecord = await userManager.GetUserByIdAsync("user1");
 
             Assert.Equal("user1", userRecord.Uid);
             Assert.Null(userRecord.DisplayName);
@@ -102,7 +102,7 @@ public async Task GetUserByIdWithProperties()
             };
             var userManager = this.CreateFirebaseUserManager(handler);
 
-            var userRecord = await userManager.GetUserById("user1");
+            var userRecord = await userManager.GetUserByIdAsync("user1");
 
             Assert.Equal("user1", userRecord.Uid);
             Assert.Equal("Test User", userRecord.DisplayName);
@@ -154,22 +154,22 @@ public async Task GetUserByIdUserNotFound()
             var userManager = this.CreateFirebaseUserManager(handler);
 
             var exception = await Assert.ThrowsAsync<FirebaseException>(
-                async () => await userManager.GetUserById("user1"));
+                async () => await userManager.GetUserByIdAsync("user1"));
             Assert.Equal("Failed to get user with uid: user1", exception.Message);
         }
 
         [Fact]
         public async Task GetUserByIdNull()
         {
             var userManager = this.CreateFirebaseUserManager(new MockMessageHandler());
-            await Assert.ThrowsAsync<ArgumentException>(() => userManager.GetUserById(null));
+            await Assert.ThrowsAsync<ArgumentException>(() => userManager.GetUserByIdAsync(null));
         }
 
         [Fact]
         public async Task GetUserByIdEmpty()
         {
             var userManager = this.CreateFirebaseUserManager(new MockMessageHandler());
-            await Assert.ThrowsAsync<ArgumentException>(() => userManager.GetUserById(string.Empty));
+            await Assert.ThrowsAsync<ArgumentException>(() => userManager.GetUserByIdAsync(string.Empty));
         }
 
         [Fact]
@@ -185,7 +185,7 @@ public async Task GetUserByEmail()
             };
             var userManager = this.CreateFirebaseUserManager(handler);
 
-            var userRecord = await userManager.GetUserByEmail("user@example.com");
+            var userRecord = await userManager.GetUserByEmailAsync("user@example.com");
 
             Assert.Equal("user1", userRecord.Uid);
             Assert.Null(userRecord.DisplayName);
@@ -215,22 +215,22 @@ public async Task GetUserByEmailUserNotFound()
             var userManager = this.CreateFirebaseUserManager(handler);
 
             var exception = await Assert.ThrowsAsync<FirebaseException>(
-                async () => await userManager.GetUserByEmail("user@example.com"));
+                async () => await userManager.GetUserByEmailAsync("user@example.com"));
             Assert.Equal("Failed to get user with email: user@example.com", exception.Message);
         }
 
         [Fact]
         public async Task GetUserByEmailNull()
         {
             var userManager = this.CreateFirebaseUserManager(new MockMessageHandler());
-            await Assert.ThrowsAsync<ArgumentException>(() => userManager.GetUserByEmail(null));
+            await Assert.ThrowsAsync<ArgumentException>(() => userManager.GetUserByEmailAsync(null));
         }
 
         [Fact]
         public async Task GetUserByEmailEmpty()
         {
             var userManager = this.CreateFirebaseUserManager(new MockMessageHandler());
-            await Assert.ThrowsAsync<ArgumentException>(() => userManager.GetUserByEmail(string.Empty));
+            await Assert.ThrowsAsync<ArgumentException>(() => userManager.GetUserByEmailAsync(string.Empty));
         }
 
         [Fact]
@@ -246,7 +246,7 @@ public async Task GetUserByPhoneNumber()
             };
             var userManager = this.CreateFirebaseUserManager(handler);
 
-            var userRecord = await userManager.GetUserByPhoneNumber("+1234567890");
+            var userRecord = await userManager.GetUserByPhoneNumberAsync("+1234567890");
 
             Assert.Equal("user1", userRecord.Uid);
             Assert.Null(userRecord.DisplayName);
@@ -276,22 +276,22 @@ public async Task GetUserByPhoneNumberUserNotFound()
             var userManager = this.CreateFirebaseUserManager(handler);
 
             var exception = await Assert.ThrowsAsync<FirebaseException>(
-                async () => await userManager.GetUserByPhoneNumber("+1234567890"));
+                async () => await userManager.GetUserByPhoneNumberAsync("+1234567890"));
             Assert.Equal("Failed to get user with phone number: +1234567890", exception.Message);
         }
 
         [Fact]
         public async Task GetUserByPhoneNumberNull()
         {
             var userManager = this.CreateFirebaseUserManager(new MockMessageHandler());
-            await Assert.ThrowsAsync<ArgumentException>(() => userManager.GetUserByPhoneNumber(null));
+            await Assert.ThrowsAsync<ArgumentException>(() => userManager.GetUserByPhoneNumberAsync(null));
         }
 
         [Fact]
         public async Task GetUserByPhoneNumberEmpty()
         {
             var userManager = this.CreateFirebaseUserManager(new MockMessageHandler());
-            await Assert.ThrowsAsync<ArgumentException>(() => userManager.GetUserByPhoneNumber(string.Empty));
+            await Assert.ThrowsAsync<ArgumentException>(() => userManager.GetUserByPhoneNumberAsync(string.Empty));
         }
 
         [Fact]

FirebaseAdmin/FirebaseAdmin/Auth/FirebaseAuth.cs

@@ -293,7 +293,7 @@ public async Task<UserRecord> GetUserAsync(
         {
             var userManager = this.IfNotDeleted(() => this.userManager.Value);
 
-            return await userManager.GetUserById(uid, cancellationToken);
+            return await userManager.GetUserByIdAsync(uid, cancellationToken);
         }
 
         /// <summary>
@@ -326,7 +326,7 @@ public async Task<UserRecord> GetUserByEmailAsync(
         {
             var userManager = this.IfNotDeleted(() => this.userManager.Value);
 
-            return await userManager.GetUserByEmail(email, cancellationToken);
+            return await userManager.GetUserByEmailAsync(email, cancellationToken);
         }
 
         /// <summary>
@@ -359,7 +359,7 @@ public async Task<UserRecord> GetUserByPhoneNumberAsync(
         {
             var userManager = this.IfNotDeleted(() => this.userManager.Value);
 
-            return await userManager.GetUserByPhoneNumber(phoneNumber, cancellationToken);
+            return await userManager.GetUserByPhoneNumberAsync(phoneNumber, cancellationToken);
         }
 
         /// <summary>

FirebaseAdmin/FirebaseAdmin/Auth/FirebaseUserManager.cs

@@ -73,7 +73,7 @@ internal static FirebaseUserManager Create(FirebaseApp app)
         /// <param name="cancellationToken">A cancellation token to monitor the asynchronous
         /// operation.</param>
         /// <returns>A record of user with the queried id if one exists.</returns>
-        internal async Task<UserRecord> GetUserById(
+        internal async Task<UserRecord> GetUserByIdAsync(
             string uid, CancellationToken cancellationToken = default(CancellationToken))
         {
             if (string.IsNullOrEmpty(uid))
@@ -97,7 +97,7 @@ internal async Task<UserRecord> GetUserById(
         /// <param name="cancellationToken">A cancellation token to monitor the asynchronous
         /// operation.</param>
         /// <returns>A record of user with the queried email if one exists.</returns>
-        internal async Task<UserRecord> GetUserByEmail(
+        internal async Task<UserRecord> GetUserByEmailAsync(
             string email, CancellationToken cancellationToken = default(CancellationToken))
         {
             if (string.IsNullOrEmpty(email))
@@ -120,7 +120,7 @@ internal async Task<UserRecord> GetUserByEmail(
         /// <param name="cancellationToken">A cancellation token to monitor the asynchronous
         /// operation.</param>
         /// <returns>A record of user with the queried phone number if one exists.</returns>
-        internal async Task<UserRecord> GetUserByPhoneNumber(
+        internal async Task<UserRecord> GetUserByPhoneNumberAsync(
             string phoneNumber, CancellationToken cancellationToken = default(CancellationToken))
         {
             if (string.IsNullOrEmpty(phoneNumber))
@@ -249,6 +249,13 @@ private async Task<string> SendAsync(
             }
         }
 
+        /// <summary>
+        /// Represents a query that can be executed against the Firebase Auth service to retrieve user records.
+        /// A query mainly consists of a <see cref="UserQuery.Field"/> and a <see cref="UserQuery.Value"/> (e.g.
+        /// <c>Field = localId</c> and <c>Value = alice</c>). Additionally, a query may also specify a more
+        /// human-readable <see cref="UserQuery.Label"/> for the field, which will appear on any error messages
+        /// produced by the query.
+        /// </summary>
         private class UserQuery
         {
             internal string Field { get; set; }