DBFILESSearchError

Objective-C

@interface DBFILESSearchError : NSObject <DBSerializable, NSCopying>

Swift

class DBFILESSearchError : NSObject, DBSerializable, NSCopying

The SearchError 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) DBFILESSearchErrorTag tag;

    Swift

    var tag: DBFILESSearchErrorTag { get }

  • (no description). - note: Ensure the isPath method returns true before accessing, otherwise a runtime exception will be raised.

    Declaration

    Objective-C

    @property (nonatomic, readonly) DBFILESLookupError *_Nonnull path;

    Swift

    var path: DBFILESLookupError { get }

  • (no description). - note: Ensure the isInvalidArgument method returns true before accessing, otherwise a runtime exception will be raised.

    Declaration

    Objective-C

    @property (nonatomic, copy, readonly, nullable) NSString *invalidArgument;

    Swift

    var invalidArgument: String? { get }

Constructors

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

    Declaration

    Objective-C

    - (nonnull instancetype)initWithPath:(nonnull DBFILESLookupError *)path;

    Swift

    init(path: DBFILESLookupError)

    Parameters

    path

    (no description).

    Return Value

    An initialized instance.

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

    Declaration

    Objective-C

    - (nonnull instancetype)initWithInvalidArgument:
    (nullable NSString *)invalidArgument;

    Swift

    init(invalidArgument: String?)

    Parameters

    invalidArgument

    (no description).

    Return Value

    An initialized instance.

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

    Description of the “internal_error” tag state: Something went wrong, please try again.

    Declaration

    Objective-C

    - (nonnull instancetype)initWithInternalError;

    Swift

    init(internalError: ())

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

    Note

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

    Declaration

    Objective-C

    - (BOOL)isPath;

    Swift

    func isPath() -> Bool

    Return Value

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

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

    Note

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

    Declaration

    Objective-C

    - (BOOL)isInvalidArgument;

    Swift

    func isInvalidArgument() -> Bool

    Return Value

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

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

    Declaration

    Objective-C

    - (BOOL)isInternalError;

    Swift

    func isInternalError() -> Bool

    Return Value

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

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