No Description

FIRCreateAuthURIResponse.h 2.0KB

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 "FIRAuthRPCResponse.h"
  18. NS_ASSUME_NONNULL_BEGIN
  19. /** @class FIRCreateAuthURIResponse
  20. @brief Represents the parameters for the createAuthUri endpoint.
  21. @see https://developers.google.com/identity/toolkit/web/reference/relyingparty/createAuthUri
  22. */
  23. @interface FIRCreateAuthURIResponse : NSObject <FIRAuthRPCResponse>
  24. /** @property authUri
  25. @brief The URI used by the IDP to authenticate the user.
  26. */
  27. @property(nonatomic, strong, readonly, nullable) NSString *authURI;
  28. /** @property registered
  29. @brief Whether the user is registered if the identifier is an email.
  30. */
  31. @property(nonatomic, assign, readonly) BOOL registered;
  32. /** @property providerId
  33. @brief The provider ID of the auth URI.
  34. */
  35. @property(nonatomic, strong, readonly, nullable) NSString *providerID;
  36. /** @property forExistingProvider
  37. @brief True if the authUri is for user's existing provider.
  38. */
  39. @property(nonatomic, assign, readonly) BOOL forExistingProvider;
  40. /** @property allProviders
  41. @brief A list of provider IDs the passed @c identifier could use to sign in with.
  42. */
  43. @property(nonatomic, copy, readonly, nullable) NSArray<NSString *> *allProviders;
  44. /** @property signinMethods
  45. @brief A list of sign-in methods available for the passed @c identifier.
  46. */
  47. @property(nonatomic, copy, readonly, nullable) NSArray<NSString *> *signinMethods;
  48. @end
  49. NS_ASSUME_NONNULL_END