blob: 28757f5e71776e151b007a80f8088270e75c5085 (
plain)
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
|
/*
* Copyright 2017 Google
*
* Licensed under the Apache License, Version 2.0 (the "License");
* you may not use this file except in compliance with the License.
* You may obtain a copy of the License at
*
* http://www.apache.org/licenses/LICENSE-2.0
*
* Unless required by applicable law or agreed to in writing, software
* distributed under the License is distributed on an "AS IS" BASIS,
* WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
* See the License for the specific language governing permissions and
* limitations under the License.
*/
#import <Foundation/Foundation.h>
@class FIRAuth;
@class FIRPhoneAuthCredential;
@protocol FIRAuthUIDelegate;
NS_ASSUME_NONNULL_BEGIN
/** @var FIRPhoneAuthProviderID
@brief A string constant identifying the phone identity provider.
*/
extern NSString *const FIRPhoneAuthProviderID NS_SWIFT_NAME(PhoneAuthProviderID);
/** @var FIRPhoneAuthProviderID
@brief A string constant identifying the phone sign-in method.
*/
extern NSString *const _Nonnull FIRPhoneAuthSignInMethod NS_SWIFT_NAME(PhoneAuthSignInMethod);
/** @typedef FIRVerificationResultCallback
@brief The type of block invoked when a request to send a verification code has finished.
@param verificationID On success, the verification ID provided, nil otherwise.
@param error On error, the error that occured, nil otherwise.
*/
typedef void (^FIRVerificationResultCallback)(NSString *_Nullable verificationID,
NSError *_Nullable error)
NS_SWIFT_NAME(VerificationResultCallback);
/** @class FIRPhoneAuthProvider
@brief A concrete implementation of `FIRAuthProvider` for phone auth providers.
*/
NS_SWIFT_NAME(PhoneAuthProvider)
@interface FIRPhoneAuthProvider : NSObject
/** @fn provider
@brief Returns an instance of `FIRPhoneAuthProvider` for the default `FIRAuth` object.
*/
+ (instancetype)provider NS_SWIFT_NAME(provider());
/** @fn providerWithAuth:
@brief Returns an instance of `FIRPhoneAuthProvider` for the provided `FIRAuth` object.
@param auth The auth object to associate with the phone auth provider instance.
*/
+ (instancetype)providerWithAuth:(FIRAuth *)auth NS_SWIFT_NAME(provider(auth:));
/** @fn verifyPhoneNumber:UIDelegate:completion:
@brief Starts the phone number authentication flow by sending a verifcation code to the
specified phone number.
@param phoneNumber The phone number to be verified.
@param UIDelegate An object used to present the SFSafariViewController. The object is retained
by this method until the completion block is executed.
@param completion The callback to be invoked when the verification flow is finished.
@remarks Possible error codes:
+ `FIRAuthErrorCodeCaptchaCheckFailed` - Indicates that the reCAPTCHA token obtained by
the Firebase Auth is invalid or has expired.
+ `FIRAuthErrorCodeQuotaExceeded` - Indicates that the phone verification quota for this
project has been exceeded.
+ `FIRAuthErrorCodeInvalidPhoneNumber` - Indicates that the phone number provided is
invalid.
+ `FIRAuthErrorCodeMissingPhoneNumber` - Indicates that a phone number was not provided.
*/
- (void)verifyPhoneNumber:(NSString *)phoneNumber
UIDelegate:(nullable id<FIRAuthUIDelegate>)UIDelegate
completion:(nullable FIRVerificationResultCallback)completion;
/** @fn credentialWithVerificationID:verificationCode:
@brief Creates an `FIRAuthCredential` for the phone number provider identified by the
verification ID and verification code.
@param verificationID The verification ID obtained from invoking
verifyPhoneNumber:completion:
@param verificationCode The verification code obtained from the user.
@return The corresponding phone auth credential for the verification ID and verification code
provided.
*/
- (FIRPhoneAuthCredential *)credentialWithVerificationID:(NSString *)verificationID
verificationCode:(NSString *)verificationCode;
/** @fn init
@brief Please use the `provider` or `providerWithAuth:` methods to obtain an instance of
`FIRPhoneAuthProvider`.
*/
- (instancetype)init NS_UNAVAILABLE;
@end
NS_ASSUME_NONNULL_END
|
