DBBatchUploadTask

Objective-C

@interface DBBatchUploadTask : NSObject

Swift

class DBBatchUploadTask : NSObject

Dropbox task object for custom batch upload route.

The batch upload route is a convenience layer over several of our auto-generated API endpoints. For this reason, there is less flexibility and granularity of control. Progress and response handlers are passed directly into this route (rather than installed via this task object) and only cancel is available. This task is also specific to only one endpoint, rather than an entire class (style) of endpoints.

  • DBBatchUploadTask full constructor.

    @returns A DBBatchUploadTask instance.

    Declaration

    Objective-C

    - (nonnull instancetype)initWithUploadData:
    (nonnull DBBatchUploadData *)uploadData;

    Swift

    init(uploadData: DBBatchUploadData)

    Parameters

    uploadData

    relevant to the particular batch upload request.

  • Cancels the current request.

    Declaration

    Objective-C

    - (void)cancel;

    Swift

    func cancel()

  • Determines whether there are any upload tasks still in progress.

    NOTE: This will return NO during the final polling / commit phase of batch upload.

    Declaration

    Objective-C

    - (BOOL)uploadsInProgress;

    Swift

    func uploadsInProgress() -> Bool

    Return Value

    Whether there are any upload tasks in progress.