DBFILESUploadSessionFinishError

Objective-C

@interface DBFILESUploadSessionFinishError
    : NSObject <DBSerializable, NSCopying>

Swift

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

Instance fields

  • tag

    Represents the union’s current tag state.

    Declaration

    Objective-C

    @property (nonatomic, readonly) DBFILESUploadSessionFinishErrorTag tag;

    Swift

    var tag: DBFILESUploadSessionFinishErrorTag { get }
  • The session arguments are incorrect; the value explains the reason. @note Ensure the isLookupFailed method returns true before accessing, otherwise a runtime exception will be raised.

    Declaration

    Objective-C

    @property (nonatomic, readonly) DBFILESUploadSessionLookupError *_Nonnull lookupFailed;

    Swift

    var lookupFailed: DBFILESUploadSessionLookupError { get }
  • Unable to save the uploaded contents to a file. Data has already been appended to the upload session. Please retry with empty data body and updated offset. - note: Ensure the isPath method returns true before accessing, otherwise a runtime exception will be raised.

    Declaration

    Objective-C

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

    Swift

    var path: DBFILESWriteError { get }
  • The supplied property group is invalid. The file has uploaded without property groups. - note: Ensure the isPropertiesError method returns true before accessing, otherwise a runtime exception will be raised.

    Declaration

    Objective-C

    @property (nonatomic, readonly) DBFILEPROPERTIESInvalidPropertyGroupError *_Nonnull propertiesError;

    Swift

    var propertiesError: DBFILEPROPERTIESInvalidPropertyGroupError { get }

Constructors

  • 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. Data has already been appended to the upload session. Please retry with empty data body and updated offset.

    Declaration

    Objective-C

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

    Swift

    init(path: DBFILESWriteError)

    Parameters

    path

    Unable to save the uploaded contents to a file. Data has already been appended to the upload session. Please retry with empty data body and updated offset.

    Return Value

    An initialized instance.

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

    Description of the “properties_error” tag state: The supplied property group is invalid. The file has uploaded without property groups.

    Declaration

    Objective-C

    - (nonnull instancetype)initWithPropertiesError:
        (nonnull DBFILEPROPERTIESInvalidPropertyGroupError *)propertiesError;

    Swift

    init(propertiesError: DBFILEPROPERTIESInvalidPropertyGroupError)

    Parameters

    propertiesError

    The supplied property group is invalid. The file has uploaded without property groups.

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

    Description of the “concurrent_session_data_not_allowed” tag state: Uploading data not allowed when finishing concurrent upload session.

    Declaration

    Objective-C

    - (nonnull instancetype)initWithConcurrentSessionDataNotAllowed;

    Swift

    init(concurrentSessionDataNotAllowed: ())

    Return Value

    An initialized instance.

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

    Description of the “concurrent_session_not_closed” tag state: Concurrent upload sessions need to be closed before finishing.

    Declaration

    Objective-C

    - (nonnull instancetype)initWithConcurrentSessionNotClosed;

    Swift

    init(concurrentSessionNotClosed: ())

    Return Value

    An initialized instance.

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

    Description of the “concurrent_session_missing_data” tag state: Not all pieces of data were uploaded before trying to finish the session.

    Declaration

    Objective-C

    - (nonnull instancetype)initWithConcurrentSessionMissingData;

    Swift

    init(concurrentSessionMissingData: ())

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

    Note

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

    Declaration

    Objective-C

    - (BOOL)isPropertiesError;

    Swift

    func isPropertiesError() -> Bool

    Return Value

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

  • 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 “concurrent_session_data_not_allowed”.

    Declaration

    Objective-C

    - (BOOL)isConcurrentSessionDataNotAllowed;

    Swift

    func isConcurrentSessionDataNotAllowed() -> Bool

    Return Value

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

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

    Declaration

    Objective-C

    - (BOOL)isConcurrentSessionNotClosed;

    Swift

    func isConcurrentSessionNotClosed() -> Bool

    Return Value

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

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

    Declaration

    Objective-C

    - (BOOL)isConcurrentSessionMissingData;

    Swift

    func isConcurrentSessionMissingData() -> Bool

    Return Value

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

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