DBFILEPROPERTIESPropertiesSearchQuery

Objective-C

@interface DBFILEPROPERTIESPropertiesSearchQuery
    : NSObject <DBSerializable, NSCopying>

Swift

class DBFILEPROPERTIESPropertiesSearchQuery : NSObject, DBSerializable, NSCopying

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


                    
                    
                    query

The property field value for which to search across templates.

Declaration

Objective-C

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

Swift

var query: String { get }


                    
                    
                    mode

The mode with which to perform the search.

Declaration

Objective-C

@property (nonatomic, readonly) DBFILEPROPERTIESPropertiesSearchMode *_Nonnull mode;

Swift

var mode: DBFILEPROPERTIESPropertiesSearchMode { get }


                    
                    
                    logicalOperator

The logical operator with which to append the query.

Declaration

Objective-C

@property (nonatomic, readonly) DBFILEPROPERTIESLogicalOperator *_Nonnull logicalOperator;

Swift

var logicalOperator: DBFILEPROPERTIESLogicalOperator { get }

Constructors


                    
                    
                    -initWithQuery:mode:logicalOperator:

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

Declaration

Objective-C

- (nonnull instancetype)
      initWithQuery:(nonnull NSString *)query
               mode:(nonnull DBFILEPROPERTIESPropertiesSearchMode *)mode
    logicalOperator:(nullable DBFILEPROPERTIESLogicalOperator *)logicalOperator;

Swift

init(query: String, mode: DBFILEPROPERTIESPropertiesSearchMode, logicalOperator: DBFILEPROPERTIESLogicalOperator?)

Parameters

`query`	The property field value for which to search across templates.
`mode`	The mode with which to perform the search.
`logicalOperator`	The logical operator with which to append the query.

Return Value

An initialized instance.


                    
                    
                    -initWithQuery:mode:

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

Declaration

Objective-C

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

Swift

init(query: String, mode: DBFILEPROPERTIESPropertiesSearchMode)

Parameters

`query`	The property field value for which to search across templates.
`mode`	The mode with which to perform the search.

Return Value

An initialized instance.