DBTEAMMembersSuspendError

Objective-C

@interface DBTEAMMembersSuspendError : NSObject <DBSerializable, NSCopying>

Swift

class DBTEAMMembersSuspendError : NSObject, DBSerializable, NSCopying

The MembersSuspendError 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 “user_not_found”.

    Description of the “user_not_found” tag state: No matching user found. The provided team_member_id, email, or external_id does not exist on this team.

    Declaration

    Objective-C

    - (nonnull instancetype)initWithUserNotFound;

    Swift

    init(userNotFound: ())

    Return Value

    An initialized instance.

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

    Description of the “user_not_in_team” tag state: The user is not a member of the team.

    Declaration

    Objective-C

    - (nonnull instancetype)initWithUserNotInTeam;

    Swift

    init(userNotInTeam: ())

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

    Description of the “suspend_inactive_user” tag state: The user is not active, so it cannot be suspended.

    Declaration

    Objective-C

    - (nonnull instancetype)initWithSuspendInactiveUser;

    Swift

    init(suspendInactiveUser: ())

    Return Value

    An initialized instance.

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

    Description of the “suspend_last_admin” tag state: The user is the last admin of the team, so it cannot be suspended.

    Declaration

    Objective-C

    - (nonnull instancetype)initWithSuspendLastAdmin;

    Swift

    init(suspendLastAdmin: ())

    Return Value

    An initialized instance.

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

    Description of the “team_license_limit” tag state: Team is full. The organization has no available licenses.

    Declaration

    Objective-C

    - (nonnull instancetype)initWithTeamLicenseLimit;

    Swift

    init(teamLicenseLimit: ())

    Return Value

    An initialized instance.

Tag state methods

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

    Declaration

    Objective-C

    - (BOOL)isUserNotFound;

    Swift

    func isUserNotFound() -> Bool

    Return Value

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

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

    Declaration

    Objective-C

    - (BOOL)isUserNotInTeam;

    Swift

    func isUserNotInTeam() -> Bool

    Return Value

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

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

    Declaration

    Objective-C

    - (BOOL)isSuspendInactiveUser;

    Swift

    func isSuspendInactiveUser() -> Bool

    Return Value

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

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

    Declaration

    Objective-C

    - (BOOL)isSuspendLastAdmin;

    Swift

    func isSuspendLastAdmin() -> Bool

    Return Value

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

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

    Declaration

    Objective-C

    - (BOOL)isTeamLicenseLimit;

    Swift

    func isTeamLicenseLimit() -> Bool

    Return Value

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

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