DBFILESUploadSessionAppendError

Objective-C

@interface DBFILESUploadSessionAppendError
    : NSObject <DBSerializable, NSCopying>

Swift

class DBFILESUploadSessionAppendError : NSObject, DBSerializable, NSCopying

The UploadSessionAppendError 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) DBFILESUploadSessionAppendErrorTag tag;

    Swift

    var tag: DBFILESUploadSessionAppendErrorTag { get }

  • The specified offset was incorrect. See the value for the correct offset. This error may occur when a previous request was received and processed successfully but the client did not receive the response, e.g. due to a network error. - note: Ensure the isIncorrectOffset method returns true before accessing, otherwise a runtime exception will be raised.

    Declaration

    Objective-C

    @property (nonatomic, readonly) DBFILESUploadSessionOffsetError *_Nonnull incorrectOffset;

    Swift

    var incorrectOffset: DBFILESUploadSessionOffsetError { get }

Constructors

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

    Description of the “not_found” tag state: The upload session ID was not found or has expired. Upload sessions are valid for 7 days.

    Declaration

    Objective-C

    - (nonnull instancetype)initWithNotFound;

    Swift

    init(notFound: ())

    Return Value

    An initialized instance.

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

    Description of the “incorrect_offset” tag state: The specified offset was incorrect. See the value for the correct offset. This error may occur when a previous request was received and processed successfully but the client did not receive the response, e.g. due to a network error.

    Declaration

    Objective-C

    - (nonnull instancetype)initWithIncorrectOffset:
    (nonnull DBFILESUploadSessionOffsetError *)incorrectOffset;

    Swift

    init(incorrectOffset: DBFILESUploadSessionOffsetError)

    Parameters

    incorrectOffset

    The specified offset was incorrect. See the value for the correct offset. This error may occur when a previous request was received and processed successfully but the client did not receive the response, e.g. due to a network error.

    Return Value

    An initialized instance.

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

    Description of the “closed” tag state: You are attempting to append data to an upload session that has already been closed (i.e. committed).

    Declaration

    Objective-C

    - (nonnull instancetype)initWithClosed;

    Swift

    init(closed: ())

    Return Value

    An initialized instance.

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

    Description of the “not_closed” tag state: The session must be closed before calling upload_session/finish_batch.

    Declaration

    Objective-C

    - (nonnull instancetype)initWithNotClosed;

    Swift

    init(notClosed: ())

    Return Value

    An initialized instance.

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

    Description of the “too_large” tag state: You can not append to the upload session because the size of a file should not reach the max file size limit (i.e. 350GB).

    Declaration

    Objective-C

    - (nonnull instancetype)initWithTooLarge;

    Swift

    init(tooLarge: ())

    Return Value

    An initialized instance.

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

    Description of the “concurrent_session_invalid_offset” tag state: For concurrent upload sessions, offset needs to be multiple of 4194304 bytes.

    Declaration

    Objective-C

    - (nonnull instancetype)initWithConcurrentSessionInvalidOffset;

    Swift

    init(concurrentSessionInvalidOffset: ())

    Return Value

    An initialized instance.

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

    Description of the “concurrent_session_invalid_data_size” tag state: For concurrent upload sessions, only chunks with size multiple of 4194304 bytes can be uploaded.

    Declaration

    Objective-C

    - (nonnull instancetype)initWithConcurrentSessionInvalidDataSize;

    Swift

    init(concurrentSessionInvalidDataSize: ())

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

    Declaration

    Objective-C

    - (nonnull instancetype)initWithOther;

    Swift

    init(other: ())

    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.

Tag state methods

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

    Declaration

    Objective-C

    - (BOOL)isNotFound;

    Swift

    func isNotFound() -> Bool

    Return Value

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

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

    Note

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

    Declaration

    Objective-C

    - (BOOL)isIncorrectOffset;

    Swift

    func isIncorrectOffset() -> Bool

    Return Value

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

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

    Declaration

    Objective-C

    - (BOOL)isClosed;

    Swift

    func isClosed() -> Bool

    Return Value

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

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

    Declaration

    Objective-C

    - (BOOL)isNotClosed;

    Swift

    func isNotClosed() -> Bool

    Return Value

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

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

    Declaration

    Objective-C

    - (BOOL)isTooLarge;

    Swift

    func isTooLarge() -> Bool

    Return Value

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

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

    Declaration

    Objective-C

    - (BOOL)isConcurrentSessionInvalidOffset;

    Swift

    func isConcurrentSessionInvalidOffset() -> Bool

    Return Value

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

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

    Declaration

    Objective-C

    - (BOOL)isConcurrentSessionInvalidDataSize;

    Swift

    func isConcurrentSessionInvalidDataSize() -> Bool

    Return Value

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

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

    Declaration

    Objective-C

    - (BOOL)isOther;

    Swift

    func isOther() -> Bool

    Return Value

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

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