aboutsummaryrefslogtreecommitdiffhomepage
path: root/Firebase/Auth/Source/AuthProviders/Phone
diff options
context:
space:
mode:
authorGravatar Zsika Phillip <protocol86@users.noreply.github.com>2017-09-15 14:54:11 -0700
committerGravatar GitHub <noreply@github.com>2017-09-15 14:54:11 -0700
commit7dc124882a987de77de27943357d9259a55ec0d2 (patch)
treebac42ab9fb3d6c053292c6fedb420e122a14bce5 /Firebase/Auth/Source/AuthProviders/Phone
parentf0442122d37dd0918655af97c0ee8a113b158d99 (diff)
Add missing comments (#273)
* Small code clean-up changes * Fixes typos * Addresses comment
Diffstat (limited to 'Firebase/Auth/Source/AuthProviders/Phone')
-rw-r--r--Firebase/Auth/Source/AuthProviders/Phone/FIRPhoneAuthProvider.m13
1 files changed, 13 insertions, 0 deletions
diff --git a/Firebase/Auth/Source/AuthProviders/Phone/FIRPhoneAuthProvider.m b/Firebase/Auth/Source/AuthProviders/Phone/FIRPhoneAuthProvider.m
index 3a098a5..5d22fc4 100644
--- a/Firebase/Auth/Source/AuthProviders/Phone/FIRPhoneAuthProvider.m
+++ b/Firebase/Auth/Source/AuthProviders/Phone/FIRPhoneAuthProvider.m
@@ -429,6 +429,13 @@ NSString *const kReCAPTCHAURLStringFormat = @"https://%@/__/auth/handler?%@";
}];
}
+/** @fn reCAPTCHAURLWithEventID:completion:
+ @brief Constructs a URL used for opening a reCAPTCHA app verification flow using a given event
+ ID.
+ @param eventID The event ID used for this purpose.
+ @param completion The callback invoked after the URL has been constructed or an error
+ has been encountered.
+ */
- (void)reCAPTCHAURLWithEventID:(NSString *)eventID completion:(FIRReCAPTCHAURLCallBack)completion {
[self fetchAuthDomainWithCompletion:^(NSString *_Nullable authDomain,
NSError *_Nullable error) {
@@ -457,6 +464,12 @@ NSString *const kReCAPTCHAURLStringFormat = @"https://%@/__/auth/handler?%@";
}];
}
+
+/** @fn fetchAuthDomainWithCompletion:completion:
+ @brief Fetches the auth domain associated with the Firebase Project.
+ @param completion The callback invoked after the auth domain has been constructed or an error
+ has been encountered.
+ */
- (void)fetchAuthDomainWithCompletion:(FIRFetchAuthDomainCallback)completion {
FIRGetProjectConfigRequest *request =
[[FIRGetProjectConfigRequest alloc] initWithRequestConfiguration:_auth.requestConfiguration];