FIRPhoneAuthCredential_Internal.h 2.6 KB

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