aboutsummaryrefslogtreecommitdiffhomepage
path: root/Firebase/Auth/Source/RPCs/FIRResetPasswordRequest.h
blob: 66b03ad76f8c0deea66415e718945b529610dee6 (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
/*
 * 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>

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

NS_ASSUME_NONNULL_BEGIN

@interface FIRResetPasswordRequest : FIRIdentityToolkitRequest <FIRAuthRPCRequest>

/** @property oobCode
    @brief The oobCode sent in the request.
 */
@property(nonatomic, copy, readonly) NSString *oobCode;

/** @property updatedPassword
    @brief The new password sent in the request.
 */
@property(nonatomic, copy, readonly) NSString *updatedPassword;

/** @fn initWithEndpoint:APIKey:
    @brief Please use initWithOOBCode:oobCode: instead.
 */
- (nullable instancetype)initWithEndpoint:(NSString *)endpoint
                                   APIKey:(NSString *)APIKey NS_UNAVAILABLE;

/** @fn initWithAPIKey:oobCode:currentPassword:
    @brief Designated initializer.
    @param APIKey The client's API Key.
    @param oobCode The OOB Code.
    @param newPassword The new password.
 */
- (nullable instancetype)initWithAPIKey:(NSString *)APIKey
                                oobCode:(NSString *)oobCode
                            newPassword:(nullable NSString *)newPassword NS_DESIGNATED_INITIALIZER;
@end

NS_ASSUME_NONNULL_END