Constants

The following constants are available globally.

Notification Constants

  • This notification is posted when a write transaction has been committed to a Realm on a different thread for the same file.

    It is not posted if autorefresh is enabled, or if the Realm is refreshed before the notification has a chance to run.

    Realms with autorefresh disabled should normally install a handler for this notification which calls -[RLMRealm refresh] after doing some work. Refreshing the Realm is optional, but not refreshing the Realm may lead to large Realm files. This is because an extra copy of the data must be kept for the stale Realm.

    Declaration

    Objective-C

    extern NS_SWIFT_NAME(RefreshRequired) const RLMNotification
    RLMRealmRefreshRequiredNotification

    Swift

    static let RefreshRequired: RLMNotification
    Show on GitHub

  • This notification is posted by a Realm when a write transaction has been committed to a Realm on a different thread for the same file.

    It is not posted if -[RLMRealm autorefresh] is enabled, or if the Realm is refreshed before the notification has a chance to run.

    Realms with autorefresh disabled should normally install a handler for this notification which calls -[RLMRealm refresh] after doing some work. Refreshing the Realm is optional, but not refreshing the Realm may lead to large Realm files. This is because Realm must keep an extra copy of the data for the stale Realm.

    Declaration

    Objective-C

    extern NS_SWIFT_NAME(DidChange) const RLMNotification
    RLMRealmDidChangeNotification

    Swift

    static let DidChange: RLMNotification
    Show on GitHub

Error keys

  • Key to identify the associated backup Realm configuration in an error’s userInfo dictionary

    Declaration

    Objective-C

    extern NSString *const _Nonnull RLMBackupRealmConfigurationErrorKey

    Swift

    let RLMBackupRealmConfigurationErrorKey: String
    Show on GitHub

Other Constants

  • The schema version used for uninitialized Realms

    Declaration

    Objective-C

    extern const uint64_t RLMNotVersioned

    Swift

    let RLMNotVersioned: UInt64
    Show on GitHub

  • The corresponding value is the name of an exception thrown by Realm.

    Declaration

    Objective-C

    extern NSString *const _Nonnull RLMExceptionName

    Swift

    let RLMExceptionName: String
    Show on GitHub

  • The corresponding value is a Realm file version.

    Declaration

    Objective-C

    extern NSString *const _Nonnull RLMRealmVersionKey

    Swift

    let RLMRealmVersionKey: String
    Show on GitHub

  • The corresponding key is the version of the underlying database engine.

    Declaration

    Objective-C

    extern NSString *const _Nonnull RLMRealmCoreVersionKey

    Swift

    let RLMRealmCoreVersionKey: String
    Show on GitHub

  • The corresponding key is the Realm invalidated property name.

    Declaration

    Objective-C

    extern NSString *const _Nonnull RLMInvalidatedKey

    Swift

    let RLMInvalidatedKey: String
    Show on GitHub

Error Domains

  • Error code is a value from the RLMError enum.

    Declaration

    Objective-C

    extern NSString *const RLMErrorDomain

    Swift

    let RLMErrorDomain: String
    Show on GitHub

  • An error domain identifying non-specific system errors.

    Declaration

    Objective-C

    extern NSString *const RLMUnknownSystemErrorDomain

    Swift

    let RLMUnknownSystemErrorDomain: String
    Show on GitHub

RLMError

  • A user info key containing the name of the error code. This is for debugging purposes only and should not be relied on.

    Declaration

    Objective-C

    extern NSString *const RLMErrorCodeNameKey

    Swift

    let RLMErrorCodeNameKey: String
    Show on GitHub