DBFILESDeleteError

Objective-C

@interface DBFILESDeleteError : NSObject <DBSerializable, NSCopying>

Swift

class DBFILESDeleteError : NSObject, DBSerializable, NSCopying

The DeleteError 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) DBFILESDeleteErrorTag tag;

    Swift

    var tag: DBFILESDeleteErrorTag { get }

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

    Declaration

    Objective-C

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

    Swift

    var pathLookup: DBFILESLookupError { get }

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

    Declaration

    Objective-C

    @property (nonatomic, readonly) DBFILESWriteError *_Nonnull pathWrite;

    Swift

    var pathWrite: DBFILESWriteError { get }

Constructors

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

    Declaration

    Objective-C

    - (nonnull instancetype)initWithPathLookup:
    (nonnull DBFILESLookupError *)pathLookup;

    Swift

    init(pathLookup: DBFILESLookupError)

    Parameters

    pathLookup

    (no description).

    Return Value

    An initialized instance.

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

    Declaration

    Objective-C

    - (nonnull instancetype)initWithPathWrite:
    (nonnull DBFILESWriteError *)pathWrite;

    Swift

    init(pathWrite: DBFILESWriteError)

    Parameters

    pathWrite

    (no description).

    Return Value

    An initialized instance.

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

    Description of the “too_many_write_operations” tag state: There are too many write operations in user’s Dropbox. Please retry this request.

    Declaration

    Objective-C

    - (nonnull instancetype)initWithTooManyWriteOperations;

    Swift

    init(tooManyWriteOperations: ())

    Return Value

    An initialized instance.

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

    Description of the “too_many_files” tag state: There are too many files in one request. Please retry with fewer files.

    Declaration

    Objective-C

    - (nonnull instancetype)initWithTooManyFiles;

    Swift

    init(tooManyFiles: ())

    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_lookup”.

    Note

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

    Declaration

    Objective-C

    - (BOOL)isPathLookup;

    Swift

    func isPathLookup() -> Bool

    Return Value

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

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

    Note

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

    Declaration

    Objective-C

    - (BOOL)isPathWrite;

    Swift

    func isPathWrite() -> Bool

    Return Value

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

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

    Declaration

    Objective-C

    - (BOOL)isTooManyWriteOperations;

    Swift

    func isTooManyWriteOperations() -> Bool

    Return Value

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

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

    Declaration

    Objective-C

    - (BOOL)isTooManyFiles;

    Swift

    func isTooManyFiles() -> Bool

    Return Value

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

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