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

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

  • 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 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 RLMSyncAuthErrorDomain

    Swift

    let RLMSyncAuthErrorDomain: String
    Show on GitHub

  • The error domain string for all SDK errors related to the Atlas App Services endpoint.

    Declaration

    Objective-C

    extern NSString *const RLMAppErrorDomain

    Swift

    let RLMAppErrorDomain: String
    Show on GitHub

RLMError

  • Deprecated

    use -[NSError code]

    A user info key containing the error code. This is provided for backwards compatibility only and should not be used.

    Declaration

    Objective-C

    extern NSString *const RLMErrorCodeKey

    Swift

    let RLMErrorCodeKey: String
    Show on GitHub

  • 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

  • A user info key present in sync errors which originate from the server, containing the URL of the server-side logs associated with the error.

    Declaration

    Objective-C

    extern NSString *const RLMServerLogURLKey

    Swift

    let RLMServerLogURLKey: String
    Show on GitHub

  • A user info key containing a HTTP status code. Some RLMAppError codes include this, most notably RLMAppErrorHttpRequestFailed.

    Declaration

    Objective-C

    extern NSString *const RLMHTTPStatusCodeKey

    Swift

    let RLMHTTPStatusCodeKey: String
    Show on GitHub

  • A user info key containing a RLMCompensatingWriteInfo which includes further details about what was reverted by the server.

    Declaration

    Objective-C

    extern NSString *const RLMCompensatingWriteInfoKey

    Swift

    let RLMCompensatingWriteInfoKey: String
    Show on GitHub

RLMSyncError

  • A user info key for use with RLMSyncErrorClientResetError.

    Declaration

    Objective-C

    extern NSString *const kRLMSyncPathOfRealmBackupCopyKey

    Swift

    let kRLMSyncPathOfRealmBackupCopyKey: String
    Show on GitHub

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

    Declaration

    Objective-C

    extern NSString *const kRLMSyncErrorActionTokenKey

    Swift

    let kRLMSyncErrorActionTokenKey: String
    Show on GitHub