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.

    Declaration

    Objective-C

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

    Swift

    var realmURL: URL { get }
    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 full, unresolved URL to the Realm on the Realm Object Server. Full means that this URL is fully qualified; e.g. realm://example.org/~/path/to/my.realm. Unresolved means the path should contain the wildcard marker ~.
    Show on GitHub