No Description

FIRResetPasswordResponse.h 1.7KB

12345678910111213141516171819202122232425262728293031323334353637383940414243444546474849505152
  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 FIRAuthResetPasswordResponse
  20. @brief Represents the response from the resetPassword endpoint.
  21. @remarks Possible error codes:
  22. - FIRAuthErrorCodeWeakPassword
  23. - FIRAuthErrorCodeUserDisabled
  24. - FIRAuthErrorCodeOperationNotAllowed
  25. - FIRAuthErrorCodeExpiredActionCode
  26. - FIRAuthErrorCodeInvalidActionCode
  27. @see https://developers.google.com/identity/toolkit/web/reference/relyingparty/resetPassword
  28. */
  29. @interface FIRResetPasswordResponse : NSObject<FIRAuthRPCResponse>
  30. /** @property email
  31. @brief The email address corresponding to the reset password request.
  32. */
  33. @property(nonatomic, strong, readonly) NSString *email;
  34. /** @property verifiedEmail
  35. @brief The verified email returned from the backend.
  36. */
  37. @property(nonatomic, strong, readonly) NSString *verifiedEmail;
  38. /** @property requestType
  39. @brief The tpye of request as returned by the backend.
  40. */
  41. @property(nonatomic, strong, readonly) NSString *requestType;
  42. @end
  43. NS_ASSUME_NONNULL_END