CBLMultipeerCollectionConfiguration

@interface CBLMultipeerCollectionConfiguration : NSObject

Configuration for specifying a collection to replicate, including optional filters and a custom conflict resolver.

  • The collection.

    Declaration

    Objective-C

    @property (nonatomic, readonly) CBLCollection *_Nonnull collection;

  • Optional list of document IDs to replicate. Only documents with the specified IDs will be replicated.

    Declaration

    Objective-C

    @property (nonatomic, nullable) NSArray<NSString *> *documentIDs;

  • Optional push filter function

    Declaration

    Objective-C

    @property (nonatomic, nullable) CBLMultipeerReplicationFilter pushFilter;

  • Optional pull filter function

    Declaration

    Objective-C

    @property (nonatomic, nullable) CBLMultipeerReplicationFilter pullFilter;

  • Optional Custom conflict resolver. If not specified, the default conflict resolver will be used.

    Declaration

    Objective-C

    @property (nonatomic, nullable) id<CBLMultipeerConflictResolver> conflictResolver;

  • Initializes the configuration with the specified collection.

    Declaration

    Objective-C

    - (nonnull instancetype)initWithCollection:(nonnull CBLCollection *)collection;

    Parameters

    collection

    The collection.

    Return Value

    A CBLMultipeerCollectionConfiguration instance.

  • Unavailable

    Not available.

    Declaration

    Objective-C

    - (nonnull instancetype)init;

  • Creates an array of CBLMultipeerCollectionConfiguration objects from the given collections.

    Each collection is wrapped in a CBLMultipeerCollectionConfigurationusing default settings (no filters and no custom conflict resolvers).

    This is a convenience method for configuring multiple collections with default configurations. If custom configurations are needed, construct CBLMultipeerCollectionConfiguration objects directly instead.

    Declaration

    Objective-C

    + (nonnull NSArray<CBLMultipeerCollectionConfiguration *> *)fromCollections:
    (nonnull NSArray<CBLCollection *> *)collections;

    Parameters

    collections

    The collections to replicate.

    Return Value

    An array of CBLMultipeerCollectionConfiguration objects for the given collections.