RLMResults

@interface RLMResults<RLMObjectType>
    : NSObject <RLMCollection, NSFastEnumeration>

RLMResults is an auto-updating container type in Realm returned from object queries. It represents the results of the query in the form of a collection of objects.

RLMResults can be queried using the same predicates as RLMObject and RLMArray, and you can chain queries to further filter results.

RLMResults always reflect the current state of the Realm on the current thread, including during write transactions on the current thread. The one exception to this is when using for...in fast enumeration, which will always enumerate over the objects which matched the query when the enumeration is begun, even if some of them are deleted or modified to be excluded by the filter during the enumeration.

RLMResults are lazily evaluated the first time they are accessed; they only run queries when the result of the query is requested. This means that chaining several temporary RLMResults to sort and filter your data does not perform any extra work processing the intermediate state.

Once the results have been evaluated or a notification block has been added, the results are eagerly kept up-to-date, with the work done to keep them up-to-date done on a background thread whenever possible.

RLMResults cannot be directly instantiated.

Properties

count
The number of objects in the results collection.
Declaration
Objective-C

@property (nonatomic, readonly) NSUInteger count;
Swift

var count: UInt { get }
Show on GitHub


                    
                    
                    type

The type of the objects in the results collection.

Declaration

Objective-C

@property (nonatomic, readonly) RLMPropertyType type;

Swift

var type: RLMPropertyType { get }

Show on GitHub

optional
Indicates whether the objects in the collection can be nil.
Declaration
Objective-C

@property (nonatomic, getter=isOptional) BOOL optional;
Swift

var isOptional: Bool { get set }
Show on GitHub
objectClassName
The class name of the objects contained in the results collection.

Will be nil if type is not RLMPropertyTypeObject.
Declaration
Objective-C

@property (nonatomic, copy, readonly, nullable) NSString *objectClassName;
Swift

var objectClassName: String? { get }
Show on GitHub


                    
                    
                    realm

The Realm which manages this results collection.

Declaration

Objective-C

@property (nonatomic, readonly) RLMRealm *_Nonnull realm;

Swift

var realm: RLMRealm { get }

Show on GitHub

invalidated
Indicates if the results collection is no longer valid.

The results collection becomes invalid if invalidate is called on the containing realm. An invalidated results collection can be accessed, but will always be empty.
Declaration
Objective-C

@property (nonatomic, readonly, getter=isInvalidated) BOOL invalidated;
Swift

var isInvalidated: Bool { get }
Show on GitHub

Accessing Objects from an RLMResults


                    
                    
                    -objectAtIndex:

Returns the object at the index specified.

Declaration

Objective-C

- (nonnull RLMObjectType)objectAtIndex:(NSUInteger)index;

Swift

func object(at index: UInt) -> RLMObjectType

Parameters


                                index

The index to look up.

Return Value

An object of the type contained in the results collection.

Show on GitHub

-firstObject
Returns the first object in the results collection.

Returns nil if called on an empty results collection.
Declaration
Objective-C

- (nullable RLMObjectType)firstObject;
Swift

func firstObject() -> RLMObjectType?
Return Value

An object of the type contained in the results collection.

Show on GitHub
-lastObject
Returns the last object in the results collection.

Returns nil if called on an empty results collection.
Declaration
Objective-C

- (nullable RLMObjectType)lastObject;
Swift

func lastObject() -> RLMObjectType?
Return Value

An object of the type contained in the results collection.

Show on GitHub

Querying Results


                    
                    
                    -indexOfObject:

Returns the index of an object in the results collection.

Returns NSNotFound if the object is not found in the results collection.

Declaration

Objective-C

- (NSUInteger)indexOfObject:(nonnull RLMObjectType)object;

Swift

func index(of object: RLMObjectType) -> UInt

Parameters


                                object

An object (of the same type as returned from the objectClassName selector).

Show on GitHub


                    
                    
                    -indexOfObjectWhere:

Returns the index of the first object in the results collection matching the predicate.

Declaration

Objective-C

- (NSUInteger)indexOfObjectWhere:(nonnull NSString *)predicateFormat, ...;

Parameters


                                predicateFormat

A predicate format string, optionally followed by a variable number of arguments.

Return Value

The index of the object, or NSNotFound if the object is not found in the results collection.

Show on GitHub


                    
                    
                    -indexOfObjectWithPredicate:

Returns the index of the first object in the results collection matching the predicate.

Declaration

Objective-C

- (NSUInteger)indexOfObjectWithPredicate:(nonnull NSPredicate *)predicate;

Swift

func indexOfObject(with predicate: NSPredicate) -> UInt

Parameters


                                predicate

The predicate with which to filter the objects.

Return Value

The index of the object, or NSNotFound if the object is not found in the results collection.

Show on GitHub


                    
                    
                    -objectsWhere:

Returns all the objects matching the given predicate in the results collection.

Declaration

Objective-C

- (nonnull RLMResults<RLMObjectType> *)objectsWhere:
    (nonnull NSString *)predicateFormat, ...;

Parameters


                                predicateFormat

A predicate format string, optionally followed by a variable number of arguments.

Return Value

An RLMResults of objects that match the given predicate.

Show on GitHub


                    
                    
                    -objectsWithPredicate:

Returns all the objects matching the given predicate in the results collection.

Declaration

Objective-C

- (nonnull RLMResults<RLMObjectType> *)objectsWithPredicate:
    (nonnull NSPredicate *)predicate;

Swift

func objects(with predicate: NSPredicate) -> RLMResults<RLMObjectType>

Parameters


                                predicate

The predicate with which to filter the objects.

Return Value

An RLMResults of objects that match the given predicate.

Show on GitHub


                    
                    
                    -sortedResultsUsingKeyPath:ascending:

Returns a sorted RLMResults from an existing results collection.

Declaration

Objective-C

- (nonnull RLMResults<RLMObjectType> *)
    sortedResultsUsingKeyPath:(nonnull NSString *)keyPath
                    ascending:(BOOL)ascending;

Swift

func sortedResults(usingKeyPath keyPath: String, ascending: Bool) -> RLMResults<RLMObjectType>

Parameters

`keyPath`	The key path to sort by.
`ascending`	The direction to sort in.

Return Value

An RLMResults sorted by the specified key path.

Show on GitHub


                    
                    
                    -sortedResultsUsingDescriptors:

Returns a sorted RLMResults from an existing results collection.

Declaration

Objective-C

- (nonnull RLMResults<RLMObjectType> *)sortedResultsUsingDescriptors:
    (nonnull NSArray<RLMSortDescriptor *> *)properties;

Swift

func sortedResults(using properties: [RLMSortDescriptor]) -> RLMResults<RLMObjectType>

Parameters


                                properties

An array of RLMSortDescriptors to sort by.

Return Value

An RLMResults sorted by the specified properties.

Show on GitHub


                    
                    
                    -distinctResultsUsingKeyPaths:

Returns a distinct RLMResults from an existing results collection.

Declaration

Objective-C

- (nonnull RLMResults<RLMObjectType> *)distinctResultsUsingKeyPaths:
    (nonnull NSArray<NSString *> *)keyPaths;

Swift

func distinctResults(usingKeyPaths keyPaths: [String]) -> RLMResults<RLMObjectType>

Parameters


                                keyPaths

The key paths used produce distinct results

Return Value

An RLMResults made distinct based on the specified key paths

Show on GitHub

Notifications


                    
                    
                    -addNotificationBlock:

Registers a block to be called each time the results collection changes.

The block will be asynchronously called with the initial results collection, and then called again after each write transaction which changes either any of the objects in the results, or which objects are in the results.

The change parameter will be nil the first time the block is called. For each call after that, it will contain information about which rows in the results collection were added, removed or modified. If a write transaction did not modify any objects in the results collection, the block is not called at all. See the RLMCollectionChange documentation for information on how the changes are reported and an example of updating a UITableView.

If an error occurs the block will be called with nil for the results parameter and a non-nil error. Currently the only errors that can occur are when opening the Realm on the background worker thread.

At the time when the block is called, the RLMResults object will be fully evaluated and up-to-date, and as long as you do not perform a write transaction on the same thread or explicitly call -[RLMRealm refresh], accessing it will never perform blocking work.

Notifications are delivered via the standard run loop, and so can’t be delivered while the run loop is blocked by other activity. When notifications can’t be delivered instantly, multiple notifications may be coalesced into a single notification. This can include the notification with the initial results. For example, the following code performs a write transaction immediately after adding the notification block, so there is no opportunity for the initial notification to be delivered first. As a result, the initial notification will reflect the state of the Realm after the write transaction.

RLMResults<Dog *> *results = [Dog allObjects];
NSLog(@"dogs.count: %zu", dogs.count); // => 0
self.token = [results addNotificationBlock:^(RLMResults *dogs,
                                             RLMCollectionChange *changes,
                                             NSError *error) {
    // Only fired once for the example
    NSLog(@"dogs.count: %zu", dogs.count); // => 1
}];
[realm transactionWithBlock:^{
    Dog *dog = [[Dog alloc] init];
    dog.name = @"Rex";
    [realm addObject:dog];
}];
// end of run loop execution context

You must retain the returned token for as long as you want updates to continue to be sent to the block. To stop receiving updates, call -invalidate on the token.

Warning

This method cannot be called during a write transaction, or when the containing Realm is read-only.

Declaration

Objective-C

- (nonnull RLMNotificationToken *)addNotificationBlock:
    (nonnull void (^)(RLMResults<RLMObjectType> *_Nullable,
                      RLMCollectionChange *_Nullable, NSError *_Nullable))block;

Swift

func addNotificationBlock(_ block: @escaping (RLMResults<RLMObjectType>?, RLMCollectionChange?, Error?) -> Void) -> RLMNotificationToken

Parameters


                                block

The block to be called whenever a change occurs.

Return Value

A token which must be held for as long as you want updates to be delivered.

Show on GitHub


                    
                    
                    -addNotificationBlock:queue:

Registers a block to be called each time the results collection changes.

Notifications are delivered on the given queue. If the queue is blocked and notifications can’t be delivered instantly, multiple notifications may be coalesced into a single notification.

You must retain the returned token for as long as you want updates to continue to be sent to the block. To stop receiving updates, call -invalidate on the token.

Warning

This method cannot be called when the containing Realm is read-only or frozen.

Warning

The queue must be a serial queue.

Declaration

Objective-C

- (nonnull RLMNotificationToken *)
    addNotificationBlock:(nonnull void (^)(RLMResults<RLMObjectType> *_Nullable,
                                           RLMCollectionChange *_Nullable,
                                           NSError *_Nullable))block
                   queue:(nullable dispatch_queue_t)queue;

Swift

func addNotificationBlock(_ block: @escaping (RLMResults<RLMObjectType>?, RLMCollectionChange?, Error?) -> Void, queue: DispatchQueue?) -> RLMNotificationToken

Parameters

`block`	The block to be called whenever a change occurs.
`queue`	The serial queue to deliver notifications to.

Return Value

A token which must be held for as long as you want updates to be delivered.

Show on GitHub

Aggregating Property Values


                    
                    
                    -minOfProperty:

Returns the minimum (lowest) value of the given property among all the objects represented by the results collection.

NSNumber *min = [results minOfProperty:@"age"];

Warning

You cannot use this method on RLMObject, RLMArray, and NSData properties.

Declaration

Objective-C

- (nullable id)minOfProperty:(nonnull NSString *)property;

Swift

func min(ofProperty property: String) -> Any?

Parameters


                                property

The property whose minimum value is desired. Only properties of types int, float, double, and NSDate are supported.

Return Value

The minimum value of the property, or nil if the Results are empty.

Show on GitHub


                    
                    
                    -maxOfProperty:

Returns the maximum (highest) value of the given property among all the objects represented by the results collection.

NSNumber *max = [results maxOfProperty:@"age"];

Warning

You cannot use this method on RLMObject, RLMArray, and NSData properties.

Declaration

Objective-C

- (nullable id)maxOfProperty:(nonnull NSString *)property;

Swift

func max(ofProperty property: String) -> Any?

Parameters


                                property

The property whose maximum value is desired. Only properties of types int, float, double, and NSDate are supported.

Return Value

The maximum value of the property, or nil if the Results are empty.

Show on GitHub


                    
                    
                    -sumOfProperty:

Returns the sum of the values of a given property over all the objects represented by the results collection.

NSNumber *sum = [results sumOfProperty:@"age"];

Warning

You cannot use this method on RLMObject, RLMArray, and NSData properties.

Declaration

Objective-C

- (nonnull NSNumber *)sumOfProperty:(nonnull NSString *)property;

Swift

func sum(ofProperty property: String) -> NSNumber

Parameters


                                property

The property whose values should be summed. Only properties of types int, float, and double are supported.

Return Value

The sum of the given property.

Show on GitHub


                    
                    
                    -averageOfProperty:

Returns the average value of a given property over the objects represented by the results collection.

NSNumber *average = [results averageOfProperty:@"age"];

Warning

You cannot use this method on RLMObject, RLMArray, and NSData properties.

Declaration

Objective-C

- (nullable NSNumber *)averageOfProperty:(nonnull NSString *)property;

Swift

func average(ofProperty property: String) -> NSNumber?

Parameters


                                property

The property whose average value should be calculated. Only properties of types int, float, and double are supported.

Return Value

The average value of the given property, or nil if the Results are empty.

Show on GitHub

Freeze

frozen
Indicates if the result are frozen.

Frozen Results are immutable and can be accessed from any thread.The objects read from a frozen Results will also be frozen.
Declaration
Objective-C

@property (nonatomic, readonly, getter=isFrozen) BOOL frozen;
Swift

var isFrozen: Bool { get }
Show on GitHub
-freeze
Returns a frozen (immutable) snapshot of these results.

The frozen copy is an immutable collection which contains the same data as this collection currently contains, but will not update when writes are made to the containing Realm. Unlike live Results, frozen Results can be accessed from any thread.

Warning
This method cannot be called during a write transaction, or when the containing Realm is read-only.

Warning
Holding onto a frozen collection for an extended period while performing write transaction on the Realm may result in the Realm file growing to large sizes. See RLMRealmConfiguration.maximumNumberOfActiveVersions for more information.
Declaration
Objective-C

- (nonnull instancetype)freeze;
Swift

func freeze() -> Self
Show on GitHub

Unavailable Methods

-init
Unavailable

RLMResults cannot be created directly

-[RLMResults init] is not available because RLMResults cannot be created directly. RLMResults can be obtained by querying a Realm.
Declaration
Objective-C

- (nonnull instancetype)init;
Show on GitHub
+new
Unavailable

RLMResults cannot be created directly

+[RLMResults new] is not available because RLMResults cannot be created directly. RLMResults can be obtained by querying a Realm.
Declaration
Objective-C

+ (nonnull instancetype)new;
Show on GitHub