DBFILEPROPERTIESPropertiesSearchMode

Objective-C

@interface DBFILEPROPERTIESPropertiesSearchMode
    : NSObject <DBSerializable, NSCopying>

Swift

class DBFILEPROPERTIESPropertiesSearchMode : NSObject, DBSerializable, NSCopying

The PropertiesSearchMode union.

This class implements the DBSerializable protocol (serialize and deserialize instance methods), which is required for all Obj-C SDK API route objects.

Instance fields

  • tag

    Represents the union’s current tag state.

    Declaration

    Objective-C

    @property (nonatomic, readonly) DBFILEPROPERTIESPropertiesSearchModeTag tag;

    Swift

    var tag: DBFILEPROPERTIESPropertiesSearchModeTag { get }

  • Search for a value associated with this field name. - note: Ensure the isFieldName method returns true before accessing, otherwise a runtime exception will be raised.

    Declaration

    Objective-C

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

    Swift

    var fieldName: String { get }

Constructors

  • Initializes union class with tag state of “field_name”.

    Description of the “field_name” tag state: Search for a value associated with this field name.

    Declaration

    Objective-C

    - (nonnull instancetype)initWithFieldName:(nonnull NSString *)fieldName;

    Swift

    init(fieldName: String)

    Parameters

    fieldName

    Search for a value associated with this field name.

    Return Value

    An initialized instance.

  • Initializes union class with tag state of “other”.

    Declaration

    Objective-C

    - (nonnull instancetype)initWithOther;

    Swift

    init(other: ())

    Return Value

    An initialized instance.

Tag state methods

  • Retrieves whether the union’s current tag state has value “field_name”.

    Note

    Call this method and ensure it returns true before accessing the fieldName property, otherwise a runtime exception will be thrown.

    Declaration

    Objective-C

    - (BOOL)isFieldName;

    Swift

    func isFieldName() -> Bool

    Return Value

    Whether the union’s current tag state has value “field_name”.

  • Retrieves whether the union’s current tag state has value “other”.

    Declaration

    Objective-C

    - (BOOL)isOther;

    Swift

    func isOther() -> Bool

    Return Value

    Whether the union’s current tag state has value “other”.

  • Retrieves string value of union’s current tag state.

    Declaration

    Objective-C

    - (nonnull NSString *)tagName;

    Swift

    func tagName() -> String

    Return Value

    A human-readable string representing the union’s current tag state.