aboutsummaryrefslogtreecommitdiffhomepage
path: root/Firebase
diff options
context:
space:
mode:
authorGravatar Xiangtian Dai <xiangtian@google.com>2017-08-25 12:01:27 -0700
committerGravatar GitHub <noreply@github.com>2017-08-25 12:01:27 -0700
commit9108a337d6862a9556611ed9f88292cddb5ef1ae (patch)
treede2a3d8a957404aa360fe99e56b4cc61a4291926 /Firebase
parentb1c231d95bbb582154a964091f3b5033dee130b5 (diff)
Updates Auth ChangeLog for the next release. (#216)
Also moves an unused public method into private header.
Diffstat (limited to 'Firebase')
-rw-r--r--Firebase/Auth/CHANGELOG.md3
-rw-r--r--Firebase/Auth/Source/FIRAuth_Internal.h12
-rw-r--r--Firebase/Auth/Source/Public/FIRAuth.h12
3 files changed, 15 insertions, 12 deletions
diff --git a/Firebase/Auth/CHANGELOG.md b/Firebase/Auth/CHANGELOG.md
index 877ce43..7738fb5 100644
--- a/Firebase/Auth/CHANGELOG.md
+++ b/Firebase/Auth/CHANGELOG.md
@@ -1,3 +1,6 @@
+# v4.1.1
+- Improves some method documentation in headers.
+
# v4.1.0
- Allows the app to handle continue URL natively, e.g., from password reset
email.
diff --git a/Firebase/Auth/Source/FIRAuth_Internal.h b/Firebase/Auth/Source/FIRAuth_Internal.h
index c9d210a..d568d45 100644
--- a/Firebase/Auth/Source/FIRAuth_Internal.h
+++ b/Firebase/Auth/Source/FIRAuth_Internal.h
@@ -116,6 +116,18 @@ NS_ASSUME_NONNULL_BEGIN
*/
- (BOOL)signOutByForceWithUserID:(NSString *)userID error:(NSError *_Nullable *_Nullable)error;
+/** @fn canHandleURL:
+ @brief Whether the specific URL is handled by @c FIRAuth .
+ @param url The URL received by the application delegate from any of the openURL method.
+ @return Whether or the URL is handled. YES means the URL is for Firebase Auth
+ so the caller should ignore the URL from further processing, and NO means the
+ the URL is for the app (or another libaray) so the caller should continue handling
+ this URL as usual.
+ @remarks If swizzling is disabled, URLs received by the application delegate must be forwarded
+ to this method for phone number auth to work.
+ */
+- (BOOL)canHandleURL:(nonnull NSURL *)url;
+
@end
NS_ASSUME_NONNULL_END
diff --git a/Firebase/Auth/Source/Public/FIRAuth.h b/Firebase/Auth/Source/Public/FIRAuth.h
index f2b00ae..ad6b635 100644
--- a/Firebase/Auth/Source/Public/FIRAuth.h
+++ b/Firebase/Auth/Source/Public/FIRAuth.h
@@ -684,18 +684,6 @@ FIR_SWIFT_NAME(Auth)
- (BOOL)canHandleNotification:(NSDictionary *)userInfo;
#endif
-/** @fn canHandleURL:
- @brief Whether the specific URL is handled by @c FIRAuth .
- @param url The URL received by the application delegate from any of the openURL method.
- @return Whether or the URL is handled. YES means the URL is for Firebase Auth
- so the caller should ignore the URL from further processing, and NO means the
- the URL is for the app (or another libaray) so the caller should continue handling
- this URL as usual.
- @remarks If swizzling is disabled, URLs received by the application delegate must be forwarded
- to this method for phone number auth to work.
- */
-- (BOOL)canHandleURL:(nonnull NSURL *)url;
-
@end
NS_ASSUME_NONNULL_END