DBFILESSearchV2Arg

Objective-C

@interface DBFILESSearchV2Arg : NSObject <DBSerializable, NSCopying>

Swift

class DBFILESSearchV2Arg : NSObject, DBSerializable, NSCopying

The SearchV2Arg 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

  • The string to search for. May match across multiple fields based on the request arguments.

    Declaration

    Objective-C

    @property (nonatomic, copy, readonly) NSString *_Nonnull query;

    Swift

    var query: String { get }

  • Options for more targeted search results.

    Declaration

    Objective-C

    @property (nonatomic, readonly, nullable) DBFILESSearchOptions *options;

    Swift

    var options: DBFILESSearchOptions? { get }

  • Options for search results match fields.

    Declaration

    Objective-C

    @property (nonatomic, readonly, nullable) DBFILESSearchMatchFieldOptions *matchFieldOptions;

    Swift

    var matchFieldOptions: DBFILESSearchMatchFieldOptions? { get }

  • Deprecated and moved this option to SearchMatchFieldOptions.

    Declaration

    Objective-C

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

    Swift

    var includeHighlights: NSNumber? { get }

Constructors

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

    Declaration

    Objective-C

    - (nonnull instancetype)initWithQuery:(nonnull NSString *)query
                              options:(nullable DBFILESSearchOptions *)options
                    matchFieldOptions:
                        (nullable DBFILESSearchMatchFieldOptions *)
                            matchFieldOptions
                    includeHighlights:(nullable NSNumber *)includeHighlights;

    Swift

    init(query: String, options: DBFILESSearchOptions?, matchFieldOptions: DBFILESSearchMatchFieldOptions?, includeHighlights: NSNumber?)

    Parameters

    query

    The string to search for. May match across multiple fields based on the request arguments.
    options

    Options for more targeted search results.
    matchFieldOptions

    Options for search results match fields.
    includeHighlights

    Deprecated and moved this option to SearchMatchFieldOptions.

    Return Value

    An initialized instance.

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

    Declaration

    Objective-C

    - (nonnull instancetype)initWithQuery:(nonnull NSString *)query;

    Swift

    init(query: String)

    Parameters

    query

    The string to search for. May match across multiple fields based on the request arguments.

    Return Value

    An initialized instance.