DBTEAMLegalHoldsListHeldRevisionsError

Objective-C

@interface DBTEAMLegalHoldsListHeldRevisionsError
    : NSObject <DBSerializable, NSCopying>

Swift

class DBTEAMLegalHoldsListHeldRevisionsError : NSObject, DBSerializable, NSCopying

The LegalHoldsListHeldRevisionsError 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

Constructors

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

    Description of the “unknown_legal_hold_error” tag state: There has been an unknown legal hold error.

    Declaration

    Objective-C

    - (nonnull instancetype)initWithUnknownLegalHoldError;

    Swift

    init(unknownLegalHoldError: ())

    Return Value

    An initialized instance.

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

    Description of the “insufficient_permissions” tag state: You don’t have permissions to perform this action.

    Declaration

    Objective-C

    - (nonnull instancetype)initWithInsufficientPermissions;

    Swift

    init(insufficientPermissions: ())

    Return Value

    An initialized instance.

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

    Declaration

    Objective-C

    - (nonnull instancetype)initWithOther;

    Swift

    init(other: ())

    Return Value

    An initialized instance.

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

    Description of the “transient_error” tag state: Temporary infrastructure failure, please retry.

    Declaration

    Objective-C

    - (nonnull instancetype)initWithTransientError;

    Swift

    init(transientError: ())

    Return Value

    An initialized instance.

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

    Description of the “legal_hold_still_empty” tag state: The legal hold is not holding any revisions yet.

    Declaration

    Objective-C

    - (nonnull instancetype)initWithLegalHoldStillEmpty;

    Swift

    init(legalHoldStillEmpty: ())

    Return Value

    An initialized instance.

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

    Description of the “inactive_legal_hold” tag state: Trying to list revisions for an inactive legal hold.

    Declaration

    Objective-C

    - (nonnull instancetype)initWithInactiveLegalHold;

    Swift

    init(inactiveLegalHold: ())

    Return Value

    An initialized instance.

Tag state methods

  • Retrieves whether the union’s current tag state has value “unknown_legal_hold_error”.

    Declaration

    Objective-C

    - (BOOL)isUnknownLegalHoldError;

    Swift

    func isUnknownLegalHoldError() -> Bool

    Return Value

    Whether the union’s current tag state has value “unknown_legal_hold_error”.

  • Retrieves whether the union’s current tag state has value “insufficient_permissions”.

    Declaration

    Objective-C

    - (BOOL)isInsufficientPermissions;

    Swift

    func isInsufficientPermissions() -> Bool

    Return Value

    Whether the union’s current tag state has value “insufficient_permissions”.

  • Retrieves whether the union’s current tag state has value “other”.

    Declaration

    Objective-C

    - (BOOL)isOther;

    Swift

    func isOther() -> Bool

    Return Value

    Whether the union’s current tag state has value “other”.

  • Retrieves whether the union’s current tag state has value “transient_error”.

    Declaration

    Objective-C

    - (BOOL)isTransientError;

    Swift

    func isTransientError() -> Bool

    Return Value

    Whether the union’s current tag state has value “transient_error”.

  • Retrieves whether the union’s current tag state has value “legal_hold_still_empty”.

    Declaration

    Objective-C

    - (BOOL)isLegalHoldStillEmpty;

    Swift

    func isLegalHoldStillEmpty() -> Bool

    Return Value

    Whether the union’s current tag state has value “legal_hold_still_empty”.

  • Retrieves whether the union’s current tag state has value “inactive_legal_hold”.

    Declaration

    Objective-C

    - (BOOL)isInactiveLegalHold;

    Swift

    func isInactiveLegalHold() -> Bool

    Return Value

    Whether the union’s current tag state has value “inactive_legal_hold”.

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