RealmCollection
public protocol RealmCollection : RealmCollectionBase
検索、フィルタリング、並べ替え、操作可能なObject
の同義語コレクション。
-
コレクションを管理する Realm、または管理されていないコレクションの場合は
nil
。宣言
Swift
var realm: Realm? { get }
-
コレクションがアクセスできなくなっているかどうかを示します。
コレクションを管理する
Realm
でinvalidate()
が呼び出された場合、コレクションにアクセスできなくなります。宣言
Swift
var isInvalidated: Bool { get }
-
コレクション内のオブジェクトの数。
宣言
Swift
var count: Int { get }
-
コレクションに含まれるオブジェクトの、人間が判読可能な説明。
宣言
Swift
var description: String { get }
-
コレクション内のオブジェクトのインデックスを返します。オブジェクトが存在しない場合は
nil
を返します。宣言
Swift
func index(of object: Element) -> Int?
パラメーター
object
オブジェクト。
-
述語に一致する最初のオブジェクトのインデックスを返します。一致するオブジェクトがない場合は
nil
を返します。宣言
Swift
func index(matching predicate: NSPredicate) -> Int?
パラメーター
predicate
オブジェクトをフィルタリングするために使用する述語。
-
index(matching:
デフォルトの実装_: ) 述語に一致する最初のオブジェクトのインデックスを返します。一致するオブジェクトがない場合は
nil
を返します。デフォルトの実装
指定された述語に一致する最初のオブジェクトのインデックスを返します。一致するオブジェクトがない場合は
nil
を返します。宣言
Swift
func index(matching predicateFormat: String, _ args: Any...) -> Int?
パラメーター
predicateFormat
述語形式の string 。オプションで、その後に変数の数の引数が続きます。
-
filter(_:
デフォルトの実装_: )
-
コレクション内のオブジェクトを含む
Results
をソートされた状態で返します。オブジェクトは、指定されたキー パスの値に基づいてソートされます。 たとえば、
Student
のコレクションをage
プロパティに基づいて、小さいものから古い順に並べ替えるには、students.sorted(byKeyPath: "age", ascending: true)
を呼び出します。警告
コレクションは、ブール値、
Date
、NSDate
、単一および倍精度浮動小数点、整数、およびstring型のプロパティでのみソートできます。宣言
Swift
func sorted(byKeyPath keyPath: String, ascending: Bool) -> Results<Element>
パラメーター
keyPath
ソートするキー パス。
ascending
並べ替える方向。
-
コレクション内のオブジェクトを含む
Results
をソートされた状態で返します。警告
コレクションは、ブール値、
Date
、NSDate
、単一および倍精度浮動小数点、整数、およびstring型のプロパティでのみソートできます。詳細は、次を参照してください:
宣言
Swift
func sorted<S>(by sortDescriptors: S) -> Results<Element> where S : Sequence, S.Element == SortDescriptor
パラメーター
sortDescriptors
並べ替える
SortDescriptor
のシーケンス。
-
コレクション内のすべてのオブジェクト間で指定されたプロパティの最小(最小)値を返します。コレクションが空の場合は
nil
を返します。警告
MinMaxType
プロトコルに準拠するタイプのプロパティのみを指定できます。宣言
Swift
func min<T>(ofProperty property: String) -> T? where T : MinMaxType
パラメーター
property
最小値が必要なプロパティの名前。
-
コレクション内のすべてのオブジェクト間で指定されたプロパティの最大値(最高値)を返します。コレクションが空の場合は
nil
を返します。警告
MinMaxType
プロトコルに準拠するタイプのプロパティのみを指定できます。宣言
Swift
func max<T>(ofProperty property: String) -> T? where T : MinMaxType
パラメーター
property
最小値が必要なプロパティの名前。
-
コレクション内のオブジェクトの指定された プロパティの合計を返します。コレクションが空の場合は
nil
です。警告
AddableType
プロトコルに準拠した型のプロパティ名のみを使用できます。宣言
Swift
func sum<T>(ofProperty property: String) -> T where T : AddableType
パラメーター
property
合計を計算するための
AddableType
に準拠したプロパティの名前。 -
コレクション内のすべてのオブジェクトにわたる指定されたプロパティの平均値を返します。コレクションが空の場合は
nil
を返します。警告
AddableType
プロトコルに準拠するタイプのプロパティのみを指定できます。宣言
Swift
func average<T>(ofProperty property: String) -> T? where T : AddableType
パラメーター
property
値を合計するプロパティの名前。
-
コレクションの各オブジェクトで
key
を使用してvalueForKey(_:)
を呼び出した結果を含むArray
を返します。宣言
Swift
func value(forKey key: String) -> Any?
パラメーター
key
値が必要なプロパティの名前。
-
コレクションの各オブジェクトで
keyPath
を使用してvalueForKeyPath(_:)
を呼び出した結果を含むArray
を返します。宣言
Swift
func value(forKeyPath keyPath: String) -> Any?
パラメーター
keyPath
値が必要なプロパティへのキー パス。
-
指定された
value
とkey
を使用して、コレクション内の各オブジェクトでsetValue(_:forKey:)
を呼び出します。警告
このメソッドは、書込みトランザクション中にのみ呼び出されます。
宣言
Swift
func setValue(_ value: Any?, forKey key: String)
パラメーター
value
オブジェクト値。
key
各オブジェクトに値を設定するプロパティの名前。
-
コレクションが変更されるたびに呼び出されるブロックを登録します。
ブロックは初期結果とは非同期に呼び出され、コレクション内のいずれかのオブジェクトまたはコレクション内のどのオブジェクトのいずれかを変更する書込みトランザクションごとに再度呼び出されます。
ブロックに渡される
change
パラメータは、各書込みトランザクション中に追加、削除、または変更されたオブジェクトをコレクション内のインデックスの形式で報告します。 提供される変更情報の詳細と、その変更情報を使用してUITableView
をアップデートする方法の例については、RealmCollectionChange
のドキュメントを参照してください。ブロックが呼び出される時点で、コレクションは完全に評価され、最新の状態になります。また、同じスレッドで書込みトランザクションを実行したり、
realm.refresh()
を明示的に呼び出したりしない限り、アクセスに関するブロッキングは実行されません動作する。キューが指定されていない場合、通知は標準の実行ループを介して配信されるため、実行ループが他のアクティビティによってブロックされている間は通知を配信できません。 キューが指定されている場合、代わりにそのキューに通知が配信されます。 通知をすぐに配信できない場合は、複数の通知が 1 つの通知に統合されることがあります。 これには、初期コレクションの通知を含めることができます。
たとえば、次のコードは通知ブロックを追加した後すぐに書込みトランザクションを実行するため、最初の通知が最初に配信される可能性はありません。 その結果、最初の通知には、書込みトランザクション後の Realm の状態が反映されます。
let results = realm.objects(Dog.self) print("dogs.count: \(dogs?.count)") // => 0 let token = dogs.observe { 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
アップデートをブロックに送信する場合は、返されたトークンを保持する必要があります。 更新の受信を停止するには、トークンで
invalidate()
を呼び出します。警告
このメソッドは、書込みトランザクション中、または Realm を含む が読み取り専用の場合に呼び出すことができません。
宣言
Swift
func observe(on queue: DispatchQueue?, _ block: @escaping (RealmCollectionChange<Self>) -> Void) -> NotificationToken
パラメーター
queue
通知を受信するシリアル ディスパッチ キュー。
nil
の場合、通知は現在のスレッドに配信されます。block
変更が発生するたびに呼び出されるブロック。
戻り値
更新を配信する限り保持する必要があるトークン。
-
このコレクションが固定されている場合は を返します
宣言
Swift
var isFrozen: Bool { get }
-
このコレクションの固定(不変)スナップショットを返します。
固定されたコピーは、このコレクションに現在含まれているデータと同じデータを含む不変のコレクションですが、含まれている Realm への書込み (write) が行われても更新されません。 ライブコレクションとは異なり、固定コレクションには任意のスレッドからアクセスできます。
警告
このメソッドは、書込みトランザクション中、または Realm を含む が読み取り専用の場合に呼び出すことができません。警告
Realm で書込みトランザクションを実行中に固定されたコレクションを長時間保持すると、Realm ファイルのサイズが大きくなる可能性があります。 詳しくは、Realm.Configuration.maximumNumberOfActiveVersions
を参照してください。宣言
Swift
func freeze() -> Self
-
この固定されたコレクションのライブ(可変)バージョンを返します。
このメソッドは、同じ固定コレクションのライブ コピーへの参照を解決します。 ライブ コレクションで呼び出されると、 は自分自身を返します。
宣言
Swift
func thaw() -> Self?
-
objectWillChange
拡張メソッドコレクションが変更されるたびに Vid を発行する出版社。
名前に関係なく、コレクションが変更された後にこれが実際に発行します。
宣言
Swift
public var objectWillChange: RealmPublishers.WillChange<Self> { get }
-
collectionPublisher
拡張メソッドコレクションが変更されるたびにコレクションを発行する出版社。
宣言
Swift
public var collectionPublisher: RealmPublishers.Value<Self> { get }
-
changesetPublisher
拡張メソッドコレクションが変更されるたびにコレクションの変更セットを発行する出版社。
宣言
Swift
public var changesetPublisher: RealmPublishers.CollectionChangeset<Self> { get }
-
sum()
拡張メソッドコレクション内の 値の合計を返します。コレクションが空の場合は
nil
を返します。宣言
Swift
func sum() -> Element
-
average()
拡張メソッドコレクション内のすべての値の平均を返します。
宣言
Swift
func average<T>() -> T? where T : AddableType
-
sum()
拡張メソッドコレクション内の 値の合計を返します。コレクションが空の場合は
nil
を返します。宣言
Swift
func sum() -> Element.Wrapped
-
average()
拡張メソッドコレクション内のすべての値の平均を返します。
宣言
Swift
func average<T>() -> T? where T : AddableType
-
sorted(ascending:
拡張メソッド)
-
sorted(ascending:
拡張メソッド)