DBFILESUploadSessionFinishError

@interface DBFILESUploadSessionFinishError
    : NSObject <DBSerializable, NSCopying>

The UploadSessionFinishError union.

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

  • Initializes union class with tag state of lookup_failed.

    Description of the lookup_failed tag state: The session arguments are incorrect; the value explains the reason.

    Declaration

    Objective-C

    - (nonnull instancetype)initWithLookupFailed:
        (nonnull DBFILESUploadSessionLookupError *)lookupFailed;

    Swift

    init(lookupFailed: DBFILESUploadSessionLookupError)

    Parameters

    lookupFailed

    The session arguments are incorrect; the value explains the reason.

    Return Value

    An initialized instance.

  • Initializes union class with tag state of path.

    Description of the path tag state: Unable to save the uploaded contents to a file.

    Declaration

    Objective-C

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

    Swift

    init(path: DBFILESWriteError)

    Parameters

    path

    Unable to save the uploaded contents to a file.

    Return Value

    An initialized instance.

  • Initializes union class with tag state of too_many_shared_folder_targets.

    Description of the too_many_shared_folder_targets tag state: The batch request commits files into too many different shared folders. Please limit your batch request to files contained in a single shared folder.

    Declaration

    Objective-C

    - (nonnull instancetype)initWithTooManySharedFolderTargets;

    Swift

    init(tooManySharedFolderTargets: ())

    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 happening in the user’s Dropbox. You should retry uploading this file.

    Declaration

    Objective-C

    - (nonnull instancetype)initWithTooManyWriteOperations;

    Swift

    init(tooManyWriteOperations: ())

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

    Note

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

    Declaration

    Objective-C

    - (BOOL)isLookupFailed;

    Swift

    func isLookupFailed() -> Bool

    Return Value

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

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

    Declaration

    Objective-C

    - (BOOL)isTooManySharedFolderTargets;

    Swift

    func isTooManySharedFolderTargets() -> Bool

    Return Value

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

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