タイプエイリアス

次の型エイリアスはグローバルで使用できます。

Aliases

  • PropertyType は、Realm モデルでサポートされているすべてのプロパティ タイプを説明する列挙型です。

    詳細については、「 Realm モデル」を参照してください。

    プリミティブの型

    • Int
    • Bool
    • Float
    • Double

    オブジェクト タイプ

    関係: 配列(Swift、 List )とObject

    宣言

    Swift

    public typealias PropertyType = RLMPropertyType
  • Realm への変更をサブスクライブするメソッドから返されるオペレーターのトークン。

    詳細は、次を参照してください:

    Realm.observe(_:)

    宣言

    Swift

    public typealias NotificationToken = RLMNotificationToken
  • Realm App の構成を表すオブジェクト

    詳細は、次を参照してください:

    RLMAppConfiguration

    宣言

    Swift

    public typealias AppConfiguration = RLMAppConfiguration
  • Realm Cloud ユーザー API キーでネットワーク呼び出しを実行するクライアントを表すオブジェクト

    詳細は、次を参照してください:

    RLMAPIKeyAuth

    宣言

    Swift

    public typealias APIKeyAuth = RLMAPIKeyAuth
  • Realm Cloud ユーザー登録およびパスワード機能に対してネットワーク呼び出しを実行するクライアントを表すオブジェクト

    詳細は、次を参照してください:

    RLMEmailPasswordAuth

    宣言

    Swift

    public typealias EmailPasswordAuth = RLMEmailPasswordAuth
  • エラーを報告するために使用されるブロックの種類

    宣言

    Swift

    public typealias EmailPasswordAuthOptionalErrorBlock = RLMEmailPasswordAuthOptionalErrorBlock
  • 通知をプッシュするデバイスを登録するために、Realm Cloud でネットワーク呼び出しを実行するクライアントを表すオブジェクト

    詳細は、次を参照してください:

    詳細は、次を参照してください: RLMPushClient

    宣言

    Swift

    public typealias PushClient = RLMPushClient
  • ユーザー APIKeyProviderClient 内で使用されるオブジェクト

    宣言

    Swift

    public typealias UserAPIKey = RLMUserAPIKey
  • App

    Appには、Realm アプリケーション バックエンドで通信するための基本セットがあります。 このインターフェースは、ログインと認証へのアクセスを提供します。

    宣言

    Swift

    public typealias App = RLMApp
  • この委任を使用して、認証が成功または失敗したときにコールバックを提供します

    宣言

    Swift

    @available(macOS 10.15, watchOS 6.0, iOS 13.0, iOSApplicationExtension 13.0, macOSApplicationExtension 10.15, tvOS 13.0, *)
    public typealias ASLoginDelegate = RLMASLoginDelegate
  • BSONドキュメントを表す辞書オブジェクト。

    宣言

    Swift

    public typealias Document = Dictionary<String, AnyBSON?>
  • MaxKey は、他の BSON types と比較すると、常に最大値になります

    宣言

    Swift

    public typealias MaxKey = RLMMaxKey
  • MinKey は、他のBSON typesと比較すると、常に最小値になります

    宣言

    Swift

    public typealias MinKey = RLMMinKey
  • 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
    • UUID
    • @objc enum これはRealmEnumに準拠しているとして削除されました。
    • RealmOptional<Value> (任意の数値プロパティ用)
    • Object サブクラス(多対 1 の関係をモデル化するため)
    • EmbeddedObject サブクラス、1 対 1 の関係を所有するモデル化
    • List<Element>、多対多の関係をモデル化する

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

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

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

    クエリ

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

    関係

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

    宣言

    Swift

    public typealias Object = RealmSwiftObject
  • EmbeddedObject は、埋め込み Realm モデル オブジェクトを定義するために使用される基本クラスです。

    埋め込みオブジェクトは通常のオブジェクトと同様に機能しますが、単一の親オブジェクト(それ自体が埋め込まれる場合)によって所有されます。 通常の最上位オブジェクトとは異なり、埋め込みオブジェクトを で直接作成したり、Realm に追加したりすることはできません。 代わりに、親オブジェクトの一部として、または管理されていないオブジェクトを親オブジェクトの プロパティに割り当てた場合にのみ作成できます。 埋め込みオブジェクトは、親オブジェクトが削除されるか、親が埋め込みオブジェクトを指すように変更されると、 オブジェクト プロパティを再割り当てするか、それを含むリストから埋め込みオブジェクトを削除して、自動的に削除されます。

    埋め込みオブジェクトには、それらにリンクする親オブジェクトが 1 つだけあるため、既存の管理対象オブジェクトにリンクしようとすると例外がスローされます。

    EmbeddedObjectでサポートされているプロパティ タイプはObjectと同じですが、埋め込みオブジェクトが最上位オブジェクトにリンクできないため、 ObjectList<Object>プロパティはサポートされていません( EmbeddedObjectList<EmbeddedObject>)です。

    埋め込みオブジェクトにはプライマリキーまたはインデックス付きプロパティを含めることはできません。

    class Owner: Object {
        @objc dynamic var name: String = ""
        let dogs = List<Dog>()
    }
    class Dog: EmbeddedObject {
        @objc dynamic var name: String = ""
        @objc dynamic var adopted: Bool = false
        let owner = LinkingObjects(fromType: Owner.self, property: "dogs")
    }
    

    宣言

    Swift

    public typealias EmbeddedObject = RealmSwiftEmbeddedObject
  • Realm の移行に使用される移行ブロックのタイプ。

    宣言

    Swift

    public typealias MigrationBlock = (_ migration: Migration, _ oldSchemaVersion: UInt64) -> Void

    パラメーター

    migration

    移行を実行するために使用されるMigrationオブジェクト。 移行オブジェクトを使用すると、移行を必要とする既存のオブジェクトを列挙して変更できます。

    oldSchemaVersion

    移行される Realm のスキーマ バージョン。

  • 移行中に使用されるオブジェクトクラス。

    宣言

    Swift

    public typealias MigrationObject = DynamicObject
  • Realm 内のオブジェクトの古いバージョンと新しいバージョンの両方を提供するブロック タイプ。 オブジェクト プロパティには、サブスクリプションを使用してのみアクセスできます。

    宣言

    Swift

    public typealias MigrationObjectEnumerateBlock = (_ oldObject: MigrationObject?, _ newObject: MigrationObject?) -> Void

    パラメーター

    oldObject

    元の Realm のオブジェクト(読み取り専用)。

    newObject

    移行された Realm の オブジェクト(読み取りおよび書込み)。

  • MongoClientでは、Realm Cloud サービスを介して MongoDB database の読み取りと書込みが可能になります。

    これにより、 MongoDatabaseのインスタンスへのアクセスが提供されます。これにより、データを保持する特定のMongoCollectionへのアクセスが提供されます。

    注意

    データの読み取りまたは書き込みを行う前に、ユーザーはログインする必要があります。

    次も参照してください

    App, MongoDatabase, MongoCollection

    宣言

    Swift

    public typealias MongoClient = RLMMongoClient
  • MongoDatabaseは、データを含むコレクションのグループを保持する MongoDB database を表します。

    MongoClientから取得できます。

    これを使用して、データの読み取りと書き込み用のMongoCollectionを取得します。

    注意

    データの読み取りや書き込みを行う前に、ユーザーは にログインする必要があります。

    次も参照してください

    MongoClient, MongoCollection

    宣言

    Swift

    public typealias MongoDatabase = RLMMongoDatabase
  • MongoCollectionfindコマンドを実行するときに使用するオプション。

    宣言

    Swift

    public typealias FindOptions = RLMFindOptions
  • MongoCollectionfindOneAndUpdatefindOneAndReplace 、またはfindOneAndDeleteコマンドを実行するときに使用するオプション。

    宣言

    Swift

    public typealias FindOneAndModifyOptions = RLMFindOneAndModifyOptions
  • updateOneまたはupdateMany操作の結果MongoCollection

    宣言

    Swift

    public typealias UpdateResult = RLMUpdateResult
  • 正常に挿入が行われた場合は Result.success(DocumentId) を返すブロック、または Result.failure(error) は

    宣言

    Swift

    public typealias MongoInsertBlock = (Result<AnyBSON, Error>) -> Void
  • 成功した insertMany または Result.failure(error) で Result.success([ObjectId]) が返されるブロック

    宣言

    Swift

    public typealias MongoInsertManyBlock = (Result<[AnyBSON], Error>) -> Void
  • 検索操作が成功した場合は Result.success([Document]) を返すブロック、または Result.failure(error) は

    宣言

    Swift

    public typealias MongoFindBlock = (Result<[Document], Error>) -> Void
  • 成功した findOne 操作または Result.failure(error) 操作で Result.success(Document?) が返されるブロック

    宣言

    Swift

    public typealias MongoFindOneBlock = (Result<Document?, Error>) -> Void
  • カウント操作が成功した場合は Result.success(Int) を返すブロック、または Result.failure(error) を返す

    宣言

    Swift

    public typealias MongoCountBlock = (Result<Int, Error>) -> Void
  • 成功した更新操作で Result.success(UpdateResult) を返すブロック、または Result.failure(error) を返す

    宣言

    Swift

    public typealias MongoUpdateBlock = (Result<UpdateResult, Error>) -> Void
  • MongoCollectionは MongoDB コレクションを表します。

    インスタンスはMongoDatabaseから取得できます。

    作成、読み取り、更新、削除のメソッドが利用できます。

    Realm Cloud サーバーに対する操作は非同期で実行されます。

    注意

    データの読み取りまたは書き込みを行う前に、ユーザーはログインする必要があります。

    次も参照してください

    MongoClient, MongoDatabase

    宣言

    Swift

    public typealias MongoCollection = RLMMongoCollection
  • ミドルウェアとして機能し、 WatchStream でイベントを処理します

    宣言

    Swift

    public typealias ChangeStream = RLMChangeStream

notifications

  • Realm 内のデータが変更されたときに通知目的で実行するブロックのタイプ。

    宣言

    Swift

    public typealias NotificationBlock = (_ notification: Realm.Notification, _ realm: Realm) -> Void
  • MongoDB Realm ユーザーを表すオブジェクト。

    詳細は、次を参照してください:

    RLMUser

    宣言

    Swift

    public typealias User = RLMUser
  • MongoDB Realm 同期関連の機能を構成および管理する シングルオン。

    詳細は、次を参照してください:

    RLMSyncManager

    宣言

    Swift

    public typealias SyncManager = RLMSyncManager
  • 同期クライアントでタイムアウトと間隔を設定するオプション。

    詳細は、次を参照してください:

    RLMSyncTimeoutOptions

    宣言

    Swift

    public typealias SyncTimeoutOptions = RLMSyncTimeoutOptions
  • 特定の Realm のクライアントとサーバー間の通信を表すセッション オブジェクト。

    詳細は、次を参照してください:

    RLMSyncSession

    宣言

    Swift

    public typealias SyncSession = RLMSyncSession
  • 閉じる の閉じるタイプSyncManagerに設定すると、エラーをアプリケーションに報告できるようになります。

    詳細は、次を参照してください:

    RLMSyncErrorReportingBlock

    宣言

    Swift

    public typealias ErrorReportingBlock = RLMSyncErrorReportingBlock
  • 特定の API がSyncUserオブジェクトをアプリケーションに非同期に返すために使用される クローズド の タイプ 。

    詳細は、次を参照してください:

    RLMUserCompletionBlock

    宣言

    Swift

    public typealias UserCompletionBlock = RLMUserCompletionBlock
  • SDK の同期機能に関連するエラーです。 SyncManagerに登録されているエラー ハンドラーによって報告されるすべてのエラーは、このタイプです。

    詳細は、次を参照してください:

    RLMSyncError

    宣言

    Swift

    public typealias SyncError = RLMSyncError
  • 認証サーバーに対して行われたネットワークリクエストに関連するエラーです。 このタイプのエラーは、特定のタイプのログイン試行(リクエストの形式が正しくない場合やサーバーに問題が発生している場合など)に、 SyncUser.logIn()へのコールバック ブロックで返される場合があります。

    詳細は、次を参照してください:

    RLMSyncAuthError

    宣言

    Swift

    public typealias SyncAuthError = RLMSyncAuthError
  • ログのレベルを指定するために使用できる列挙型。

    詳細は、次を参照してください:

    RLMSyncLogLevel

    宣言

    Swift

    public typealias SyncLogLevel = RLMSyncLogLevel
  • MongoDB Realm で使用できるさまざまな認証プロバイダを表す値を持つデータ型。

    詳細は、次を参照してください:

    RLMIdentityProvider

    宣言

    Swift

    public typealias Provider = RLMIdentityProvider