DBFILESSearchMatchTypeV2

Objective-C

@interface DBFILESSearchMatchTypeV2 : NSObject <DBSerializable, NSCopying>

Swift

class DBFILESSearchMatchTypeV2 : NSObject, DBSerializable, NSCopying

The SearchMatchTypeV2 union.

Indicates what type of match was found for a given item.

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: This item was matched on its file or folder name.

    Declaration

    Objective-C

    - (nonnull instancetype)initWithFilename;

    Swift

    init(filename: ())

    Return Value

    An initialized instance.

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

    Description of the “file_content” tag state: This item was matched based on its file contents.

    Declaration

    Objective-C

    - (nonnull instancetype)initWithFileContent;

    Swift

    init(fileContent: ())

    Return Value

    An initialized instance.

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

    Description of the “filename_and_content” tag state: This item was matched based on both its contents and its file name.

    Declaration

    Objective-C

    - (nonnull instancetype)initWithFilenameAndContent;

    Swift

    init(filenameAndContent: ())

    Return Value

    An initialized instance.

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

    Description of the “image_content” tag state: This item was matched on image content.

    Declaration

    Objective-C

    - (nonnull instancetype)initWithImageContent;

    Swift

    init(imageContent: ())

    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 “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 “file_content”.

    Declaration

    Objective-C

    - (BOOL)isFileContent;

    Swift

    func isFileContent() -> Bool

    Return Value

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

  • 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 “image_content”.

    Declaration

    Objective-C

    - (BOOL)isImageContent;

    Swift

    func isImageContent() -> Bool

    Return Value

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

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