オブジェクト

@objc(RealmSwiftObject)
open class Object : RLMObjectBase, RealmCollectionValue

extension Object: ObservableObject

extension Object: RealmSubscribable

extension Object: ThreadConfined

Object は、Realm モデルオブジェクトを定義するために使用されるクラスです。

Realm では、 Objectをサブクラス化し、管理するプロパティを追加することでモデルクラスを定義します。次に、 Objectクラスを直接使用するのではなく、カスタムサブクラスをインスタンス化して使用します。

class Dog: Object {
    @objc dynamic var name: String = ""
    @objc dynamic var adopted: Bool = false
    let siblings = List<Dog>()
}

サポートされているプロパティの型

String, NSString
Int
Int8, Int16, Int32, Int64
Float
Double
Bool
Date, NSDate
Data, NSData
Decimal128
ObjectId
@objc enum これはRealmEnumに準拠しているとして削除されました。
RealmOptional<Value> （任意の数値プロパティ用）
Object サブクラス（多対 1 の関係をモデル化するため）
EmbeddedObject サブクラス、1 対 1 の関係を所有するモデル化
List<Element>、多対多の関係をモデル化する

String、 NSString 、 Date 、 NSDate 、 Data 、 NSData 、 Decimal128 、 ObjectIdプロパティは任意として宣言できます。 ObjectサブクラスとEmbeddedObjectサブクラスは、任意として宣言する必要があります。 Int 、 Int8 、 Int16 、 Int32 、 Int64 、 Float 、 Double 、 Bool 、列挙、およびListプロパティは使用できません。任意の数値を保存するには、代わりにRealmOptional<Int> 、 RealmOptional<Float> 、 RealmOptional<Double> 、またはRealmOptional<Bool>を使用します。これは任意の数値をラップします。リストはまったく任意のものにはできません。

ListとRealmOptionalを除くすべてのプロパティ型は、 @objc dynamic varとして宣言する必要があります。 ListプロパティとRealmOptionalプロパティは、非動的letプロパティとして宣言する必要があります。 Swift lazyプロパティは許可されていません。

Realm によって無視されるように構成されているプロパティには、上記でリストした制限はいずれも適用されないことに注意してください。

クエリ

objects(_:)インスタンスメソッドを呼び出すと、Realm から特定のタイプのすべてのオブジェクトを検索できます。

関係

詳細については、「 Cocoa ガイド」を参照してください。

初期化子

init()
Realm オブジェクトの非マネージドインスタンスを作成します。

非マネージドオブジェクトをその Realm に追加するには、 Realmインスタンスでadd(_:)を呼び出します。

詳細は、次を参照してください:
Realm().add(_:)
宣言
Swift

public override required init()
Githubでの表示


                    
                    
                    init(value:)

Realm オブジェクトの非マネージドインスタンスを作成します。

value引数はオブジェクトにデータを入力するために使用されます。キーと値に準拠したオブジェクト、 NSJSONSerializationのメソッドから返された配列または辞書、または管理されているプロパティごとに 1 つの要素を含むArrayにすることができます。必須プロパティが存在せず、それらのプロパティがデフォルト値で定義されていない場合は、例外がスローされます。

value引数としてArrayを渡す場合、すべてのプロパティが存在し、有効で、モデルで定義されたプロパティと同じ順序にある必要があります。

非マネージドオブジェクトをその Realm に追加するには、 Realmインスタンスでadd(_:)を呼び出します。

宣言

Swift

public convenience init(value: Any)

パラメーター


                                value

オブジェクトを入力するために使用される値。

Githubでの表示

プロパティ

realm
オブジェクトを管理する Realm。オブジェクトが管理されていない場合はnil 。
宣言
Swift

public var realm: Realm? { get }
Githubでの表示
objectSchema
オブジェクトの管理対象プロパティを一覧表示するオブジェクトスキーマ。
宣言
Swift

public var objectSchema: ObjectSchema { get }
Githubでの表示
isInvalidated
オブジェクトが無効になったためアクセスできなくなっているかどうかを示します。

オブジェクトを管理する Realm からオブジェクトが削除された場合、またはその Realm でinvalidate()が呼び出された場合は、オブジェクトにアクセスできなくなります。このプロパティは、キー値を観察できます。
宣言
Swift

@objc dynamic open override var isInvalidated: Bool { get }
Githubでの表示
description
人間が判読可能なオブジェクトの説明。
宣言
Swift

open override var description: String { get }
Githubでの表示

オブジェクトカスタマイズ

primaryKey()
このメソッドをオーバーライドして、プライマリキーとして使用するプロパティの名前を指定します。

プライマリキーとして指定できるのは、 StringとIntのタイプのプロパティのみです。プライマリキープロパティでは、プロパティが設定されるたびに各値の一意性が強制されるため、マイナーなオーバーヘッドが発生します。プライマリキープロパティに対してインデックスが自動的に作成されます。
宣言
Swift

@objc open class func primaryKey() -> String?
戻り値

プライマリキーとして指定されたプロパティの名前。または、モデルにプライマリキーがない場合はnil 。

Githubでの表示
ignoredProperties()
このメソッドをオーバーライドして、無視するプロパティの名前を指定します。これらのプロパティは、オブジェクトを管理する Realm によって管理されません。
宣言
Swift

@objc open class func ignoredProperties() -> [String]
戻り値

無視するプロパティ名の配列。

Githubでの表示
indexedProperties()
インデックスを作成する必要があるプロパティのプロパティ名の配列を返します。

string 、整数、ブール値、Date、NSDate プロパティのみがサポートされます。
宣言
Swift

@objc open class func indexedProperties() -> [String]
戻り値

プロパティ名の配列。

Githubでの表示

キー値のコーディングとサブスクリプション

subscript(_:)
指定された名前のプロパティの値を返すか設定します。
宣言
Swift

@objc open subscript(key: String) -> Any? { get set }
Githubでの表示

notifications


                    
                    
                    observe(on:_:)

オブジェクトが変更されるたびに呼び出されるブロックを登録します。

ブロックは、オブジェクトを削除する、またはプロパティを既存の値に設定する自己割り当てを含む、オブジェクトの管理されているプロパティのいずれかを変更する各書込みトランザクションの後に非同期に呼び出されます。

異なるスレッドまたは異なるプロセスで実行される書込みトランザクションの場合、ブロックは管理 Realm が変更を含むバージョンに（自動）更新されたときに呼び出されますが、ローカルの書込みトランザクションでは、将来のある時点で呼び出されます書込みトランザクション (write transaction) がコミットされた場合。

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

ListやResultsとは異なり、新しい通知ブロックを追加した後に実行される初期コールバックはありません。

この方法では、Realm によって管理されているオブジェクトのみを監視できます。アップデートをブロックに送信する場合は、返されたトークンを保持する必要があります。更新の受信を停止するには、トークンでinvalidate()を呼び出します。

コールバックブロック内で監視対象オブジェクトへの強力な参照をキャプチャしても安全です。コールバックはオブジェクト自体ではなく返されたトークンによって保持されるため、保持サイクルがありません。

警告

このメソッドは、書込みトランザクション中、または Realm を含むが読み取り専用の場合に呼び出すことができません。

宣言

Swift

public func observe<T: Object>(on queue: DispatchQueue? = nil,
                               _ block: @escaping (ObjectChange<T>) -> Void) -> NotificationToken

パラメーター

`queue`	通知を受信するシリアルディスパッチキュー。 `nil`の場合、通知は現在のスレッドに配信されます。
`block`	オブジェクトに対する変更に関する情報を呼び出すブロック。

戻り値

更新を配信する限り保持する必要があるトークン。

Githubでの表示

比較


                    
                    
                    isSameObject(as:)

2 つの Realm オブジェクトが同じかどうかを返します。

オブジェクトは同じ Realm によって管理され、データベース内の同じ基礎オブジェクトを指している場合にのみ、同じと見なされます。

注意

等価比較はisEqual(_:)によって実装されています。オブジェクトタイプがプライマリキーで定義されている場合、 isEqual(_:)はこのメソッドと同じように動作します。オブジェクトタイプがプライマリキーで定義されていない場合、 isEqual(_:)はオブジェクト ID を比較するためにNSObjectの動作を使用します。このメソッドは、オブジェクトタイプがプライマリキーを定義するかどうかにかかわらず、データベースの等価性について 2 つのオブジェクトを比較するために使用できます。

宣言

Swift

public func isSameObject(as object: Object?) -> Bool

パラメーター


                                object

レシーバーを比較するオブジェクト。

Githubでの表示

オブジェクト

objectWillChange
オブジェクトが変更されるたびに Vid を発行する出版社。

名前に関係なく、コレクションが変更された後にこれが実際に発行します。
宣言
Swift

public var objectWillChange: RealmPublishers.WillChange<Object> { get }
Githubでの表示
isFrozen
このオブジェクトが固定されているかどうかを示します。

詳細は、次を参照してください:
Object.freeze()
宣言
Swift

public var isFrozen: Bool { get }
Githubでの表示
freeze()
このオブジェクトの固定（不変）スナップショットを返します。

固定されたコピーは、このオブジェクトが現在含まれているデータと同じデータを含む不変のオブジェクトですが、含まれている Realm に書込み (write) が行われた場合は更新されません。ライブオブジェクトと違い、固定オブジェクトには任意のスレッドからアクセスできます。

警告
Realm で書込みトランザクションを実行中に固定されたオブジェクトを長時間保持すると、Realm ファイルのサイズが大きくなる可能性があります。詳しくは、 Realm.Configuration.maximumNumberOfActiveVersionsを参照してください。

警告
このメソッドは、管理対象のオブジェクトでのみ呼び出せます。
宣言
Swift

public func freeze() -> Self
Githubでの表示