DBFILESSearchV2Result

Objective-C

@interface DBFILESSearchV2Result : NSObject <DBSerializable, NSCopying>

Swift

class DBFILESSearchV2Result : NSObject, DBSerializable, NSCopying

The SearchV2Result 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<DBFILESSearchMatchV2 *> *_Nonnull matches;

    Swift

    var matches: [DBFILESSearchMatchV2] { get }
  • Used for paging. If true, indicates there is another page of results available that can be fetched by calling searchContinue with the cursor.

    Declaration

    Objective-C

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

    Swift

    var hasMore: NSNumber { get }
  • Pass the cursor into searchContinue to fetch the next page of results.

    Declaration

    Objective-C

    @property (nonatomic, copy, readonly, nullable) NSString *cursor;

    Swift

    var cursor: String? { get }

Constructors

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

    Declaration

    Objective-C

    - (nonnull instancetype)initWithMatches:
                                (nonnull NSArray<DBFILESSearchMatchV2 *> *)matches
                                    hasMore:(nonnull NSNumber *)hasMore
                                     cursor:(nullable NSString *)cursor;

    Swift

    init(matches: [DBFILESSearchMatchV2], hasMore: NSNumber, cursor: String?)

    Parameters

    matches

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

    hasMore

    Used for paging. If true, indicates there is another page of results available that can be fetched by calling searchContinue with the cursor.

    cursor

    Pass the cursor into searchContinue to fetch the next page of results.

    Return Value

    An initialized instance.

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

    Declaration

    Objective-C

    - (nonnull instancetype)initWithMatches:
                                (nonnull NSArray<DBFILESSearchMatchV2 *> *)matches
                                    hasMore:(nonnull NSNumber *)hasMore;

    Swift

    init(matches: [DBFILESSearchMatchV2], hasMore: NSNumber)

    Parameters

    matches

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

    hasMore

    Used for paging. If true, indicates there is another page of results available that can be fetched by calling searchContinue with the cursor.

    Return Value

    An initialized instance.