Enumerations

The following enumerations are available globally.

RLMBSONType

  • Allowed BSON types.

    See more

    Declaration

    Objective-C

    enum RLMBSONType : NSUInteger {}

    Swift

    enum RLMBSONType : UInt, @unchecked Sendable
    Show on GitHub

Enums

  • RLMPropertyType is an enumeration describing all property types supported in Realm models.

    For more information, see Realm Models.

    See more

    Declaration

    Objective-C

    enum RLMPropertyType : int32_t {}

    Swift

    @_nonSendable(_assumed) @frozen enum RLMPropertyType : Int32, @unchecked Sendable
    Show on GitHub

  • RLMAnyValueType is an enumeration describing all property types supported by RLMValue (AnyRealmValue).

    For more information, see Realm Models.

    See more

    Declaration

    Objective-C

    enum RLMAnyValueType : int32_t {}

    Swift

    @_nonSendable(_assumed) @frozen enum RLMAnyValueType : Int32, @unchecked Sendable
    Show on GitHub

RLMError

  • RLMError is an enumeration representing all recoverable errors. It is associated with the Realm error domain specified in RLMErrorDomain.

    See more

    Declaration

    Objective-C

    enum RLMError : NSInteger {}

    Swift

    typealias RLMError.Code._ErrorType = RLMError
    Show on GitHub

RLMSyncError

  • An error related to a problem that might be reported by the synchronization manager error handler, or a callback on a sync-related API that performs asynchronous work.

    See more

    Declaration

    Objective-C

    enum RLMSyncError : NSInteger {}

    Swift

    typealias RLMSyncError.Code._ErrorType = RLMSyncError
    Show on GitHub

RLMSyncAppError

  • An error which occurred when making a request to Atlas App Services.

    See more

    Declaration

    Objective-C

    enum RLMAppError : NSInteger {}

    Swift

    typealias RLMAppError.Code._ErrorType = RLMAppError
    Show on GitHub

  • An enum representing different levels of sync-related logging that can be configured.

    See more

    Declaration

    Objective-C

    enum RLMLogLevel : NSUInteger {}

    Swift

    @frozen enum LogLevel : UInt, @unchecked Sendable
    Show on GitHub

  • Allowed HTTP methods to be used with RLMNetworkTransport.

    See more

    Declaration

    Objective-C

    enum RLMHTTPMethod : int32_t {}

    Swift

    @_nonSendable(_assumed) @frozen enum RLMHTTPMethod : Int32, @unchecked Sendable
    Show on GitHub

  • Determines wait for download behavior when subscribing on RLMResults.

    See

    [RLMResults subscribeWithName:waitForSync:onQueue:completion:]
    See more

    Declaration

    Objective-C

    enum RLMWaitForSyncMode : NSUInteger {}

    Swift

    @_nonSendable(_assumed) enum WaitForSyncMode : UInt, @unchecked Sendable
    Show on GitHub

  • Determines file behavior during a client reset.

    @see: https://docs.mongodb.com/realm/sync/error-handling/client-resets/

    See more

    Declaration

    Objective-C

    enum RLMClientResetMode : NSUInteger {}

    Swift

    @_nonSendable(_assumed) enum RLMClientResetMode : UInt, @unchecked Sendable
    Show on GitHub

  • An enum representing different levels of sync-related logging that can be configured.

    See more

    Declaration

    Objective-C

    enum RLMSyncLogLevel : NSUInteger {}

    Swift

    @_nonSendable(_assumed) @frozen enum RLMSyncLogLevel : UInt, @unchecked Sendable
    Show on GitHub

  • The current state of the session represented by a session object.

    See more

    Declaration

    Objective-C

    enum RLMSyncSessionState : NSUInteger {}

    Swift

    enum RLMSyncSessionState : UInt, @unchecked Sendable
    Show on GitHub

  • The current state of a sync session’s connection. Sessions which are not in the Active state will always be Disconnected.

    See more

    Declaration

    Objective-C

    enum RLMSyncConnectionState : NSUInteger {}

    Swift

    enum RLMSyncConnectionState : UInt, @unchecked Sendable
    Show on GitHub

  • The transfer direction (upload or download) tracked by a given progress notification block.

    Progress notification blocks can be registered on sessions if your app wishes to be informed how many bytes have been uploaded or downloaded, for example to show progress indicator UIs.

    See more

    Declaration

    Objective-C

    enum RLMSyncProgressDirection : NSUInteger {}

    Swift

    @frozen enum RLMSyncProgressDirection : UInt, @unchecked Sendable
    Show on GitHub

  • The desired behavior of a progress notification block.

    Progress notification blocks can be registered on sessions if your app wishes to be informed how many bytes have been uploaded or downloaded, for example to show progress indicator UIs.

    See more

    Declaration

    Objective-C

    enum RLMSyncProgressMode : NSUInteger {}

    Swift

    enum RLMSyncProgressMode : UInt, @unchecked Sendable
    Show on GitHub

Subscription States

  • The current state of the subscription. This can be used for ensuring that the subscriptions are not errored and that it has been successfully synced to the server.

    See more

    Declaration

    Objective-C

    enum RLMSyncSubscriptionState : NSUInteger {}

    Swift

    enum RLMSyncSubscriptionState : UInt, @unchecked Sendable
    Show on GitHub

  • The state of the user object.

    See more

    Declaration

    Objective-C

    enum RLMUserState : NSUInteger {}

    Swift

    enum RLMUserState : UInt, @unchecked Sendable
    Show on GitHub