DBTEAMMembersAddJobStatus

Objective-C

@interface DBTEAMMembersAddJobStatus : NSObject <DBSerializable, NSCopying>

Swift

class DBTEAMMembersAddJobStatus : NSObject, DBSerializable, NSCopying

The MembersAddJobStatus 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) DBTEAMMembersAddJobStatusTag tag;

    Swift

    var tag: DBTEAMMembersAddJobStatusTag { get }

  • The asynchronous job has finished. For each member that was specified in the parameter MembersAddArg that was provided to membersAdd, a corresponding item is returned in this list. - note: Ensure the isComplete method returns true before accessing, otherwise a runtime exception will be raised.

    Declaration

    Objective-C

    @property (nonatomic, readonly) NSArray<DBTEAMMemberAddResult *> *_Nonnull complete;

    Swift

    var complete: [DBTEAMMemberAddResult] { get }

  • The asynchronous job returned an error. The string contains an error message. - note: Ensure the isFailed method returns true before accessing, otherwise a runtime exception will be raised.

    Declaration

    Objective-C

    @property (nonatomic, copy, readonly) NSString *_Nonnull failed;

    Swift

    var failed: String { get }

Constructors

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

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

    Description of the “complete” tag state: The asynchronous job has finished. For each member that was specified in the parameter MembersAddArg that was provided to membersAdd, a corresponding item is returned in this list.

    Declaration

    Objective-C

    - (nonnull instancetype)initWithComplete:
    (nonnull NSArray<DBTEAMMemberAddResult *> *)complete;

    Swift

    init(complete: [DBTEAMMemberAddResult])

    Parameters

    complete

    The asynchronous job has finished. For each member that was specified in the parameter MembersAddArg that was provided to membersAdd, a corresponding item is returned in this list.

    Return Value

    An initialized instance.

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

    Description of the “failed” tag state: The asynchronous job returned an error. The string contains an error message.

    Declaration

    Objective-C

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

    Swift

    init(failed: String)

    Parameters

    failed

    The asynchronous job returned an error. The string contains an error message.

    Return Value

    An initialized instance.

Tag state methods

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

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

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

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