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
|
////////////////////////////////////////////////////////////////////////////
//
// 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>
@class RLMUserAPIKey, RLMObjectId;
NS_ASSUME_NONNULL_BEGIN
/// Provider client for user API keys.
@interface RLMAPIKeyAuth : RLMProviderClient
/// A block type used to report an error
typedef void(^RLMAPIKeyAuthOptionalErrorBlock)(NSError * _Nullable);
/// A block type used to return an `RLMUserAPIKey` on success, or an `NSError` on failure
typedef void(^RLMOptionalUserAPIKeyBlock)(RLMUserAPIKey * _Nullable, NSError * _Nullable);
/// A block type used to return an array of `RLMUserAPIKey` on success, or an `NSError` on failure
typedef void(^RLMUserAPIKeysBlock)(NSArray<RLMUserAPIKey *> * _Nullable, NSError * _Nullable);
/**
Creates a user API key that can be used to authenticate as the current user.
@param name The name of the API key to be created.
@param completion A callback to be invoked once the call is complete.
*/
- (void)createAPIKeyWithName:(NSString *)name
completion:(RLMOptionalUserAPIKeyBlock)completion NS_SWIFT_NAME(createAPIKey(named:completion:));
/**
Fetches a user API key associated with the current user.
@param objectId The ObjectId of the API key to fetch.
@param completion A callback to be invoked once the call is complete.
*/
- (void)fetchAPIKey:(RLMObjectId *)objectId
completion:(RLMOptionalUserAPIKeyBlock)completion;
/**
Fetches the user API keys associated with the current user.
@param completion A callback to be invoked once the call is complete.
*/
- (void)fetchAPIKeysWithCompletion:(RLMUserAPIKeysBlock)completion;
/**
Deletes a user API key associated with the current user.
@param objectId The ObjectId of the API key to delete.
@param completion A callback to be invoked once the call is complete.
*/
- (void)deleteAPIKey:(RLMObjectId *)objectId
completion:(RLMAPIKeyAuthOptionalErrorBlock)completion;
/**
Enables a user API key associated with the current user.
@param objectId The ObjectId of the API key to enable.
@param completion A callback to be invoked once the call is complete.
*/
- (void)enableAPIKey:(RLMObjectId *)objectId
completion:(RLMAPIKeyAuthOptionalErrorBlock)completion;
/**
Disables a user API key associated with the current user.
@param objectId The ObjectId of the API key to disable.
@param completion A callback to be invoked once the call is complete.
*/
- (void)disableAPIKey:(RLMObjectId *)objectId
completion:(RLMAPIKeyAuthOptionalErrorBlock)completion;
@end
NS_ASSUME_NONNULL_END
|
