Blame view

Pods/Realm/include/RLMFindOneAndModifyOptions.h 2.54 KB
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
  ////////////////////////////////////////////////////////////////////////////
  //
  // 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 `findOneAndUpdate`, `findOneAndReplace`,
  /// or `findOneAndDelete` command on a `RLMMongoCollection`.
  @interface RLMFindOneAndModifyOptions : NSObject
  
  /// 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;
  
  /// Whether or not to perform an upsert, default is false
  /// (only available for find_one_and_replace and find_one_and_update)
  @property (nonatomic) BOOL upsert;
  
  /// When true then the new document is returned,
  /// Otherwise the old document is returned (default)
  /// (only available for findOneAndReplace and findOneAndUpdate)
  @property (nonatomic) BOOL shouldReturnNewDocument;
  
  /// Options to use when executing a `findOneAndUpdate`, `findOneAndReplace`,
  /// or `findOneAndDelete` 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.
  /// @param upsert Whether or not to perform an upsert, default is false
  /// (only available for findOneAndReplace and findOneAndUpdate)
  /// @param shouldReturnNewDocument When true then the new document is returned,
  /// Otherwise the old document is returned (default),
  /// (only available for findOneAndReplace and findOneAndUpdate)
  - (instancetype)initWithProjection:(id<RLMBSON> _Nullable)projection
                                sort:(id<RLMBSON> _Nullable)sort
                              upsert:(BOOL)upsert
             shouldReturnNewDocument:(BOOL)shouldReturnNewDocument NS_SWIFT_UNAVAILABLE("Please see FindOneAndModifyOptions");
  
  @end
  
  NS_ASSUME_NONNULL_END