DBFILESSearchMode

Objective-C

@interface DBFILESSearchMode : NSObject <DBSerializable, NSCopying>

Swift

class DBFILESSearchMode : NSObject, DBSerializable, NSCopying

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

Constructors

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

    Description of the “filename” tag state: Search file and folder names.

    Declaration

    Objective-C

    - (nonnull instancetype)initWithFilename;

    Swift

    init(filename: ())

    Return Value

    An initialized instance.

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

    Description of the “filename_and_content” tag state: Search file and folder names as well as file contents.

    Declaration

    Objective-C

    - (nonnull instancetype)initWithFilenameAndContent;

    Swift

    init(filenameAndContent: ())

    Return Value

    An initialized instance.

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

    Description of the “deleted_filename” tag state: Search for deleted file and folder names.

    Declaration

    Objective-C

    - (nonnull instancetype)initWithDeletedFilename;

    Swift

    init(deletedFilename: ())

    Return Value

    An initialized instance.

Tag state methods

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

    Declaration

    Objective-C

    - (BOOL)isFilename;

    Swift

    func isFilename() -> Bool

    Return Value

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

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

    Declaration

    Objective-C

    - (BOOL)isFilenameAndContent;

    Swift

    func isFilenameAndContent() -> Bool

    Return Value

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

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

    Declaration

    Objective-C

    - (BOOL)isDeletedFilename;

    Swift

    func isDeletedFilename() -> Bool

    Return Value

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

  • 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.