aboutsummaryrefslogtreecommitdiffhomepage
path: root/Firebase/Auth/Source/RPCs/FIRSendVerificationCodeRequest.h
blob: 596fb8cb051770983177a0c87b078c80f9b56728 (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
/*
 * 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 "FIRIdentityToolkitRequest.h"

#import "FIRAuthRPCRequest.h"
#import "FIRIdentityToolkitRequest.h"

@class FIRAuthAppCredential;

NS_ASSUME_NONNULL_BEGIN

@interface FIRSendVerificationCodeRequest : FIRIdentityToolkitRequest <FIRAuthRPCRequest>

/** @property phoneNumber
    @brief The phone number to which the verification code should be sent.
 */
@property(nonatomic, strong, readonly) NSString *phoneNumber;

/** @property appCredential
    @brief The credential to prove the identity of the app in order to send the verification code.
 */
@property(nonatomic, strong, readonly) FIRAuthAppCredential *appCredential;

/** @fn initWithEndpoint:APIKey:
    @brief Please use initWithPhoneNumber:APIKey:
 */
- (nullable instancetype)initWithEndpoint:(NSString *)endpoint
                                   APIKey:(NSString *)APIKey NS_UNAVAILABLE;

/** @fn initWithPhoneNumber:APIKey:
    @brief Designated initializer.
    @param phoneNumber The phone number to which the verification code is to be sent.
    @param appCredential The credential that proves the identity of the app.
    @param APIKey The client's API Key.
 */
- (nullable instancetype)initWithPhoneNumber:(NSString *)phoneNumber
                               appCredential:(FIRAuthAppCredential *)appCredential
                                      APIKey:(NSString *)APIKey NS_DESIGNATED_INITIALIZER;

@end

NS_ASSUME_NONNULL_END