DBFILESRelocationBatchV2JobStatus

Objective-C

@interface DBFILESRelocationBatchV2JobStatus
    : NSObject <DBSerializable, NSCopying>

Swift

class DBFILESRelocationBatchV2JobStatus : NSObject, DBSerializable, NSCopying

The RelocationBatchV2JobStatus union.

Result returned by dCopyBatchCheck or moveBatchCheck that may either be in progress or completed with result for each entry.

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) DBFILESRelocationBatchV2JobStatusTag tag;

Swift

var tag: DBFILESRelocationBatchV2JobStatusTag { get }

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

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

var complete: DBFILESRelocationBatchV2Result { 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 copy or move batch job has finished.

Declaration

Objective-C

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

Swift

init(complete: DBFILESRelocationBatchV2Result)

Parameters


                                complete

The copy or move batch job 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.