aboutsummaryrefslogtreecommitdiffhomepage
path: root/Interop
diff options
context:
space:
mode:
authorGravatar Ryan Wilson <wilsonryan@google.com>2018-07-11 17:40:25 -0400
committerGravatar GitHub <noreply@github.com>2018-07-11 17:40:25 -0400
commit79f663d5eaaa4b7f9fe46d176c82660d38e4be8a (patch)
tree47b27cb93aa0372eb141668526552b3559ac1dbb /Interop
parentc6b4b03fffc3cea7c9525e5c79dce28f52900521 (diff)
Add Auth interoperability library. (#1501)
* Add Auth interoperability library. This allows other SDKs to retrieve the user ID and fetch a new Auth token in a type-safe way through the Core container. * Remove unnecessary import. * Add missing copyright. * Resolve comments. - Remove unnecessary umbrella header. - Move to version 1.0. - Add tvOS support for app lifecycle changes. * Move public interop headers to private. * Add public_header_files too. * Moved headers back into public. * Shorten Interoperability and Interoperable to Interop. * Add AuthInterop to travis linting. * Fixed tag format in AuthInterop.podspec. * Add AuthInterop path to Firestore Podfile.
Diffstat (limited to 'Interop')
-rw-r--r--Interop/Auth/Public/FIRAuthInterop.h42
1 files changed, 42 insertions, 0 deletions
diff --git a/Interop/Auth/Public/FIRAuthInterop.h b/Interop/Auth/Public/FIRAuthInterop.h
new file mode 100644
index 0000000..5c365a3
--- /dev/null
+++ b/Interop/Auth/Public/FIRAuthInterop.h
@@ -0,0 +1,42 @@
+/*
+ * Copyright 2018 Google
+ *
+ * Licensed under the Apache License, Version 2.0 (the "License");
+ * you may not use this file except in compliance with the License.
+ * You may obtain a copy of the License at
+ *
+ * http://www.apache.org/licenses/LICENSE-2.0
+ *
+ * Unless required by applicable law or agreed to in writing, software
+ * distributed under the License is distributed on an "AS IS" BASIS,
+ * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
+ * See the License for the specific language governing permissions and
+ * limitations under the License.
+ */
+
+#ifndef FIRAuthInterop_h
+#define FIRAuthInterop_h
+
+NS_ASSUME_NONNULL_BEGIN
+
+/** @typedef FIRTokenCallback
+ @brief The type of block which gets called when a token is ready.
+ */
+typedef void (^FIRTokenCallback)(NSString *_Nullable token, NSError *_Nullable error)
+ NS_SWIFT_NAME(TokenCallback);
+
+/// Common methods for Auth interoperability.
+NS_SWIFT_NAME(AuthInterop)
+@protocol FIRAuthInterop
+
+/// Retrieves the Firebase authentication token, possibly refreshing it if it has expired.
+- (void)getTokenForcingRefresh:(BOOL)forceRefresh withCallback:(FIRTokenCallback)callback;
+
+/// Get the current Auth user's UID. Returns nil if there is no user signed in.
+- (nullable NSString *)getUserID;
+
+@end
+
+NS_ASSUME_NONNULL_END
+
+#endif /* FIRAuthInterop_h */