RLMSortDescriptor

@interface RLMSortDescriptor : NSObject

An RLMSortDescriptor stores a property name and a sort order for use with sortedResultsUsingDescriptors:. It is similar to NSSortDescriptor, but supports only the subset of functionality which can be efficiently run by Realm’s query engine.

RLMSortDescriptor instances are immutable.

Properties

  • The key path which the sort descriptor orders results by.

    Declaration

    Objective-C

    @property (readonly, nonatomic) NSString *_Nonnull keyPath;

    Swift

    var keyPath: String { get }
    Show on GitHub

  • Whether the descriptor sorts in ascending or descending order.

    Declaration

    Objective-C

    @property (readonly, nonatomic) BOOL ascending;

    Swift

    var ascending: Bool { get }
    Show on GitHub

Methods

  • Returns a new sort descriptor for the given key path and sort direction.

    Declaration

    Objective-C

    + (nonnull instancetype)sortDescriptorWithKeyPath:(nonnull NSString *)keyPath
                                        ascending:(BOOL)ascending;

    Swift

    convenience init(keyPath: String, ascending: Bool)
    Show on GitHub

  • Returns a copy of the receiver with the sort direction reversed.

    Declaration

    Objective-C

    - (nonnull instancetype)reversedSortDescriptor;

    Swift

    func reversed() -> Self
    Show on GitHub

Deprecated

  • The name of the property which the sort descriptor orders results by.

    Declaration

    Objective-C

    @property (readonly, nonatomic) NSString *_Nonnull property;

    Swift

    var property: String { get }
    Show on GitHub

  • Returns a new sort descriptor for the given property name and sort direction.

    Declaration

    Objective-C

    + (nonnull instancetype)sortDescriptorWithProperty:
                            (nonnull NSString *)propertyName
                                         ascending:(BOOL)ascending;

    Swift

    convenience init(property propertyName: String, ascending: Bool)
    Show on GitHub