aboutsummaryrefslogtreecommitdiffhomepage
path: root/Firebase/Auth/Source/Public/FIRAuthDataResult.h
diff options
context:
space:
mode:
Diffstat (limited to 'Firebase/Auth/Source/Public/FIRAuthDataResult.h')
-rw-r--r--Firebase/Auth/Source/Public/FIRAuthDataResult.h51
1 files changed, 51 insertions, 0 deletions
diff --git a/Firebase/Auth/Source/Public/FIRAuthDataResult.h b/Firebase/Auth/Source/Public/FIRAuthDataResult.h
new file mode 100644
index 0000000..e72adf2
--- /dev/null
+++ b/Firebase/Auth/Source/Public/FIRAuthDataResult.h
@@ -0,0 +1,51 @@
+/*
+ * Copyright 2017 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.
+ */
+
+#import <Foundation/Foundation.h>
+
+#import "FIRAuthSwiftNameSupport.h"
+
+@class FIRAdditionalUserInfo;
+@class FIRUser;
+
+NS_ASSUME_NONNULL_BEGIN
+
+/** @class FIRAuthDataResult
+ @brief Helper object that contains the result of a successful sign-in, link and reauthenticate.
+ It contains a reference to a @c FIRUser and @c FIRAdditionalUserInfo.
+ */
+FIR_SWIFT_NAME(AuthDataResult)
+@interface FIRAuthDataResult : NSObject
+
+/** @fn init
+ @brief This class should not be initialized manually. @c FIRAuthDataResult instance is
+ returned as part of @c FIRAuthDataResultCallback .
+ */
+- (instancetype)init NS_UNAVAILABLE;
+
+/** @property user
+ @brief The signed in user.
+ */
+@property(nonatomic, readonly) FIRUser *user;
+
+/** @property additionalUserInfo
+ @brief If available contains the additional IdP specific information about signed in user.
+ */
+@property(nonatomic, readonly, nullable) FIRAdditionalUserInfo *additionalUserInfo;
+
+@end
+
+NS_ASSUME_NONNULL_END