RLMSyncConfiguration

Objective-C

@interface RLMSyncConfiguration : NSObject

Swift

class RLMSyncConfiguration : NSObject

A configuration object representing configuration state for a Realm which is intended to sync with a Realm Object Server.

Show on GitHub

  • The user to which the remote Realm belongs.

    Declaration

    Objective-C

    @property (nonatomic, readonly) RLMUser *_Nonnull user;

    Swift

    var user: RLMUser { get }
    Show on GitHub

  • The value this Realm is partitioned on. The partition key is a property defined in MongoDB Realm. All classes with a property with this value will be synchronized to the Realm.

    Declaration

    Objective-C

    @property (nonatomic, readonly) id<RLMBSON> _Nonnull partitionValue;
    Show on GitHub

  • Whether nonfatal connection errors should cancel async opens.

    By default, if a nonfatal connection error such as a connection timing out occurs, any currently pending asyncOpen operations will ignore the error and continue to retry until it succeeds. If this is set to true, the open will instead fail and report the error.

    FIXME: This should probably be true by default in the next major version.

    Declaration

    Objective-C

    @property (nonatomic) _Bool cancelAsyncOpenOnNonFatalErrors;

    Swift

    var cancelAsyncOpenOnNonFatalErrors: Bool { get set }
    Show on GitHub