You can not select more than 25 topics Topics must start with a letter or number, can include dashes ('-') and can be up to 35 characters long.

70 lines
2.5 KiB

6 years ago
  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 "FIRPhoneAuthCredential.h"
  18. NS_ASSUME_NONNULL_BEGIN
  19. /** @extension FIRPhoneAuthCredential
  20. @brief Internal implementation of FIRAuthCredential for Phone Auth credentials.
  21. */
  22. @interface FIRPhoneAuthCredential ()
  23. /** @var verificationID
  24. @brief The verification ID obtained from invoking @c verifyPhoneNumber:completion:
  25. */
  26. @property(nonatomic, readonly, nonnull) NSString *verificationID;
  27. /** @var verificationCode
  28. @brief The verification code provided by the user.
  29. */
  30. @property(nonatomic, readonly, nonnull) NSString *verificationCode;
  31. /** @var temporaryProof
  32. @brief The a temporary proof code perftaining to this credential, returned from the backend.
  33. */
  34. @property(nonatomic, readonly, nonnull) NSString *temporaryProof;
  35. /** @var phoneNumber
  36. @brief The a phone number pertaining to this credential, returned from the backend.
  37. */
  38. @property(nonatomic, readonly, nonnull) NSString *phoneNumber;
  39. /** @var initWithTemporaryProof:phoneNumber:
  40. @brief Designated Initializer.
  41. @param providerID The provider ID associated with the phone auth credential being created.
  42. */
  43. - (instancetype)initWithTemporaryProof:(NSString *)temporaryProof
  44. phoneNumber:(NSString *)phoneNumber
  45. providerID:(NSString *)providerID NS_DESIGNATED_INITIALIZER;
  46. /** @var initWithProviderID:verificationID:verificationCode:
  47. @brief Designated Initializer.
  48. @param providerID The provider ID associated with the phone auth credential being created.
  49. @param verificationID The verification ID associated witht Phone Auth credential being created.
  50. @param verificationCode The verification code associated witht Phone Auth credential being
  51. created.
  52. */
  53. - (instancetype)initWithProviderID:(NSString *)providerID
  54. verificationID:(NSString *)verificationID
  55. verificationCode:(NSString *)verificationCode NS_DESIGNATED_INITIALIZER;
  56. @end
  57. NS_ASSUME_NONNULL_END