YapDatabaseFilteredView

@interface YapDatabaseFilteredView : YapDatabaseView

Undocumented

  • Undocumented

    Declaration

    Objective-C

    - (id)initWithParentViewName:(NSString *)viewName
                   filtering:(YapDatabaseViewFiltering *)filtering;

    Swift

    init(parentViewName viewName: String, filtering: YapDatabaseViewFiltering)

  • Undocumented

    Declaration

    Objective-C

    - (id)initWithParentViewName:(NSString *)viewName
                   filtering:(YapDatabaseViewFiltering *)filtering
                  versionTag:(nullable NSString *)versionTag;

    Swift

    init(parentViewName viewName: String, filtering: YapDatabaseViewFiltering, versionTag: String?)

  • Declaration

    Objective-C

    - (nonnull id)initWithParentViewName:(nonnull NSString *)viewName
                           filtering:
                               (nonnull YapDatabaseViewFiltering *)filtering
                          versionTag:(nullable NSString *)versionTag
                             options:(nullable YapDatabaseViewOptions *)options;

    Swift

    init(parentViewName viewName: String, filtering: YapDatabaseViewFiltering, versionTag: String?, options: YapDatabaseViewOptions?)

    Parameters

    viewName

    The parentViewName must be the registered name of a YapDatabaseView or YapDatabaseFilteredView extension. That is, you must first register the parentView, and then use that registered name here.
    filtering

    The filteringBlock allows you to filter items from this view that exist in the parent view. There are multiple filteringBlock types that are supported.

    See

    YapDatabaseFilteredViewTypes.h for block type definitions.
    versionTag

    The filteringBlock may be changed after the filteredView is created (see YapDatabaseFilteredViewTransaction). This is often in association with user events. The versionTag helps to identify the filteringBlock being used. During initialization of the view, the view will compare the passed tag to what it has stored from a previous app session. If the tag matches, then the filteredView is already setup. Otherwise the view will automatically flush its tables, and re-populate itself.
    options

    The options allow you to specify things like creating an IN-MEMORY-ONLY VIEW (non persistent).

  • Undocumented

    Declaration

    Objective-C

    @property (nonatomic, strong, readonly) NSString *parentViewName

    Swift

    var parentViewName: String { get }

  • Undocumented

    Declaration

    Objective-C

    @property (nonatomic, strong, readonly) YapDatabaseViewFiltering *filtering

    Swift

    var filtering: YapDatabaseViewFiltering { get }