DBTEAMCOMMONGroupSummary

Objective-C

@interface DBTEAMCOMMONGroupSummary : NSObject <DBSerializable, NSCopying>

Swift

class DBTEAMCOMMONGroupSummary : NSObject, DBSerializable, NSCopying

The GroupSummary struct.

Information about a group.

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

Instance fields


                    
                    
                    groupName

(no description).

Declaration

Objective-C

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

Swift

var groupName: String { get }


                    
                    
                    groupId

(no description).

Declaration

Objective-C

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

Swift

var groupId: String { get }

groupExternalId
External ID of group. This is an arbitrary ID that an admin can attach to a group.
Declaration
Objective-C

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

var groupExternalId: String? { get }


                    
                    
                    memberCount

The number of members in the group.

Declaration

Objective-C

@property (nonatomic, readonly, nullable) NSNumber *memberCount;

Swift

var memberCount: NSNumber? { get }


                    
                    
                    groupManagementType

Who is allowed to manage the group.

Declaration

Objective-C

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

Swift

var groupManagementType: DBTEAMCOMMONGroupManagementType { get }

Constructors


                    
                    
                    -initWithGroupName:groupId:groupManagementType:groupExternalId:memberCount:

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

Declaration

Objective-C

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

Swift

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

Parameters

`groupName`	(no description).
`groupId`	(no description).
`groupManagementType`	Who is allowed to manage the group.
`groupExternalId`	External ID of group. This is an arbitrary ID that an admin can attach to a group.
`memberCount`	The number of members in the group.

Return Value

An initialized instance.


                    
                    
                    -initWithGroupName:groupId:groupManagementType:

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

Declaration

Objective-C

- (nonnull instancetype)initWithGroupName:(nonnull NSString *)groupName
                                  groupId:(nonnull NSString *)groupId
                      groupManagementType:
                          (nonnull DBTEAMCOMMONGroupManagementType *)
                              groupManagementType;

Swift

init(groupName: String, groupId: String, groupManagementType: DBTEAMCOMMONGroupManagementType)

Parameters

`groupName`	(no description).
`groupId`	(no description).
`groupManagementType`	Who is allowed to manage the group.

Return Value

An initialized instance.