RealmCollectionType

public protocol RealmCollectionType: CollectionType, CustomStringConvertible

A homogenous collection of Objects which can be retrieved, filtered, sorted, and operated upon.

Properties

  • Element type contained in this collection.

    Declaration

    Swift

    typealias Element: Object
    Show on GitHub

  • The Realm the objects in this collection belong to, or nil if the collection’s owning object does not belong to a realm (the collection is standalone).

    Declaration

    Swift

    var realm: Realm? { get }
    Show on GitHub

  • Returns the number of objects in this collection.

    Declaration

    Swift

    var count: Int { get }
    Show on GitHub

  • Returns a human-readable description of the objects contained in this collection.

    Declaration

    Swift

    var description: String { get }
    Show on GitHub

Index Retrieval

  • Returns the index of the given object, or nil if the object is not in the collection.

    Declaration

    Swift

    func indexOf(object: Element) -> Int?

    Parameters

    object

    The object whose index is being queried.

    Return Value

    The index of the given object, or nil if the object is not in the collection.

    Show on GitHub

  • Returns the index of the first object matching the given predicate, or nil no objects match.

    Declaration

    Swift

    func indexOf(predicate: NSPredicate) -> Int?

    Parameters

    predicate

    The NSPredicate used to filter the objects.

    Return Value

    The index of the first matching object, or nil if no objects match.

    Show on GitHub

  • Returns the index of the first object matching the given predicate, or nil if no objects match.

    Declaration

    Swift

    func indexOf(predicateFormat: String, _ args: AnyObject...) -> Int?

    Parameters

    predicateFormat

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

    Return Value

    The index of the first matching object, or nil if no objects match.

    Show on GitHub

Filtering

  • Returns Results containing collection elements that match the given predicate.

    Declaration

    Swift

    func filter(predicateFormat: String, _ args: AnyObject...) -> Results<Element>

    Parameters

    predicateFormat

    The predicate format string which can accept variable arguments.

    Return Value

    Results containing collection elements that match the given predicate.

    Show on GitHub

  • Returns Results containing collection elements that match the given predicate.

    Declaration

    Swift

    func filter(predicate: NSPredicate) -> Results<Element>

    Parameters

    predicate

    The predicate to filter the objects.

    Return Value

    Results containing collection elements that match the given predicate.

    Show on GitHub

Sorting

  • Returns Results containing collection elements sorted by the given property.

    Declaration

    Swift

    func sorted(property: String, ascending: Bool) -> Results<Element>

    Parameters

    property

    The property name to sort by.
    ascending

    The direction to sort by.

    Return Value

    Results containing collection elements sorted by the given property.

    Show on GitHub

  • Returns Results with elements sorted by the given sort descriptors.

    Declaration

    Swift

    func sorted<S: SequenceType where S.Generator.Element == SortDescriptor>(sortDescriptors: S) -> Results<Element>

    Parameters

    sortDescriptors

    SortDescriptors to sort by.

    Return Value

    Results with elements sorted by the given sort descriptors.

    Show on GitHub

Aggregate Operations

  • Returns the minimum value of the given property.

    Warning

    Only names of properties of a type conforming to the MinMaxType protocol can be used.

    Declaration

    Swift

    func min<U: MinMaxType>(property: String) -> U?

    Parameters

    property

    The name of a property conforming to MinMaxType to look for a minimum on.

    Return Value

    The minimum value for the property amongst objects in the collection, or nil if the collection is empty.

    Show on GitHub

  • Returns the maximum value of the given property.

    Warning

    Only names of properties of a type conforming to the MinMaxType protocol can be used.

    Declaration

    Swift

    func max<U: MinMaxType>(property: String) -> U?

    Parameters

    property

    The name of a property conforming to MinMaxType to look for a maximum on.

    Return Value

    The maximum value for the property amongst objects in the collection, or nil if the collection is empty.

    Show on GitHub

  • Returns the sum of the given property for objects in the collection.

    Warning

    Only names of properties of a type conforming to the AddableType protocol can be used.

    Declaration

    Swift

    func sum<U: AddableType>(property: String) -> U

    Parameters

    property

    The name of a property conforming to AddableType to calculate sum on.

    Return Value

    The sum of the given property over all objects in the collection.

    Show on GitHub

  • Returns the average of the given property for objects in the collection.

    Warning

    Only names of properties of a type conforming to the AddableType protocol can be used.

    Declaration

    Swift

    func average<U: AddableType>(property: String) -> U?

    Parameters

    property

    The name of a property conforming to AddableType to calculate average on.

    Return Value

    The average of the given property over all objects in the collection, or nil if the collection is empty.

    Show on GitHub

Key-Value Coding

  • Returns an Array containing the results of invoking valueForKey(_:) using key on each of the collection’s objects.

    Declaration

    Swift

    func valueForKey(key: String) -> AnyObject?

    Parameters

    key

    The name of the property.

    Return Value

    Array containing the results of invoking valueForKey(_:) using key on each of the collection’s objects.

    Show on GitHub

  • Returns an Array containing the results of invoking valueForKeyPath(_:) using keyPath on each of the collection’s objects.

    Declaration

    Swift

    func valueForKeyPath(keyPath: String) -> AnyObject?

    Parameters

    keyPath

    The key path to the property.

    Return Value

    Array containing the results of invoking valueForKeyPath(_:) using keyPath on each of the collection’s objects.

    Show on GitHub

  • Invokes setValue(_:forKey:) on each of the collection’s objects using the specified value and key.

    Warning

    This method can only be called during a write transaction.

    Declaration

    Swift

    func setValue(value: AnyObject?, forKey key: String)

    Parameters

    value

    The object value.
    key

    The name of the property.
    Show on GitHub