Typealiases

The following typealiases are available globally.

Aliases

  • PropertyType is an enum describing all property types supported in Realm models.

    For more information, see Realm Models.

    Primitive types

    • Int
    • Bool
    • Float
    • Double

    Object types

    • String
    • Data
    • Date

    Relationships: Array (in Swift, List) and Object types

    Declaration

    Swift

    public typealias PropertyType = RLMPropertyType
    Show on GitHub

  • An opaque token which is returned from methods which subscribe to changes to a Realm.

    See

    Realm.observe(_:)

    Declaration

    Swift

    public typealias NotificationToken = RLMNotificationToken
    Show on GitHub

  • The type of a migration block used to migrate a Realm.

    Declaration

    Swift

    public typealias MigrationBlock = (_ migration: Migration, _ oldSchemaVersion: UInt64) -> Void

    Parameters

    migration

    A Migration object used to perform the migration. The migration object allows you to enumerate and alter any existing objects which require migration.
    oldSchemaVersion

    The schema version of the Realm being migrated.
    Show on GitHub

  • An object class used during migrations.

    Declaration

    Swift

    public typealias MigrationObject = DynamicObject
    Show on GitHub

  • A block type which provides both the old and new versions of an object in the Realm. Object properties can only be accessed using subscripting.

    Declaration

    Swift

    public typealias MigrationObjectEnumerateBlock = (_ oldObject: MigrationObject?, _ newObject: MigrationObject?) -> Void

    Parameters

    oldObject

    The object from the original Realm (read-only).
    newObject

    The object from the migrated Realm (read-write).
    Show on GitHub

Notifications

  • The type of a block to run for notification purposes when the data in a Realm is modified.

    Declaration

    Swift

    public typealias NotificationBlock = (_ notification: Realm.Notification, _ realm: Realm) -> Void
    Show on GitHub

  • An object representing a Realm Object Server user.

    See

    RLMSyncUser

    Declaration

    Swift

    public typealias SyncUser = RLMSyncUser
    Show on GitHub

  • An immutable data object representing information retrieved from the Realm Object Server about a particular user.

    See

    RLMSyncUserInfo

    Declaration

    Swift

    public typealias SyncUserInfo = RLMSyncUserInfo
    Show on GitHub

  • An immutable data object representing an account belonging to a particular user.

    See

    SyncUserInfo, RLMSyncUserAccountInfo

    Declaration

    Swift

    public typealias SyncUserAccountInfo = RLMSyncUserAccountInfo
    Show on GitHub

  • A singleton which configures and manages the Realm Object Server synchronization-related functionality.

    See

    RLMSyncManager

    Declaration

    Swift

    public typealias SyncManager = RLMSyncManager
    Show on GitHub

  • A session object which represents communication between the client and server for a specific Realm.

    See

    RLMSyncSession

    Declaration

    Swift

    public typealias SyncSession = RLMSyncSession
    Show on GitHub

  • A closure type for a closure which can be set on the SyncManager to allow errors to be reported to the application.

    See

    RLMSyncErrorReportingBlock

    Declaration

    Swift

    public typealias ErrorReportingBlock = RLMSyncErrorReportingBlock
    Show on GitHub

  • A closure type for a closure which is used by certain APIs to asynchronously return a SyncUser object to the application.

    See

    RLMUserCompletionBlock

    Declaration

    Swift

    public typealias UserCompletionBlock = RLMUserCompletionBlock
    Show on GitHub

  • An error associated with the SDK’s synchronization functionality. All errors reported by an error handler registered on the SyncManager are of this type.

    See

    RLMSyncError

    Declaration

    Swift

    public typealias SyncError = RLMSyncError
    Show on GitHub

  • An error associated with network requests made to the authentication server. This type of error may be returned in the callback block to SyncUser.logIn() upon certain types of failed login attempts (for example, if the request is malformed or if the server is experiencing an issue).

    See

    RLMSyncAuthError

    Declaration

    Swift

    public typealias SyncAuthError = RLMSyncAuthError
    Show on GitHub

  • An error associated with retrieving or modifying user permissions to access a synchronized Realm.

    See

    RLMSyncPermissionError

    Declaration

    Swift

    public typealias SyncPermissionError = RLMSyncPermissionError
    Show on GitHub

  • An enum which can be used to specify the level of logging.

    See

    RLMSyncLogLevel

    Declaration

    Swift

    public typealias SyncLogLevel = RLMSyncLogLevel
    Show on GitHub

  • A data type whose values represent different authentication providers that can be used with the Realm Object Server.

    See

    RLMIdentityProvider

    Declaration

    Swift

    public typealias Provider = RLMIdentityProvider
    Show on GitHub

  • A value which represents a permission granted to a user to interact with a Realm. These values are passed into APIs on SyncUser, and returned from SyncPermissionResults.

    See

    RLMSyncPermission

    Declaration

    Swift

    public typealias SyncPermission = RLMSyncPermission
    Show on GitHub

  • An enumeration describing possible access levels.

    See

    RLMSyncAccessLevel

    Declaration

    Swift

    public typealias SyncAccessLevel = RLMSyncAccessLevel
    Show on GitHub

Permissions and permission results

  • A Results collection containing sync permission results.

    Declaration

    Swift

    public typealias SyncPermissionResults = Results<SyncPermission>
    Show on GitHub

  • A property upon which a SyncPermissionResults can be sorted or queried. The raw value string can be used to construct predicates and queries manually.

    Warning

    If building NSPredicates using format strings including these raw values, use %K instead of %@ as the substitution parameter.

    See

    RLMSyncPermissionSortProperty

    Declaration

    Swift

    public typealias SyncPermissionSortProperty = RLMSyncPermissionSortProperty
    Show on GitHub