DBTEAMGroupCreateArg

Objective-C

@interface DBTEAMGroupCreateArg : NSObject <DBSerializable, NSCopying>

Swift

class DBTEAMGroupCreateArg : NSObject, DBSerializable, NSCopying

The GroupCreateArg struct.

This class implements the DBSerializable protocol (serialize and deserialize instance methods), which is required for all Obj-C SDK API route objects.

Instance fields

  • Group name.

    Declaration

    Objective-C

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

    Swift

    var groupName: String { get }

  • Automatically add the creator of the group.

    Declaration

    Objective-C

    @property (nonatomic, readonly) NSNumber *_Nonnull addCreatorAsOwner;

    Swift

    var addCreatorAsOwner: NSNumber { get }

  • The creator of a team can associate an arbitrary external ID to the group.

    Declaration

    Objective-C

    @property (nonatomic, copy, readonly, nullable) NSString *groupExternalId;

    Swift

    var groupExternalId: String? { get }

  • Whether the team can be managed by selected users, or only by team admins.

    Declaration

    Objective-C

    @property (nonatomic, readonly, nullable) DBTEAMCOMMONGroupManagementType *groupManagementType;

    Swift

    var groupManagementType: DBTEAMCOMMONGroupManagementType? { get }

Constructors

  • Full constructor for the struct (exposes all instance variables).

    Declaration

    Objective-C

    - (nonnull instancetype)initWithGroupName:(nonnull NSString *)groupName
                        addCreatorAsOwner:(nullable NSNumber *)addCreatorAsOwner
                          groupExternalId:(nullable NSString *)groupExternalId
                      groupManagementType:
                          (nullable DBTEAMCOMMONGroupManagementType *)
                              groupManagementType;

    Swift

    init(groupName: String, addCreatorAsOwner: NSNumber?, groupExternalId: String?, groupManagementType: DBTEAMCOMMONGroupManagementType?)

    Parameters

    groupName

    Group name.
    addCreatorAsOwner

    Automatically add the creator of the group.
    groupExternalId

    The creator of a team can associate an arbitrary external ID to the group.
    groupManagementType

    Whether the team can be managed by selected users, or only by team admins.

    Return Value

    An initialized instance.

  • Convenience constructor (exposes only non-nullable instance variables with no default value).

    Declaration

    Objective-C

    - (nonnull instancetype)initWithGroupName:(nonnull NSString *)groupName;

    Swift

    init(groupName: String)

    Parameters

    groupName

    Group name.

    Return Value

    An initialized instance.