RLMSyncConfiguration Class Reference


                    
                    
                    user

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


                    
                    
                    partitionValue

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

Declaration

Objective-C

@property (nonatomic, readonly, nullable) id<RLMBSON> partitionValue;

Swift

var partitionValue: (any RLMBSON)? { get }

Show on GitHub


                    
                    
                    clientResetMode

An enum which determines file recovery behavior in the event of a client reset. @note: Defaults to RLMClientResetModeRecoverUnsyncedChanges

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

Declaration

Objective-C

@property (nonatomic) RLMClientResetMode clientResetMode;

Swift

var clientResetMode: RLMClientResetMode { get set }

Show on GitHub


                    
                    
                    beforeClientReset

A callback which notifies prior to prior to a client reset occurring. @see: RLMClientResetBeforeBlock

Declaration

Objective-C

@property (nonatomic, nullable) RLMClientResetBeforeBlock beforeClientReset;

Swift

var beforeClientReset: RLMClientResetBeforeBlock? { get set }

Show on GitHub


                    
                    
                    afterClientReset

A callback which notifies after a client reset has occurred. @see: RLMClientResetAfterBlock

Declaration

Objective-C

@property (nonatomic, nullable) RLMClientResetAfterBlock afterClientReset;

Swift

var afterClientReset: RLMClientResetAfterBlock? { get set }

Show on GitHub


                    
                    
                    manualClientResetHandler

A callback that’s executed when an RLMSyncErrorClientResetError is encountered. @See RLMSyncErrorReportingBlock and RLMSyncErrorClientResetError for more details on handling a client reset manually.

Declaration

Objective-C

@property (nonatomic, nullable) RLMSyncErrorReportingBlock manualClientResetHandler;

Swift

var manualClientResetHandler: RLMSyncErrorReportingBlock? { get set }

Show on GitHub


                    
                    
                    initialSubscriptions

A configuration that controls how initial subscriptions are populated when the Realm is opened.

See

RLMInitialSubscriptionsConfiguration

Declaration

Objective-C

@property (nonatomic, nullable) RLMInitialSubscriptionsConfiguration *initialSubscriptions;

Swift

var initialSubscriptions: RLMInitialSubscriptionsConfiguration? { get set }

Show on GitHub


                    
                    
                    cancelAsyncOpenOnNonFatalErrors

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.

NEXT-MAJOR: This should be true by default.

Declaration

Objective-C

@property (nonatomic) _Bool cancelAsyncOpenOnNonFatalErrors;

Swift

var cancelAsyncOpenOnNonFatalErrors: Bool { get set }

Show on GitHub