aboutsummaryrefslogtreecommitdiffhomepage
path: root/Firebase/Auth/Source/Private/FIRUserInfoImpl.h
diff options
context:
space:
mode:
authorGravatar Xiangtian Dai <xiangtian@google.com>2017-06-02 21:44:58 -0700
committerGravatar GitHub <noreply@github.com>2017-06-02 21:44:58 -0700
commit0de31ac64ba5063af4e66ed1942c4185aed94c6f (patch)
tree226ba1f131aeb9eecd60e2e90288f458952fc2cb /Firebase/Auth/Source/Private/FIRUserInfoImpl.h
parentbf94775ae0e57f9ea5ef53bcbc180bff57647286 (diff)
Auth source file cleanup (#65)
* Cleans up Firebase Auth sources: - Updates umbrella header files to import all public header files. - Moves remaining private header files under root of source directory to the private subdirectory. - Makes the version header file non-executable. * Excludes phone number auth headers from the umbrella header for mac OS.
Diffstat (limited to 'Firebase/Auth/Source/Private/FIRUserInfoImpl.h')
-rw-r--r--Firebase/Auth/Source/Private/FIRUserInfoImpl.h61
1 files changed, 61 insertions, 0 deletions
diff --git a/Firebase/Auth/Source/Private/FIRUserInfoImpl.h b/Firebase/Auth/Source/Private/FIRUserInfoImpl.h
new file mode 100644
index 0000000..0022a68
--- /dev/null
+++ b/Firebase/Auth/Source/Private/FIRUserInfoImpl.h
@@ -0,0 +1,61 @@
+/*
+ * 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 "FIRUserInfo.h"
+
+@class FIRGetAccountInfoResponseProviderUserInfo;
+
+NS_ASSUME_NONNULL_BEGIN
+
+@interface FIRUserInfoImpl : NSObject <FIRUserInfo, NSSecureCoding>
+
+/** @fn userInfoWithGetAccountInfoResponseProviderUserInfo:
+ @brief A convenience factory method for constructing a @c FIRUserInfo instance from data
+ returned by the getAccountInfo endpoint.
+ @param providerUserInfo Data returned by the getAccountInfo endpoint.
+ @return A new instance of @c FIRUserInfo using data from the getAccountInfo endpoint.
+ */
++ (nullable instancetype)userInfoWithGetAccountInfoResponseProviderUserInfo:
+ (FIRGetAccountInfoResponseProviderUserInfo *)providerUserInfo;
+
+/** @fn init
+ @brief This class should not be initialized manually.
+ @see FIRUser.providerData
+ */
+- (instancetype)init NS_UNAVAILABLE;
+
+/** @fn initWithProviderID:userID:displayName:photoURL:email:
+ @brief Designated initializer.
+ @param providerID The provider identifier.
+ @param userID The unique user ID for the user (the value of the @c uid field in the token.)
+ @param displayName The name of the user.
+ @param photoURL The URL of the user's profile photo.
+ @param email The user's email address.
+ @param phoneNumber The user's phone number.
+ */
+- (nullable instancetype)initWithProviderID:(NSString *)providerID
+ userID:(NSString *)userID
+ displayName:(nullable NSString *)displayName
+ photoURL:(nullable NSURL *)photoURL
+ email:(nullable NSString *)email
+ phoneNumber:(nullable NSString *)phoneNumber
+ NS_DESIGNATED_INITIALIZER;
+
+@end
+
+NS_ASSUME_NONNULL_END