DBFILESUploadError

Objective-C

@interface DBFILESUploadError : NSObject <DBSerializable, NSCopying>

Swift

class DBFILESUploadError : NSObject, DBSerializable, NSCopying

The UploadError 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 “path”.

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

    Declaration

    Objective-C

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

    Swift

    init(path: DBFILESUploadWriteFailed)

    Parameters

    path

    Unable to save the uploaded contents to a file.

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

    Description of the “payload_too_large” tag state: The request payload must be at most 150 MB.

    Declaration

    Objective-C

    - (nonnull instancetype)initWithPayloadTooLarge;

    Swift

    init(payloadTooLarge: ())

    Return Value

    An initialized instance.

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

    Description of the “content_hash_mismatch” tag state: The content received by the Dropbox server in this call does not match the provided content hash.

    Declaration

    Objective-C

    - (nonnull instancetype)initWithContentHashMismatch;

    Swift

    init(contentHashMismatch: ())

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

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

    Declaration

    Objective-C

    - (BOOL)isPayloadTooLarge;

    Swift

    func isPayloadTooLarge() -> Bool

    Return Value

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

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

    Declaration

    Objective-C

    - (BOOL)isContentHashMismatch;

    Swift

    func isContentHashMismatch() -> Bool

    Return Value

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

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