RLMResults Class Reference
| Declared in | RLMResults.h |
Overview
RLMResults is an auto-updating container type in Realm returned from object queries.
RLMResults can be queried with the same predicates as RLMObject and RLMArray and you can chain queries to further filter query results.
RLMResults cannot be created directly.
Tasks
RLMResults Properties
-
countproperty -
objectClassNameproperty -
realmproperty
Accessing Objects from an RLMResults
Querying Results
-
– indexOfObject: -
– indexOfObjectWhere: -
– indexOfObjectWithPredicate: -
– objectsWhere: -
– objectsWithPredicate: -
– sortedResultsUsingProperty:ascending: -
– sortedResultsUsingDescriptors:
Aggregating Property Values
Unavailable Methods
Properties
count
Number of objects in the results.
@property (nonatomic, readonly, assign) NSUInteger countDeclared In
RLMResults.hClass Methods
new
[RLMResults new] is not available because RLMResults cannot be created directly. RLMResults can be obtained by querying a Realm.
+ (instancetype)newDeclared In
RLMResults.hInstance Methods
averageOfProperty:
Returns the average of a given property for objects in an RLMResults.
- (nullable NSNumber *)averageOfProperty:(NSString *)propertyParameters
- property
The property to calculate average on. Only properties of type int, float and double are supported.
Return Value
The average for the given property amongst objects in an RLMResults. This will be of type double for both float and double properties.
Discussion
NSNumber *average = [results averageOfProperty:@“age”];
Declared In
RLMResults.hfirstObject
Returns the first object in the results.
- (nullable RLMObjectType)firstObjectReturn Value
An RLMObject of the class contained by this RLMResults.
Discussion
Returns nil if called on an empty RLMResults.
Declared In
RLMResults.hindexOfObject:
Gets the index of an object.
- (NSUInteger)indexOfObject:(RLMObjectArgument)objectParameters
- object
An object (of the same type as returned from the objectClassName selector).
Discussion
Returns NSNotFound if the object is not found in this RLMResults.
Declared In
RLMResults.hindexOfObjectWhere:
Gets the index of the first object matching the predicate.
- (NSUInteger)indexOfObjectWhere:(NSString *)predicateFormat, ...Parameters
- predicateFormat
The predicate format string which can accept variable arguments.
Return Value
Index of object or NSNotFound if the object is not found in this RLMResults.
Declared In
RLMResults.hindexOfObjectWithPredicate:
Gets the index of the first object matching the predicate.
- (NSUInteger)indexOfObjectWithPredicate:(NSPredicate *)predicateParameters
- predicate
The predicate to filter the objects.
Return Value
Index of object or NSNotFound if the object is not found in this RLMResults.
Declared In
RLMResults.hinit
[RLMResults init] is not available because RLMResults cannot be created directly. RLMResults can be obtained by querying a Realm.
- (instancetype)initDeclared In
RLMResults.hlastObject
Returns the last object in the results.
- (nullable RLMObjectType)lastObjectReturn Value
An RLMObject of the class contained by this RLMResults.
Discussion
Returns nil if called on an empty RLMResults.
Declared In
RLMResults.hmaxOfProperty:
Returns the maximum (highest) value of the given property of objects in an RLMResults
- (nullable id)maxOfProperty:(NSString *)propertyParameters
- property
The property to look for a maximum on. Only properties of type int, float, double and NSDate are supported.
Return Value
The maximum value for the property amongst objects in an RLMResults
Discussion
NSNumber *max = [results maxOfProperty:@“age”];
Declared In
RLMResults.hminOfProperty:
Returns the minimum (lowest) value of the given property
- (nullable id)minOfProperty:(NSString *)propertyParameters
- property
The property to look for a minimum on. Only properties of type int, float, double and NSDate are supported.
Return Value
The minimum value for the property amongst objects in an RLMResults.
Discussion
NSNumber *min = [results minOfProperty:@“age”];
Declared In
RLMResults.hobjectAtIndex:
Returns the object at the index specified.
- (RLMObjectType)objectAtIndex:(NSUInteger)indexParameters
- index
The index to look up.
Return Value
An RLMObject of the class contained by this RLMResults.
Declared In
RLMResults.hobjectsWhere:
Get objects matching the given predicate in the RLMResults.
- (RLMResults RLM_GENERIC_RETURN *)objectsWhere:(NSString *)predicateFormat, ...Parameters
- predicateFormat
The predicate format string which can accept variable arguments.
Return Value
An RLMResults of objects that match the given predicate
Declared In
RLMResults.hobjectsWithPredicate:
Get objects matching the given predicate in the RLMResults.
- (RLMResults RLM_GENERIC_RETURN *)objectsWithPredicate:(NSPredicate *)predicateParameters
- predicate
The predicate to filter the objects.
Return Value
An RLMResults of objects that match the given predicate
Declared In
RLMResults.hsortedResultsUsingDescriptors:
Get a sorted RLMResults from an existing RLMResults sorted by an NSArray`` ofRLMSortDescriptor`s.
- (RLMResults RLM_GENERIC_RETURN *)sortedResultsUsingDescriptors:(NSArray *)propertiesParameters
- properties
An array of
RLMSortDescriptors to sort by.
Return Value
An RLMResults sorted by the specified properties.
Declared In
RLMResults.hsortedResultsUsingProperty:ascending:
Get a sorted RLMResults from an existing RLMResults sorted by a property.
- (RLMResults RLM_GENERIC_RETURN *)sortedResultsUsingProperty:(NSString *)property ascending:(BOOL)ascendingParameters
- property
The property name to sort by.
- ascending
The direction to sort by.
Return Value
An RLMResults sorted by the specified property.
Declared In
RLMResults.hsumOfProperty:
Returns the sum of the given property for objects in an RLMResults.
- (NSNumber *)sumOfProperty:(NSString *)propertyParameters
- property
The property to calculate sum on. Only properties of type int, float and double are supported.
Return Value
The sum of the given property over all objects in an RLMResults.
Discussion
NSNumber *sum = [results sumOfProperty:@“age”];
Declared In
RLMResults.h