DBFILEPROPERTIESPropertiesSearchResult

Objective-C

@interface DBFILEPROPERTIESPropertiesSearchResult
    : NSObject <DBSerializable, NSCopying>

Swift

class DBFILEPROPERTIESPropertiesSearchResult : NSObject, DBSerializable, NSCopying

The PropertiesSearchResult 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<DBFILEPROPERTIESPropertiesSearchMatch *> *_Nonnull matches;

    Swift

    var matches: [DBFILEPROPERTIESPropertiesSearchMatch] { get }

  • Pass the cursor into propertiesSearchContinue to continue to receive search results. Cursor will be null when there are no more 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<DBFILEPROPERTIESPropertiesSearchMatch *> *)matches
             cursor:(nullable NSString *)cursor;

    Swift

    init(matches: [DBFILEPROPERTIESPropertiesSearchMatch], cursor: String?)

    Parameters

    matches

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

    Pass the cursor into propertiesSearchContinue to continue to receive search results. Cursor will be null when there are no more 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<DBFILEPROPERTIESPropertiesSearchMatch *> *)matches;

    Swift

    init(matches: [DBFILEPROPERTIESPropertiesSearchMatch])

    Parameters

    matches

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

    Return Value

    An initialized instance.