Enumerations

The following enumerations are available globally.

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 {}

    Swift

    @frozen enum RLMPropertyType : Int32
    Show on GitHub

  • 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 {}

    Swift

    typealias RLMError.Code._ErrorType = RLMError
    Show on GitHub

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

    See more

    Declaration

    Objective-C

    enum RLMSyncLogLevel {}

    Swift

    @frozen enum RLMSyncLogLevel : UInt
    Show on GitHub

  • Access levels which can be granted to Realm Mobile Platform users for specific synchronized Realms, using the permissions APIs.

    Note that each access level guarantees all allowed actions provided by less permissive access levels. Specifically, users with write access to a Realm can always read from that Realm, and users with administrative access can always read or write from the Realm.

    See more

    Declaration

    Objective-C

    enum RLMSyncAccessLevel {}

    Swift

    @frozen enum RLMSyncAccessLevel : UInt
    Show on GitHub

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

    See more

    Declaration

    Objective-C

    enum RLMSyncSessionState {}

    Swift

    enum RLMSyncSessionState : UInt
    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 {}

    Swift

    enum RLMSyncConnectionState : UInt
    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 {}

    Swift

    @frozen enum RLMSyncProgressDirection : UInt
    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 {}

    Swift

    enum RLMSyncProgressMode : UInt
    Show on GitHub

  • RLMSyncSubscriptionState is an enumeration representing the possible state of a sync subscription.

    See more

    Declaration

    Objective-C

    enum RLMSyncSubscriptionState {}

    Swift

    @frozen enum RLMSyncSubscriptionState : Int
    Show on GitHub

  • The state of the user object.

    See more

    Declaration

    Objective-C

    enum RLMSyncUserState {}

    Swift

    enum RLMSyncUserState : UInt
    Show on GitHub

  • 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 {}

    Swift

    typealias RLMSyncError.Code._ErrorType = RLMSyncError
    Show on GitHub

  • An error which is related to authentication to a Realm Object Server.

    See more

    Declaration

    Objective-C

    enum RLMSyncAuthError {}

    Swift

    typealias RLMSyncAuthError.Code._ErrorType = RLMSyncAuthError
    Show on GitHub