DBFILESLookupError

Objective-C

@interface DBFILESLookupError : NSObject <DBSerializable, NSCopying>

Swift

class DBFILESLookupError : 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.

Instance fields

Constructors

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

    Description of the “malformed_path” tag state: The given path does not satisfy the required path format. Please refer to the Path formats documentation https://www.dropbox.com/developers/documentation/http/documentation#path-formats for more information.

    Declaration

    Objective-C

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

    Swift

    init(malformedPath: String?)

    Parameters

    malformedPath

    The given path does not satisfy the required path format. Please refer to the Path formats documentation https://www.dropbox.com/developers/documentation/http/documentation#path-formats for more information.

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

    Description of the “unsupported_content_type” tag state: This operation is not supported for this content type.

    Declaration

    Objective-C

    - (nonnull instancetype)initWithUnsupportedContentType;

    Swift

    init(unsupportedContentType: ())

    Return Value

    An initialized instance.

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

    Description of the “locked” tag state: The given path is locked.

    Declaration

    Objective-C

    - (nonnull instancetype)initWithLocked;

    Swift

    init(locked: ())

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

    Declaration

    Objective-C

    - (BOOL)isUnsupportedContentType;

    Swift

    func isUnsupportedContentType() -> Bool

    Return Value

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

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

    Declaration

    Objective-C

    - (BOOL)isLocked;

    Swift

    func isLocked() -> Bool

    Return Value

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

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