DBTEAMGroupCreateError

Objective-C

@interface DBTEAMGroupCreateError : NSObject <DBSerializable, NSCopying>

Swift

class DBTEAMGroupCreateError : NSObject, DBSerializable, NSCopying

The GroupCreateError 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 “group_name_already_used”.

    Description of the “group_name_already_used” tag state: The requested group name is already being used by another group.

    Declaration

    Objective-C

    - (nonnull instancetype)initWithGroupNameAlreadyUsed;

    Swift

    init(groupNameAlreadyUsed: ())

    Return Value

    An initialized instance.

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

    Description of the “group_name_invalid” tag state: Group name is empty or has invalid characters.

    Declaration

    Objective-C

    - (nonnull instancetype)initWithGroupNameInvalid;

    Swift

    init(groupNameInvalid: ())

    Return Value

    An initialized instance.

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

    Description of the “external_id_already_in_use” tag state: The requested external ID is already being used by another group.

    Declaration

    Objective-C

    - (nonnull instancetype)initWithExternalIdAlreadyInUse;

    Swift

    init(externalIdAlreadyInUse: ())

    Return Value

    An initialized instance.

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

    Description of the “system_managed_group_disallowed” tag state: System-managed group cannot be manually created.

    Declaration

    Objective-C

    - (nonnull instancetype)initWithSystemManagedGroupDisallowed;

    Swift

    init(systemManagedGroupDisallowed: ())

    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.

Tag state methods

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

    Declaration

    Objective-C

    - (BOOL)isGroupNameAlreadyUsed;

    Swift

    func isGroupNameAlreadyUsed() -> Bool

    Return Value

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

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

    Declaration

    Objective-C

    - (BOOL)isGroupNameInvalid;

    Swift

    func isGroupNameInvalid() -> Bool

    Return Value

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

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

    Declaration

    Objective-C

    - (BOOL)isExternalIdAlreadyInUse;

    Swift

    func isExternalIdAlreadyInUse() -> Bool

    Return Value

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

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

    Declaration

    Objective-C

    - (BOOL)isSystemManagedGroupDisallowed;

    Swift

    func isSystemManagedGroupDisallowed() -> Bool

    Return Value

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

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