Nav apraksta

FIRUserInfoImpl.h 2.4KB

12345678910111213141516171819202122232425262728293031323334353637383940414243444546474849505152535455565758596061
  1. /*
  2. * Copyright 2017 Google
  3. *
  4. * Licensed under the Apache License, Version 2.0 (the "License");
  5. * you may not use this file except in compliance with the License.
  6. * You may obtain a copy of the License at
  7. *
  8. * http://www.apache.org/licenses/LICENSE-2.0
  9. *
  10. * Unless required by applicable law or agreed to in writing, software
  11. * distributed under the License is distributed on an "AS IS" BASIS,
  12. * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
  13. * See the License for the specific language governing permissions and
  14. * limitations under the License.
  15. */
  16. #import <Foundation/Foundation.h>
  17. #import "FIRUserInfo.h"
  18. @class FIRGetAccountInfoResponseProviderUserInfo;
  19. NS_ASSUME_NONNULL_BEGIN
  20. @interface FIRUserInfoImpl : NSObject <FIRUserInfo, NSSecureCoding>
  21. /** @fn userInfoWithGetAccountInfoResponseProviderUserInfo:
  22. @brief A convenience factory method for constructing a @c FIRUserInfo instance from data
  23. returned by the getAccountInfo endpoint.
  24. @param providerUserInfo Data returned by the getAccountInfo endpoint.
  25. @return A new instance of @c FIRUserInfo using data from the getAccountInfo endpoint.
  26. */
  27. + (nullable instancetype)userInfoWithGetAccountInfoResponseProviderUserInfo:
  28. (FIRGetAccountInfoResponseProviderUserInfo *)providerUserInfo;
  29. /** @fn init
  30. @brief This class should not be initialized manually.
  31. @see FIRUser.providerData
  32. */
  33. - (instancetype)init NS_UNAVAILABLE;
  34. /** @fn initWithProviderID:userID:displayName:photoURL:email:
  35. @brief Designated initializer.
  36. @param providerID The provider identifier.
  37. @param userID The unique user ID for the user (the value of the @c uid field in the token.)
  38. @param displayName The name of the user.
  39. @param photoURL The URL of the user's profile photo.
  40. @param email The user's email address.
  41. @param phoneNumber The user's phone number.
  42. */
  43. - (nullable instancetype)initWithProviderID:(NSString *)providerID
  44. userID:(NSString *)userID
  45. displayName:(nullable NSString *)displayName
  46. photoURL:(nullable NSURL *)photoURL
  47. email:(nullable NSString *)email
  48. phoneNumber:(nullable NSString *)phoneNumber
  49. NS_DESIGNATED_INITIALIZER;
  50. @end
  51. NS_ASSUME_NONNULL_END