No Description

FIRAdditionalUserInfo.h 1.7KB

123456789101112131415161718192021222324252627282930313233343536373839404142434445464748495051525354555657
  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. @class FIRVerifyAssertionResponse;
  18. NS_ASSUME_NONNULL_BEGIN
  19. /** @class FIRAdditionalUserInfo
  20. @brief Represents additional user data returned from an identity provider.
  21. */
  22. NS_SWIFT_NAME(AdditionalUserInfo)
  23. @interface FIRAdditionalUserInfo : NSObject
  24. /** @fn init
  25. @brief This class should not be initialized manually. `FIRAdditionalUserInfo` can be retrieved
  26. from from an instance of `FIRAuthDataResult`.
  27. */
  28. - (instancetype)init NS_UNAVAILABLE;
  29. /** @property providerID
  30. @brief The provider identifier.
  31. */
  32. @property(nonatomic, readonly) NSString *providerID;
  33. /** @property profile
  34. @brief Dictionary containing the additional IdP specific information.
  35. */
  36. @property(nonatomic, readonly, nullable) NSDictionary<NSString *, NSObject *> *profile;
  37. /** @property username
  38. @brief username The name of the user.
  39. */
  40. @property(nonatomic, readonly, nullable) NSString *username;
  41. /** @property newUser
  42. @brief Indicates whether or not the current user was signed in for the first time.
  43. */
  44. @property(nonatomic, readonly, getter=isNewUser) BOOL newUser;
  45. @end
  46. NS_ASSUME_NONNULL_END