List

The type of the elements contained within the collection.

The Realm which manages the list, or nil if the list is unmanaged.

Indicates if the list can no longer be accessed.

Creates a List that holds Realm model objects of type T.

Returns the index of an object in the list, or nil if the object is not present.

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

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

Returns the object at the given index (get), or replaces the object at the given index (set).

Returns the first object in the list, or nil if the list is empty.

Returns the last object in the list, or nil if the list is empty.

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

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

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

Returns a Results containing all objects matching the given predicate in the list.

Returns a Results containing all objects matching the given predicate in the list.

Returns a Results containing the objects in the list, but sorted.

Objects are sorted based on the values of the given key path. For example, to sort a list of Students from youngest to oldest based on their age property, you might call students.sorted(byKeyPath: "age", ascending: true).

Returns a Results containing the objects in the list, but sorted.

Objects are sorted based on the values of the given property. For example, to sort a list of Students from youngest to oldest based on their age property, you might call students.sorted(byProperty: "age", ascending: true).

Returns a Results containing the objects in the list, but sorted.

Returns the minimum (lowest) value of the given property among all the objects in the list, or nil if the list is empty.

Returns the maximum (highest) value of the given property among all the objects in the list, or nil if the list is empty.

Returns the sum of the values of a given property over all the objects in the list.

Returns the average value of a given property over all the objects in the list, or nil if the list is empty.

Appends the given object to the end of the list.

If the object is managed by a different Realm than the receiver, a copy is made and added to the Realm managing the receiver.

Appends the objects in the given sequence to the end of the list.

Inserts an object at the given index.

Removes an object at the given index. The object is not removed from the Realm that manages it.

Removes the last object in the list. The object is not removed from the Realm that manages it.

Removes all objects from the list. The objects are not removed from the Realm that manages them.

Replaces an object at the given index with a new object.

Moves the object at the given source index to the given destination index.

Exchanges the objects in the list at given indices.

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

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

The change parameter that is passed to the block reports, in the form of indices within the collection, which of the objects were added, removed, or modified during each write transaction. See the RealmCollectionChange documentation for more information on the change information supplied and an example of how to use it to update a UITableView.

At the time when the block is called, the collection 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 realm.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 collection.

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.

let results = realm.objects(Dog.self)
print("dogs.count: \(dogs?.count)") // => 0
let token = dogs.addNotificationBlock { changes in
    switch changes {
    case .initial(let dogs):
        // Will print "dogs.count: 1"
        print("dogs.count: \(dogs.count)")
        break
    case .update:
        // Will not be hit in this example
        break
    case .error:
        break
    }
}
try! realm.write {
    let dog = Dog()
    dog.name = "Rex"
    person.dogs.append(dog)
}
// end of run loop execution context

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

Returns a RLMIterator that yields successive elements in the List.

Replace the given subRange of elements with newElements.

The position of the first element in a non-empty collection. Identical to endIndex in an empty collection.

The collection’s past the end position. endIndex is not a valid argument to subscript, and is always reachable from startIndex by zero or more applications of successor().