DBFILESSearchMatchV2

Objective-C

@interface DBFILESSearchMatchV2 : NSObject <DBSerializable, NSCopying>

Swift

class DBFILESSearchMatchV2 : NSObject, DBSerializable, NSCopying

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


                    
                    
                    metadata

The metadata for the matched file or folder.

Declaration

Objective-C

@property (nonatomic, readonly) DBFILESMetadataV2 *_Nonnull metadata;

Swift

var metadata: DBFILESMetadataV2 { get }


                    
                    
                    matchType

The type of the match.

Declaration

Objective-C

@property (nonatomic, readonly, nullable) DBFILESSearchMatchTypeV2 *matchType;

Swift

var matchType: DBFILESSearchMatchTypeV2? { get }


                    
                    
                    highlightSpans

The list of HighlightSpan determines which parts of the file title should be highlighted.

Declaration

Objective-C

@property (nonatomic, readonly, nullable) NSArray<DBFILESHighlightSpan *> *highlightSpans;

Swift

var highlightSpans: [DBFILESHighlightSpan]? { get }

Constructors


                    
                    
                    -initWithMetadata:matchType:highlightSpans:

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

Declaration

Objective-C

- (nonnull instancetype)
    initWithMetadata:(nonnull DBFILESMetadataV2 *)metadata
           matchType:(nullable DBFILESSearchMatchTypeV2 *)matchType
      highlightSpans:(nullable NSArray<DBFILESHighlightSpan *> *)highlightSpans;

Swift

init(metadata: DBFILESMetadataV2, matchType: DBFILESSearchMatchTypeV2?, highlightSpans: [DBFILESHighlightSpan]?)

Parameters

`metadata`	The metadata for the matched file or folder.
`matchType`	The type of the match.
`highlightSpans`	The list of HighlightSpan determines which parts of the file title should be highlighted.

Return Value

An initialized instance.


                    
                    
                    -initWithMetadata:

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

Declaration

Objective-C

- (nonnull instancetype)initWithMetadata:(nonnull DBFILESMetadataV2 *)metadata;

Swift

init(metadata: DBFILESMetadataV2)

Parameters


                                metadata

The metadata for the matched file or folder.

Return Value

An initialized instance.