RLMSyncConfiguration

@interface RLMSyncConfiguration : NSObject

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

  • The user to which the remote Realm belongs.

    Declaration

    Objective-C

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

    Swift

    var user: RLMSyncUser { get }
    Show on GitHub

  • The URL of the remote Realm upon the Realm Object Server.

    Warning

    The URL cannot end with .realm, .realm.lock or .realm.management.

    Declaration

    Objective-C

    @property (readonly, nonatomic) NSURL *_Nonnull realmURL;

    Swift

    var realmURL: URL { get }
    Show on GitHub

  • A local path to a file containing the trust anchors for SSL connections.

    Only the certificates stored in the PEM file (or any certificates signed by it, if the file contains a CA cert) will be accepted when initiating a connection to a server. This prevents certain certain kinds of man-in-the-middle (MITM) attacks, and can also be used to trust a self-signed certificate which would otherwise be untrusted.

    On macOS, the file may be in any of the formats supported by SecItemImport(), including PEM and .cer (see SecExternalFormat for a complete list of possible formats). On iOS and other platforms, only DER .cer files are supported.

    Declaration

    Objective-C

    @property (assign, readwrite, nonatomic, nullable) NSURL *pinnedCertificateURL;

    Swift

    var pinnedCertificateURL: URL? { get set }
    Show on GitHub

  • Whether SSL certificate validation is enabled for the connection associated with this configuration value. SSL certificate validation is ON by default.

    Warning

    NEVER disable certificate validation for clients and servers in production.

    Declaration

    Objective-C

    @property (assign, readwrite, nonatomic) BOOL enableSSLValidation;

    Swift

    var enableSSLValidation: Bool { get set }
    Show on GitHub

  • Whether this Realm should be opened in ‘partial synchronization’ mode. Partial synchronization mode means that no objects are synchronized from the remote Realm except those matching queries that the user explicitly specifies.

    Warning

    Partial synchronization is a tech preview. Its APIs are subject to change.

    Declaration

    Objective-C

    @property (assign, readwrite, nonatomic) BOOL isPartial;

    Swift

    var isPartial: Bool { get set }
    Show on GitHub

  • Whether this Realm should be a fully synchronized Realm.

    Synchronized Realms comes in two flavors: Query-based and Fully synchronized. A fully synchronized Realm will automatically synchronize the entire Realm in the background while a query-based Realm will only synchronize the data being subscribed to. Synchronized realms are by default query-based unless this boolean is set.

    Declaration

    Objective-C

    @property (assign, readwrite, nonatomic) BOOL fullSynchronization;

    Swift

    var fullSynchronization: Bool { get set }
    Show on GitHub

  • The prefix that is prepended to the path in the HTTP request that initiates a sync connection. The value specified must match with the server’s expectation. Changing the value of urlPrefix should be matched with a corresponding change of the server’s configuration. If no value is specified here then the default /realm-sync path is used.

    Declaration

    Objective-C

    @property (readwrite, copy, nonatomic, nullable) NSString *urlPrefix;

    Swift

    var urlPrefix: String? { get set }
    Show on GitHub

  • Create a sync configuration instance.

    Declaration

    Objective-C

    - (nonnull instancetype)initWithUser:(nonnull RLMSyncUser *)user
                            realmURL:(nonnull NSURL *)url;

    Swift

    init(user: RLMSyncUser, realmURL url: URL)

    Parameters

    user

    A RLMSyncUser that owns the Realm at the given URL.
    url

    The unresolved absolute URL to the Realm on the Realm Object Server, e.g. realm://example.org/~/path/to/realm. Unresolved means the path should contain the wildcard marker ~, which will automatically be filled in with the user identity by the Realm Object Server.
    Show on GitHub

  • Return a Realm configuration for syncing with the default Realm of the currently logged-in sync user.

    Partial synchronization is enabled in the returned configuration.

    Declaration

    Objective-C

    + (nonnull RLMRealmConfiguration *)automaticConfiguration;

    Swift

    class func automaticConfiguration() -> RLMRealmConfiguration
    Show on GitHub

  • Return a Realm configuration for syncing with the default Realm of the given sync user.

    Partial synchronization is enabled in the returned configuration.

    Declaration

    Objective-C

    + (nonnull RLMRealmConfiguration *)automaticConfigurationForUser:
    (nonnull RLMSyncUser *)user;

    Swift

    class func automaticConfiguration(for user: RLMSyncUser) -> RLMRealmConfiguration
    Show on GitHub