RLMFindOptions.h
2.24 KB
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
////////////////////////////////////////////////////////////////////////////
//
// 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 <Foundation/Foundation.h>
NS_ASSUME_NONNULL_BEGIN
@protocol RLMBSON;
/// Options to use when executing a `find` command on a `RLMMongoCollection`.
@interface RLMFindOptions : NSObject
/// The maximum number of documents to return. Specifying 0 will return all documents.
@property (nonatomic) NSInteger limit;
/// Limits the fields to return for all matching documents.
@property (nonatomic, nullable) id<RLMBSON> projection NS_REFINED_FOR_SWIFT;
/// The order in which to return matching documents.
@property (nonatomic, nullable) id<RLMBSON> sort NS_REFINED_FOR_SWIFT;
/// Options to use when executing a `find` command on a `RLMMongoCollection`.
/// @param limit The maximum number of documents to return. Specifying 0 will return all documents.
/// @param projection Limits the fields to return for all matching documents.
/// @param sort The order in which to return matching documents.
- (instancetype)initWithLimit:(NSInteger)limit
projection:(id<RLMBSON> _Nullable)projection
sort:(id<RLMBSON> _Nullable)sort
NS_SWIFT_UNAVAILABLE("Please see FindOption");
/// Options to use when executing a `find` command on a `RLMMongoCollection`.
/// @param projection Limits the fields to return for all matching documents.
/// @param sort The order in which to return matching documents.
- (instancetype)initWithProjection:(id<RLMBSON> _Nullable)projection
sort:(id<RLMBSON> _Nullable)sort
NS_SWIFT_UNAVAILABLE("Please see FindOption");
@end
NS_ASSUME_NONNULL_END