DBTEAMLegalHoldsPolicyCreateError

Objective-C

@interface DBTEAMLegalHoldsPolicyCreateError
    : NSObject <DBSerializable, NSCopying>

Swift

class DBTEAMLegalHoldsPolicyCreateError : NSObject, DBSerializable, NSCopying

The LegalHoldsPolicyCreateError 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 “start_date_is_later_than_end_date”.

    Description of the “start_date_is_later_than_end_date” tag state: Start date must be earlier than end date.

    Declaration

    Objective-C

    - (nonnull instancetype)initWithStartDateIsLaterThanEndDate;

    Swift

    init(startDateIsLaterThanEndDate: ())

    Return Value

    An initialized instance.

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

    Description of the “empty_members_list” tag state: The users list must have at least one user.

    Declaration

    Objective-C

    - (nonnull instancetype)initWithEmptyMembersList;

    Swift

    init(emptyMembersList: ())

    Return Value

    An initialized instance.

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

    Description of the “invalid_members” tag state: Some members in the members list are not valid to be placed under legal hold.

    Declaration

    Objective-C

    - (nonnull instancetype)initWithInvalidMembers;

    Swift

    init(invalidMembers: ())

    Return Value

    An initialized instance.

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

    Description of the “number_of_users_on_hold_is_greater_than_hold_limitation” tag state: You cannot add more than 5 users in a legal hold.

    Declaration

    Objective-C

    - (nonnull instancetype)initWithNumberOfUsersOnHoldIsGreaterThanHoldLimitation;

    Swift

    init(numberOfUsersOnHoldIsGreaterThanHoldLimitation: ())

    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 “name_must_be_unique”.

    Description of the “name_must_be_unique” tag state: The name provided is already in use by another legal hold.

    Declaration

    Objective-C

    - (nonnull instancetype)initWithNameMustBeUnique;

    Swift

    init(nameMustBeUnique: ())

    Return Value

    An initialized instance.

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

    Description of the “team_exceeded_legal_hold_quota” tag state: Team exceeded legal hold quota.

    Declaration

    Objective-C

    - (nonnull instancetype)initWithTeamExceededLegalHoldQuota;

    Swift

    init(teamExceededLegalHoldQuota: ())

    Return Value

    An initialized instance.

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

    Description of the “invalid_date” tag state: The provided date is invalid.

    Declaration

    Objective-C

    - (nonnull instancetype)initWithInvalidDate;

    Swift

    init(invalidDate: ())

    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 “start_date_is_later_than_end_date”.

    Declaration

    Objective-C

    - (BOOL)isStartDateIsLaterThanEndDate;

    Swift

    func isStartDateIsLaterThanEndDate() -> Bool

    Return Value

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

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

    Declaration

    Objective-C

    - (BOOL)isEmptyMembersList;

    Swift

    func isEmptyMembersList() -> Bool

    Return Value

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

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

    Declaration

    Objective-C

    - (BOOL)isInvalidMembers;

    Swift

    func isInvalidMembers() -> Bool

    Return Value

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

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

    Declaration

    Objective-C

    - (BOOL)isNumberOfUsersOnHoldIsGreaterThanHoldLimitation;

    Swift

    func isNumberOfUsersOnHoldIsGreaterThanHoldLimitation() -> Bool

    Return Value

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

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

    Declaration

    Objective-C

    - (BOOL)isNameMustBeUnique;

    Swift

    func isNameMustBeUnique() -> Bool

    Return Value

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

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

    Declaration

    Objective-C

    - (BOOL)isTeamExceededLegalHoldQuota;

    Swift

    func isTeamExceededLegalHoldQuota() -> Bool

    Return Value

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

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

    Declaration

    Objective-C

    - (BOOL)isInvalidDate;

    Swift

    func isInvalidDate() -> Bool

    Return Value

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

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