DBFILESSearchMatchFieldOptions

Objective-C

@interface DBFILESSearchMatchFieldOptions : NSObject <DBSerializable, NSCopying>

Swift

class DBFILESSearchMatchFieldOptions : NSObject, DBSerializable, NSCopying

The SearchMatchFieldOptions struct.

This class implements the DBSerializable protocol (serialize and deserialize instance methods), which is required for all Obj-C SDK API route objects.

Instance fields

  • Whether to include highlight span from file title.

    Declaration

    Objective-C

    @property (nonatomic, readonly) NSNumber *_Nonnull includeHighlights;

    Swift

    var includeHighlights: NSNumber { get }

Constructors

  • Full constructor for the struct (exposes all instance variables).

    Declaration

    Objective-C

    - (nonnull instancetype)initWithIncludeHighlights:
    (nullable NSNumber *)includeHighlights;

    Swift

    init(includeHighlights: NSNumber?)

    Parameters

    includeHighlights

    Whether to include highlight span from file title.

    Return Value

    An initialized instance.

  • Convenience constructor (exposes only non-nullable instance variables with no default value).

    Declaration

    Objective-C

    - (nonnull instancetype)initDefault;

    Swift

    init(default: ())

    Return Value

    An initialized instance.