Realm v10.0.0-beta.3 Release Notes

Release Date: 2020-08-18 // over 3 years ago
  • ๐Ÿš€ This release also contains all changes from 5.3.2.

    ๐Ÿ’ฅ Breaking Changes

    • The following classes & aliases have been renamed to align Cocoa with the other Realm SDKs:
    Old API New API
    RLMSyncUser RLMUser
    ๐Ÿ”€ SyncUser
    RLMAppCredential RLMCredential
    AppCredential Credential
    RealmApp App
    RLMUserAPIKeyProviderClient RLMAPIKeyAuth
    RLMUsernamePasswordProviderClient RLMEmailPasswordAuth
    UsernamePasswordProviderClient EmailPasswordAuth
    UserAPIKeyProviderClient APIKeyAuth
    • ๐Ÿšš The following functionality has also moved to the User
    Old API New API
    [RLMApp callFunctionNamed:] [RLMUser callFunctionNamed:]
    App.functions User.functions
    [RLMApp mongoClientWithServiceName:] [RLMUser mongoClientWithServiceName:]
    App.mongoClient(serviceName) User.mongoClient(serviceName)
    [RLMApp userAPIKeyProviderClient] [RLMUser apiKeyAuth]
    App.userAPIKeyProviderClient App.apiKeyAuth()
    [RLMApp logOut:] [RLMUser logOut]
    App.logOut(user) User.logOut()
    ๐Ÿšš [RLMApp removeUser:]
    ๐Ÿšš App.remove(user)
    [RLMApp linkUser:credentials:] [RLMUser linkWithCredentials:]
    App.linkUser(user, credentials) User.link(credentials)
    • refreshCustomData() on User now returns void and passes the custom data to the callback on success.

    Compatibility

    • ๐Ÿš€ This release introduces breaking changes w.r.t some sync classes and MongoDB Realm Cloud functionality. ๐Ÿ‘€ (See the breaking changes section for the full list)
    • โฌ†๏ธ File format: Generates Realms with format v11 (Reads and upgrades all previous formats)
    • Realm Studio: 10.0.0 or later.
    • ๐Ÿš€ Carthage release for Swift is built with Xcode 11.5.

    Internal

    • โฌ†๏ธ Upgraded realm-core from ? to ?
    • โฌ†๏ธ Upgraded realm-sync from ? to ?