Constants
The following constants are available globally.
-
An error domain identifying Realm-specific errors.
Declaration
Objective-C
extern NSString *const _Nonnull RLMErrorDomain
Swift
let RLMErrorDomain: String
-
An error domain identifying non-specific system errors.
Declaration
Objective-C
extern NSString *const _Nonnull RLMUnknownSystemErrorDomain
Swift
let RLMUnknownSystemErrorDomain: String
-
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 RLM_EXTENSIBLE_STRING_ENUM_CASE_SWIFT_NAME( RLMRealmRefreshRequiredNotification, RefreshRequired) const RLMNotification RLMRealmRefreshRequiredNotification
Swift
static let RefreshRequired: RLMNotification
-
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 RLM_EXTENSIBLE_STRING_ENUM_CASE_SWIFT_NAME(RLMRealmDidChangeNotification, DidChange) const RLMNotification RLMRealmDidChangeNotification
Swift
static let DidChange: RLMNotification
-
Key to identify the associated backup Realm configuration in an error’s
userInfo
dictionaryDeclaration
Objective-C
extern NSString *const _Nonnull RLMBackupRealmConfigurationErrorKey
Swift
let RLMBackupRealmConfigurationErrorKey: String
-
The schema version used for uninitialized Realms
Declaration
Objective-C
extern const uint64_t RLMNotVersioned
Swift
let RLMNotVersioned: UInt64
-
The corresponding value is the name of an exception thrown by Realm.
Declaration
Objective-C
extern NSString *const _Nonnull RLMExceptionName
Swift
let RLMExceptionName: String
-
The corresponding value is a Realm file version.
Declaration
Objective-C
extern NSString *const _Nonnull RLMRealmVersionKey
Swift
let RLMRealmVersionKey: String
-
The corresponding key is the version of the underlying database engine.
Declaration
Objective-C
extern NSString *const _Nonnull RLMRealmCoreVersionKey
Swift
let RLMRealmCoreVersionKey: String
-
The corresponding key is the Realm invalidated property name.
Declaration
Objective-C
extern NSString *const _Nonnull RLMInvalidatedKey
Swift
let RLMInvalidatedKey: String
-
The debug identity provider, which accepts any token string and creates a user associated with that token if one does not yet exist. Not enabled for Realm Object Server configured for production.
Declaration
Objective-C
extern const RLMIdentityProvider _Nonnull RLMIdentityProviderDebug
Swift
static let debug: RLMIdentityProvider
-
The username/password identity provider. User accounts are handled by the Realm Object Server directly without the involvement of a third-party identity provider.
Declaration
Objective-C
extern const RLMIdentityProvider _Nonnull RLMIdentityProviderUsernamePassword
Swift
static let usernamePassword: RLMIdentityProvider
-
A Facebook account as an identity provider.
Declaration
Objective-C
extern const RLMIdentityProvider _Nonnull RLMIdentityProviderFacebook
Swift
static let facebook: RLMIdentityProvider
-
A Google account as an identity provider.
Declaration
Objective-C
extern const RLMIdentityProvider _Nonnull RLMIdentityProviderGoogle
Swift
static let google: RLMIdentityProvider
-
A CloudKit account as an identity provider.
Declaration
Objective-C
extern const RLMIdentityProvider _Nonnull RLMIdentityProviderCloudKit
Swift
static let cloudKit: RLMIdentityProvider
-
A JSON Web Token as an identity provider.
Declaration
Objective-C
extern const RLMIdentityProvider _Nonnull RLMIdentityProviderJWT
Swift
static let JWT: RLMIdentityProvider
-
An Anonymous account as an identity provider.
Declaration
Objective-C
extern const RLMIdentityProvider _Nonnull RLMIdentityProviderAnonymous
Swift
static let anonymous: RLMIdentityProvider
-
Deprecated
Use RLMIdentityProviderUsernamePassword instead
A Nickname account as an identity provider.
Declaration
Objective-C
extern __deprecated_msg("Use RLMIdentityProviderUsernamePassword instead") const RLMIdentityProvider RLMIdentityProviderNickname
Swift
static let nickname: RLMIdentityProvider
-
A user info key for use with
RLMSyncErrorClientResetError
.Declaration
Objective-C
extern NSString *const _Nonnull kRLMSyncPathOfRealmBackupCopyKey
Swift
let kRLMSyncPathOfRealmBackupCopyKey: String
-
A user info key for use with certain error types.
Declaration
Objective-C
extern NSString *const _Nonnull kRLMSyncErrorActionTokenKey
Swift
let kRLMSyncErrorActionTokenKey: String
-
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
-
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
-
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