DBFILESSearchResult

Objective-C

@interface DBFILESSearchResult : NSObject <DBSerializable, NSCopying>

Swift

class DBFILESSearchResult : NSObject, DBSerializable, NSCopying

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

  • A list (possibly empty) of matches for the query.

    Declaration

    Objective-C

    @property (nonatomic, readonly) NSArray<DBFILESSearchMatch *> *_Nonnull matches;

    Swift

    var matches: [DBFILESSearchMatch] { get }

  • Used for paging. If true, indicates there is another page of results available that can be fetched by calling search again.

    Declaration

    Objective-C

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

    Swift

    var more: NSNumber { get }

  • Used for paging. Value to set the start argument to when calling search to fetch the next page of results.

    Declaration

    Objective-C

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

    Swift

    var start: NSNumber { get }

Constructors

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

    Declaration

    Objective-C

    - (nonnull instancetype)initWithMatches:
                            (nonnull NSArray<DBFILESSearchMatch *> *)matches
                                   more:(nonnull NSNumber *)more
                                  start:(nonnull NSNumber *)start;

    Swift

    init(matches: [DBFILESSearchMatch], more: NSNumber, start: NSNumber)

    Parameters

    matches

    A list (possibly empty) of matches for the query.
    more

    Used for paging. If true, indicates there is another page of results available that can be fetched by calling search again.
    start

    Used for paging. Value to set the start argument to when calling search to fetch the next page of results.

    Return Value

    An initialized instance.