DBFILESRelocationBatchJobStatus

Objective-C

@interface DBFILESRelocationBatchJobStatus
    : NSObject <DBSerializable, NSCopying>

Swift

class DBFILESRelocationBatchJobStatus : NSObject, DBSerializable, NSCopying

The RelocationBatchJobStatus 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) DBFILESRelocationBatchJobStatusTag tag;

Swift

var tag: DBFILESRelocationBatchJobStatusTag { 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) DBFILESRelocationBatchResult *_Nonnull complete;
Swift

var complete: DBFILESRelocationBatchResult { get }
failed
The copy or move batch job has failed with exception. - note: Ensure the isFailed method returns true before accessing, otherwise a runtime exception will be raised.
Declaration
Objective-C

@property (nonatomic, readonly) DBFILESRelocationBatchError *_Nonnull failed;
Swift

var failed: DBFILESRelocationBatchError { 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 DBFILESRelocationBatchResult *)complete;

Swift

init(complete: DBFILESRelocationBatchResult)

Parameters


                                complete

The copy or move batch job has finished.

Return Value

An initialized instance.


                    
                    
                    -initWithFailed:

Initializes union class with tag state of “failed”.

Description of the “failed” tag state: The copy or move batch job has failed with exception.

Declaration

Objective-C

- (nonnull instancetype)initWithFailed:
    (nonnull DBFILESRelocationBatchError *)failed;

Swift

init(failed: DBFILESRelocationBatchError)

Parameters


                                failed

The copy or move batch job has failed with exception.

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”.
-isFailed
Retrieves whether the union’s current tag state has value “failed”.

Note

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

- (BOOL)isFailed;
Swift

func isFailed() -> Bool
Return Value

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