DBFILEPROPERTIESLookupError

@interface DBFILEPROPERTIESLookupError : NSObject <DBSerializable, NSCopying>

The LookupError union.

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

  • tag

    Represents the union’s current tag state.

    Declaration

    Objective-C

    @property (readonly, nonatomic) DBFILEPROPERTIESLookupErrorTag tag;

    Swift

    var tag: DBFILEPROPERTIESLookupErrorTag { get }
  • (no description). - note: Ensure the isMalformedPath method returns true before accessing, otherwise a runtime exception will be raised.

    Declaration

    Objective-C

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

    Swift

    var malformedPath: String { get }
  • Initializes union class with tag state of malformed_path.

    Declaration

    Objective-C

    - (nonnull instancetype)initWithMalformedPath:(nonnull NSString *)malformedPath;

    Swift

    init(malformedPath: String)

    Parameters

    malformedPath

    (no description).

    Return Value

    An initialized instance.

  • Initializes union class with tag state of not_found.

    Description of the not_found tag state: There is nothing at the given path.

    Declaration

    Objective-C

    - (nonnull instancetype)initWithNotFound;

    Swift

    init(notFound: ())

    Return Value

    An initialized instance.

  • Initializes union class with tag state of not_file.

    Description of the not_file tag state: We were expecting a file, but the given path refers to something that isn’t a file.

    Declaration

    Objective-C

    - (nonnull instancetype)initWithNotFile;

    Swift

    init(notFile: ())

    Return Value

    An initialized instance.

  • Initializes union class with tag state of not_folder.

    Description of the not_folder tag state: We were expecting a folder, but the given path refers to something that isn’t a folder.

    Declaration

    Objective-C

    - (nonnull instancetype)initWithNotFolder;

    Swift

    init(notFolder: ())

    Return Value

    An initialized instance.

  • Initializes union class with tag state of restricted_content.

    Description of the restricted_content tag state: The file cannot be transferred because the content is restricted. For example, sometimes there are legal restrictions due to copyright claims.

    Declaration

    Objective-C

    - (nonnull instancetype)initWithRestrictedContent;

    Swift

    init(restrictedContent: ())

    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.

  • Retrieves whether the union’s current tag state has value malformed_path.

    Note

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

    Declaration

    Objective-C

    - (BOOL)isMalformedPath;

    Swift

    func isMalformedPath() -> Bool

    Return Value

    Whether the union’s current tag state has value malformed_path.

  • Retrieves whether the union’s current tag state has value not_found.

    Declaration

    Objective-C

    - (BOOL)isNotFound;

    Swift

    func isNotFound() -> Bool

    Return Value

    Whether the union’s current tag state has value not_found.

  • Retrieves whether the union’s current tag state has value not_file.

    Declaration

    Objective-C

    - (BOOL)isNotFile;

    Swift

    func isNotFile() -> Bool

    Return Value

    Whether the union’s current tag state has value not_file.

  • Retrieves whether the union’s current tag state has value not_folder.

    Declaration

    Objective-C

    - (BOOL)isNotFolder;

    Swift

    func isNotFolder() -> Bool

    Return Value

    Whether the union’s current tag state has value not_folder.

  • Retrieves whether the union’s current tag state has value restricted_content.

    Declaration

    Objective-C

    - (BOOL)isRestrictedContent;

    Swift

    func isRestrictedContent() -> Bool

    Return Value

    Whether the union’s current tag state has value restricted_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.