DBSHARINGGroupInfo

@interface DBSHARINGGroupInfo
    : DBTEAMCOMMONGroupSummary <DBSerializable, NSCopying>

The GroupInfo struct.

The information about a group. Groups is a way to manage a list of users who need same access permission to the shared folder.

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

  • The type of group.

    Declaration

    Objective-C

    @property (readonly, nonatomic) DBTEAMCOMMONGroupType *_Nonnull groupType;

    Swift

    var groupType: DBTEAMCOMMONGroupType { get }
  • If the current user is a member of the group.

    Declaration

    Objective-C

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

    Swift

    var isMember: NSNumber { get }
  • If the current user is an owner of the group.

    Declaration

    Objective-C

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

    Swift

    var isOwner: NSNumber { get }
  • If the group is owned by the current user’s team.

    Declaration

    Objective-C

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

    Swift

    var sameTeam: NSNumber { get }
  • 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
              groupType:(nonnull DBTEAMCOMMONGroupType *)groupType
               isMember:(nonnull NSNumber *)isMember
                isOwner:(nonnull NSNumber *)isOwner
               sameTeam:(nonnull NSNumber *)sameTeam
        groupExternalId:(nullable NSString *)groupExternalId
            memberCount:(nullable NSNumber *)memberCount;

    Swift

    init(groupName: String, groupId: String, groupManagementType: DBTEAMCOMMONGroupManagementType, groupType: DBTEAMCOMMONGroupType, isMember: NSNumber, isOwner: NSNumber, sameTeam: NSNumber, groupExternalId: String?, memberCount: NSNumber?)

    Parameters

    groupName

    (no description).

    groupId

    (no description).

    groupManagementType

    Who is allowed to manage the group.

    groupType

    The type of group.

    isMember

    If the current user is a member of the group.

    isOwner

    If the current user is an owner of the group.

    sameTeam

    If the group is owned by the current user’s team.

    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.

  • 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
              groupType:(nonnull DBTEAMCOMMONGroupType *)groupType
               isMember:(nonnull NSNumber *)isMember
                isOwner:(nonnull NSNumber *)isOwner
               sameTeam:(nonnull NSNumber *)sameTeam;

    Swift

    init(groupName: String, groupId: String, groupManagementType: DBTEAMCOMMONGroupManagementType, groupType: DBTEAMCOMMONGroupType, isMember: NSNumber, isOwner: NSNumber, sameTeam: NSNumber)

    Parameters

    groupName

    (no description).

    groupId

    (no description).

    groupManagementType

    Who is allowed to manage the group.

    groupType

    The type of group.

    isMember

    If the current user is a member of the group.

    isOwner

    If the current user is an owner of the group.

    sameTeam

    If the group is owned by the current user’s team.

    Return Value

    An initialized instance.