75d24c15
 yangbin
123
|
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
107
108
109
110
111
112
113
114
115
116
117
|
////////////////////////////////////////////////////////////////////////////
//
// Copyright 2020 Realm Inc.
//
// 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 <Realm/RLMProviderClient.h>
@protocol RLMBSON;
/// A block type used to report an error
typedef void(^RLMEmailPasswordAuthOptionalErrorBlock)(NSError * _Nullable);
NS_ASSUME_NONNULL_BEGIN
/**
A client for the email/password authentication provider which
can be used to obtain a credential for logging in,
and to perform requests specifically related to the email/password provider.
*/
@interface RLMEmailPasswordAuth : RLMProviderClient
/**
Registers a new email identity with the email/password provider,
and sends a confirmation email to the provided address.
@param email The email address of the user to register.
@param password The password that the user created for the new email/password identity.
@param completionHandler A callback to be invoked once the call is complete.
*/
- (void)registerUserWithEmail:(NSString *)email
password:(NSString *)password
completion:(RLMEmailPasswordAuthOptionalErrorBlock)completionHandler NS_SWIFT_NAME(registerUser(email:password:completion:));
/**
Confirms an email identity with the email/password provider.
@param token The confirmation token that was emailed to the user.
@param tokenId The confirmation token id that was emailed to the user.
@param completionHandler A callback to be invoked once the call is complete.
*/
- (void)confirmUser:(NSString *)token
tokenId:(NSString *)tokenId
completion:(RLMEmailPasswordAuthOptionalErrorBlock)completionHandler;
/**
Re-sends a confirmation email to a user that has registered but
not yet confirmed their email address.
@param email The email address of the user to re-send a confirmation for.
@param completionHandler A callback to be invoked once the call is complete.
*/
- (void)resendConfirmationEmail:(NSString *)email
completion:(RLMEmailPasswordAuthOptionalErrorBlock)completionHandler;
/**
Retries custom confirmation function for a given email address.
@param email The email address of the user to retry custom confirmation logic.
@param completionHandler A callback to be invoked once the call is complete.
*/
- (void)retryCustomConfirmation:(NSString *)email
completion:(RLMEmailPasswordAuthOptionalErrorBlock)completionHandler;
/**
Sends a password reset email to the given email address.
@param email The email address of the user to send a password reset email for.
@param completionHandler A callback to be invoked once the call is complete.
*/
- (void)sendResetPasswordEmail:(NSString *)email
completion:(RLMEmailPasswordAuthOptionalErrorBlock)completionHandler;
/**
Resets the password of an email identity using the
password reset token emailed to a user.
@param password The new password.
@param token The password reset token that was emailed to the user.
@param tokenId The password reset token id that was emailed to the user.
@param completionHandler A callback to be invoked once the call is complete.
*/
- (void)resetPasswordTo:(NSString *)password
token:(NSString *)token
tokenId:(NSString *)tokenId
completion:(RLMEmailPasswordAuthOptionalErrorBlock)completionHandler;
/**
Resets the password of an email identity using the
password reset function set up in the application.
@param email The email address of the user.
@param password The desired new password.
@param args A list of arguments passed in as a BSON array.
@param completionHandler A callback to be invoked once the call is complete.
*/
- (void)callResetPasswordFunction:(NSString *)email
password:(NSString *)password
args:(NSArray<id<RLMBSON>> *)args
completion:(RLMEmailPasswordAuthOptionalErrorBlock)completionHandler NS_REFINED_FOR_SWIFT;
@end
NS_ASSUME_NONNULL_END
|
