Constants

The following constants are available globally.

  • A user info key for use with RLMSyncErrorClientResetError.

    Declaration

    Objective-C

    extern NSString *const _Nonnull kRLMSyncPathOfRealmBackupCopyKey

    Swift

    let kRLMSyncPathOfRealmBackupCopyKey: String
    Show on GitHub

  • A user info key for use with certain error types.

    Declaration

    Objective-C

    extern NSString *const _Nonnull kRLMSyncErrorActionTokenKey

    Swift

    let kRLMSyncErrorActionTokenKey: String
    Show on GitHub

  • The error domain string for all SDK errors related to errors reported by the synchronization manager error handler, as well as general sync errors that don’t fall into any of the other categories.

    Declaration

    Objective-C

    extern NSString *const _Nonnull RLMSyncErrorDomain

    Swift

    let RLMSyncErrorDomain: String
    Show on GitHub

  • The error domain string for all SDK errors related to the authentication endpoint.

    Declaration

    Objective-C

    extern NSString *const _Nonnull RLMSyncAuthErrorDomain

    Swift

    let RLMSyncAuthErrorDomain: String
    Show on GitHub

  • The error domain string for all SDK errors related to the permissions system and APIs.

    Declaration

    Objective-C

    extern NSString *const _Nonnull RLMSyncPermissionErrorDomain

    Swift

    let RLMSyncPermissionErrorDomain: String
    Show on GitHub

Enums

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 const RLMNotification _Nonnull RLMRealmRefreshRequiredNotification
    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 const RLMNotification _Nonnull RLMRealmDidChangeNotification
    Show on GitHub

Error keys

Other Constants

  • The schema version used for uninitialized Realms

    Declaration

    Objective-C

    extern const uint64_t RLMNotVersioned
    Show on GitHub

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

    Declaration

    Objective-C

    extern NSString *const _Nonnull RLMExceptionName
    Show on GitHub

  • The corresponding value is a Realm file version.

    Declaration

    Objective-C

    extern NSString *const _Nonnull RLMRealmVersionKey
    Show on GitHub

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

    Declaration

    Objective-C

    extern NSString *const _Nonnull RLMRealmCoreVersionKey
    Show on GitHub

  • The corresponding key is the Realm invalidated property name.

    Declaration

    Objective-C

    extern NSString *const _Nonnull RLMInvalidatedKey
    Show on GitHub