DBFILESUploadSessionFinishBatchJobStatus

Objective-C

@interface DBFILESUploadSessionFinishBatchJobStatus
    : NSObject <DBSerializable, NSCopying>

Swift

class DBFILESUploadSessionFinishBatchJobStatus : NSObject, DBSerializable, NSCopying

The UploadSessionFinishBatchJobStatus 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) DBFILESUploadSessionFinishBatchJobStatusTag tag;

Swift

var tag: DBFILESUploadSessionFinishBatchJobStatusTag { get }

complete
The uploadSessionFinishBatch has finished. - note: Ensure the isComplete method returns true before accessing, otherwise a runtime exception will be raised.
Declaration
Objective-C

@property (nonatomic, readonly) DBFILESUploadSessionFinishBatchResult *_Nonnull complete;
Swift

var complete: DBFILESUploadSessionFinishBatchResult { get }

Constructors

-initWithInProgress
Initializes union class with tag state of “in_progress”.

Description of the “in_progress” tag state: The asynchronous job is still in progress.
Declaration
Objective-C

- (nonnull instancetype)initWithInProgress;
Swift

init(inProgress: ())
Return Value

An initialized instance.


                    
                    
                    -initWithComplete:

Initializes union class with tag state of “complete”.

Description of the “complete” tag state: The uploadSessionFinishBatch has finished.

Declaration

Objective-C

- (nonnull instancetype)initWithComplete:
    (nonnull DBFILESUploadSessionFinishBatchResult *)complete;

Swift

init(complete: DBFILESUploadSessionFinishBatchResult)

Parameters


                                complete

The uploadSessionFinishBatch has finished.

Return Value

An initialized instance.

Tag state methods

-isInProgress
Retrieves whether the union’s current tag state has value “in_progress”.
Declaration
Objective-C

- (BOOL)isInProgress;
Swift

func isInProgress() -> Bool
Return Value

Whether the union’s current tag state has value “in_progress”.
-isComplete
Retrieves whether the union’s current tag state has value “complete”.

Note

Call this method and ensure it returns true before accessing the complete property, otherwise a runtime exception will be thrown.
Declaration
Objective-C

- (BOOL)isComplete;
Swift

func isComplete() -> Bool
Return Value

Whether the union’s current tag state has value “complete”.
-tagName
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.