Constants

The following constants are available globally.

Notification Constants

  • This notification is posted by a Realm when the data in that Realm has changed.

    More specifically, this notification is posted after a Realm has been refreshed to reflect a write transaction. This can happen when an autorefresh occurs, when -[RLMRealm refresh] is called, after an implicit refresh from -[RLMRealm beginWriteTransaction], or after a local write transaction is completed.

    Declaration

    Objective‑C

    extern NSString *const RLMRealmRefreshRequiredNotification

    Swift

    let RLMRealmRefreshRequiredNotification: String
    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 NSString *const RLMRealmDidChangeNotification

    Swift

    let RLMRealmDidChangeNotification: 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

  • An error domain identifying Realm-specific errors.

    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

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

    Declaration

    Objective‑C

    extern NSString *const RLMExceptionName

    Swift

    let RLMExceptionName: String
    Show on GitHub

  • The corresponding value is a Realm file version.

    Declaration

    Objective‑C

    extern NSString *const 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 RLMRealmCoreVersionKey

    Swift

    let RLMRealmCoreVersionKey: String
    Show on GitHub

  • The corresponding key is the Realm invalidated property name.

    Declaration

    Objective‑C

    extern NSString *const RLMInvalidatedKey

    Swift

    let RLMInvalidatedKey: String
    Show on GitHub