No Description

FIRSignUpNewUserRequest.h 2.5KB

123456789101112131415161718192021222324252627282930313233343536373839404142434445464748495051525354555657585960616263646566676869707172
  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 "FIRAuthRPCRequest.h"
  18. #import "FIRIdentityToolkitRequest.h"
  19. NS_ASSUME_NONNULL_BEGIN
  20. @interface FIRSignUpNewUserRequest : FIRIdentityToolkitRequest <FIRAuthRPCRequest>
  21. /** @property email
  22. @brief The email of the user.
  23. */
  24. @property(nonatomic, copy, nullable) NSString *email;
  25. /** @property password
  26. @brief The password inputed by the user.
  27. */
  28. @property(nonatomic, copy, nullable) NSString *password;
  29. /** @property displayName
  30. @brief The password inputed by the user.
  31. */
  32. @property(nonatomic, copy, nullable) NSString *displayName;
  33. /** @property returnSecureToken
  34. @brief Whether the response should return access token and refresh token directly.
  35. @remarks The default value is @c YES .
  36. */
  37. @property(nonatomic, assign) BOOL returnSecureToken;
  38. /** @fn initWithEndpoint:requestConfiguration:
  39. @brief Please use initWithAPIKey:email:password:displayName:requestConfiguration instead.
  40. */
  41. - (nullable instancetype)initWithEndpoint:(NSString *)endpoint
  42. requestConfiguration:(FIRAuthRequestConfiguration *)requestConfiguration
  43. NS_UNAVAILABLE;
  44. /** @fn initWithEndpoint:requestConfiguration:
  45. @brief initializer for anonymous sign-in.
  46. */
  47. - (nullable instancetype)initWithRequestConfiguration:
  48. (FIRAuthRequestConfiguration *)requestConfiguration;
  49. /** @fn initWithAPIKey:email:password:displayName:requestConfiguration
  50. @brief Designated initializer.
  51. @param requestConfiguration An object containing configurations to be added to the request.
  52. */
  53. - (nullable instancetype)initWithEmail:(nullable NSString *)email
  54. password:(nullable NSString *)password
  55. displayName:(nullable NSString *)displayName
  56. requestConfiguration:(FIRAuthRequestConfiguration *)requestConfiguration
  57. NS_DESIGNATED_INITIALIZER;
  58. @end
  59. NS_ASSUME_NONNULL_END