DBFILESUploadSessionAppendArg

Objective-C

@interface DBFILESUploadSessionAppendArg : NSObject <DBSerializable, NSCopying>

Swift

class DBFILESUploadSessionAppendArg : NSObject, DBSerializable, NSCopying

The UploadSessionAppendArg struct.

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

Instance fields

  • Contains the upload session ID and the offset.

    Declaration

    Objective-C

    @property (nonatomic, readonly) DBFILESUploadSessionCursor *_Nonnull cursor;

    Swift

    var cursor: DBFILESUploadSessionCursor { get }

  • If true, the current session will be closed, at which point you won’t be able to call uploadSessionAppend anymore with the current session.

    Declaration

    Objective-C

    @property (nonatomic, readonly) NSNumber *_Nonnull close;

    Swift

    var close: NSNumber { get }

  • A hash of the file content uploaded in this call. If provided and the uploaded content does not match this hash, an error will be returned. For more information see our Content hash https://www.dropbox.com/developers/reference/content-hash page.

    Declaration

    Objective-C

    @property (nonatomic, copy, readonly, nullable) NSString *contentHash;

    Swift

    var contentHash: String? { get }

Constructors

  • Full constructor for the struct (exposes all instance variables).

    Declaration

    Objective-C

    - (nonnull instancetype)initWithCursor:
                            (nonnull DBFILESUploadSessionCursor *)cursor
                                 close:(nullable NSNumber *)close
                           contentHash:(nullable NSString *)contentHash;

    Swift

    init(cursor: DBFILESUploadSessionCursor, close: NSNumber?, contentHash: String?)

    Parameters

    cursor

    Contains the upload session ID and the offset.
    close

    If true, the current session will be closed, at which point you won’t be able to call uploadSessionAppend anymore with the current session.
    contentHash

    A hash of the file content uploaded in this call. If provided and the uploaded content does not match this hash, an error will be returned. For more information see our Content hash https://www.dropbox.com/developers/reference/content-hash page.

    Return Value

    An initialized instance.

  • Convenience constructor (exposes only non-nullable instance variables with no default value).

    Declaration

    Objective-C

    - (nonnull instancetype)initWithCursor:
    (nonnull DBFILESUploadSessionCursor *)cursor;

    Swift

    init(cursor: DBFILESUploadSessionCursor)

    Parameters

    cursor

    Contains the upload session ID and the offset.

    Return Value

    An initialized instance.