RealmSectionedResult

セクション化された結果のコレクションが変更されるたびに呼び出されるブロックを登録します。

ブロックは最初のセクション化された結果のコレクションとは非同期に呼び出され、セクション化された結果コレクション内のいずれかのオブジェクト、またはセクション化された結果コレクション内のどのオブジェクトを変更するたびに、再度呼び出されます。

ブロックに渡されるchangeパラメータは、各書込みトランザクション中に追加、削除、または変更されたオブジェクトをコレクション内のインデックスの形式で報告します。 提供される変更情報の詳細と、その変更情報を使用してUITableViewをアップデートする方法の例については、 SectionedResultsChangeのドキュメントを参照してください。

ブロックが呼び出される時点で、コレクションは完全に評価され、最新の状態になります。また、同じスレッドで書込みトランザクションを実行したり、 realm.refresh()を明示的に呼び出したりしない限り、アクセスに関するブロッキングは実行されません動作する。

キューが指定されていない場合、通知は標準の実行ループを介して配信されるため、実行ループが他のアクティビティによってブロックされている間は通知を配信できません。 キューが指定されている場合、代わりにそのキューに通知が配信されます。 通知をすぐに配信できない場合は、複数の通知が 1 つの通知に統合されることがあります。 これには、最初のセクション化された結果コレクションに 通知を含めることができます。

たとえば、次のコードは通知ブロックを追加した後すぐに書込みトランザクションを実行するため、最初の通知が最初に配信される可能性はありません。 その結果、最初の通知には、書込みトランザクション後の Realm の状態が反映されます。

let dogs = realm.objects(Dog.self)
let sectionedResults = dogs.sectioned(by: \.age, ascending: true)
print("sectionedResults.count: \(sectionedResults?.count)") // => 0
let token = sectionedResults.observe { changes in
    switch changes {
    case .initial(let sectionedResults):
        // Will print "sectionedResults.count: 1"
        print("sectionedResults.count: \(sectionedResults.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

キー パスが指定されていない場合、ブロックは、すべてのオブジェクト プロパティとネストされたリンクされたオブジェクトのプロパティの挿入、変更、または削除時に実行されます。 キー パスが指定されている場合、指定されたキー パスでのみ発生する変更に対してブロックが呼び出されます。 たとえば、次の場合:

class Dog: Object {
    @Persisted var name: String
    @Persisted var age: Int
    @Persisted var toys: List<Toy>
}
// ...
let dogs = realm.objects(Dog.self)
let sectionedResults = dogs.sectioned(by: \.age, ascending: true)
let token = sectionedResults.observe(keyPaths: ["name"]) { changes in
    switch changes {
    case .initial(let sectionedResults):
       // ...
    case .update:
       // This case is hit:
       // - after the token is initialized
       // - when the name property of an object in the
       // collection is modified
       // - when an element is inserted or removed
       //   from the collection.
       // This block is not triggered:
       // - when a value other than name is modified on
       //   one of the elements.
    case .error:
        // ...
    }
}
// end of run loop execution context

• 確認されたキー パスが ["toys.brand"] の場合、コレクションの要素の いずれか にある toys リストへの挿入または削除によってブロックがtriggerされます。 このコレクション内の Dog にリンクされている Toy の brand 値を変更すると、ブロックがtriggerされます。 このコレクション内の Dog にリンクされている Toy の brand 以外の値を変更しても、ブロックはtriggerされません。 監視対象の Dog 型コレクションへの挿入または削除によって通知がtriggerされます。
• 上記の例で ["toys"] キー パスが確認された場合、コレクション内の任意の要素の toys リストへの挿入、削除、または変更によってブロックがtriggerされます。 このコレクション内の にリンクされているToy Dogの値を変更しても、ブロックはtrigger され ません 。監視対象の Dog 型コレクションへの挿入または削除によって通知がtriggerされます。

• セクション キー パス プロパティを変更すると、セクション内のオブジェクトの位置が変更されたり、セクションが完全に変更されたりすると、通知がtriggerされます。

アップデートをブロックに送信する場合は、返されたトークンを保持する必要があります。 更新の受信を停止するには、トークンでinvalidate()を呼び出します。

セクション化された結果のコレクションが変更されるたびに呼び出されるブロックを登録します。

ブロックは最初のセクション化された結果のコレクションとは非同期に呼び出され、セクション化された結果コレクション内のいずれかのオブジェクト、またはセクション化された結果コレクション内のどのオブジェクトを変更するたびに、再度呼び出されます。

ブロックに渡されるchangeパラメータは、各書込みトランザクション中に追加、削除、または変更されたオブジェクトをコレクション内のインデックスの形式で報告します。 提供される変更情報の詳細と、その変更情報を使用してUITableViewをアップデートする方法の例については、 SectionedResultsChangeのドキュメントを参照してください。

ブロックが呼び出される時点で、コレクションは完全に評価され、最新の状態になります。また、同じスレッドで書込みトランザクションを実行したり、 realm.refresh()を明示的に呼び出したりしない限り、アクセスに関するブロッキングは実行されません動作する。

キューが指定されていない場合、通知は標準の実行ループを介して配信されるため、実行ループが他のアクティビティによってブロックされている間は通知を配信できません。 キューが指定されている場合、代わりにそのキューに通知が配信されます。 通知をすぐに配信できない場合は、複数の通知が 1 つの通知に統合されることがあります。 これには、最初のセクション化された結果コレクションに 通知を含めることができます。

たとえば、次のコードは通知ブロックを追加した後すぐに書込みトランザクションを実行するため、最初の通知が最初に配信される可能性はありません。 その結果、最初の通知には、書込みトランザクション後の Realm の状態が反映されます。

let dogs = realm.objects(Dog.self)
let sectionedResults = dogs.sectioned(by: \.age, ascending: true)
print("sectionedResults.count: \(sectionedResults?.count)") // => 0
let token = sectionedResults.observe { changes in
    switch changes {
    case .initial(let sectionedResults):
        // Will print "sectionedResults.count: 1"
        print("sectionedResults.count: \(sectionedResults.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

キー パスが指定されていない場合、ブロックは、すべてのオブジェクト プロパティとネストされたリンクされたオブジェクトのプロパティの挿入、変更、または削除時に実行されます。 キー パスが指定されている場合、指定されたキー パスでのみ発生する変更に対してブロックが呼び出されます。 たとえば、次の場合:

class Dog: Object {
    @Persisted var name: String
    @Persisted var age: Int
    @Persisted var toys: List<Toy>
}
// ...
let dogs = realm.objects(Dog.self)
let sectionedResults = dogs.sectioned(by: \.age, ascending: true)
let token = sectionedResults.observe(keyPaths: ["name"]) { changes in
    switch changes {
    case .initial(let sectionedResults):
       // ...
    case .update:
       // This case is hit:
       // - after the token is initialized
       // - when the name property of an object in the
       // collection is modified
       // - when an element is inserted or removed
       //   from the collection.
       // This block is not triggered:
       // - when a value other than name is modified on
       //   one of the elements.
    case .error:
        // ...
    }
}
// end of run loop execution context

• 確認されたキー パスが ["toys.brand"] の場合、コレクションの要素の いずれか にある toys リストへの挿入または削除によってブロックがtriggerされます。 このコレクション内の Dog にリンクされている Toy の brand 値を変更すると、ブロックがtriggerされます。 このコレクション内の Dog にリンクされている Toy の brand 以外の値を変更しても、ブロックはtriggerされません。 監視対象の Dog 型コレクションへの挿入または削除によって通知がtriggerされます。
• 上記の例で ["toys"] キー パスが確認された場合、コレクション内の任意の要素の toys リストへの挿入、削除、または変更によってブロックがtriggerされます。 このコレクション内の にリンクされているToy Dogの値を変更しても、ブロックはtrigger され ません 。監視対象の Dog 型コレクションへの挿入または削除によって通知がtriggerされます。

• セクション キー パス プロパティを変更すると、セクション内のオブジェクトの位置が変更されたり、セクションが完全に変更されたりすると、通知がtriggerされます。

アップデートをブロックに送信する場合は、返されたトークンを保持する必要があります。 更新の受信を停止するには、トークンでinvalidate()を呼び出します。