DBTEAMTeamMemberProfile

@interface DBTEAMTeamMemberProfile
    : DBTEAMMemberProfile <DBSerializable, NSCopying>

The TeamMemberProfile struct.

Profile of a user as a member of a team.

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

  • List of group IDs of groups that the user belongs to.

    Declaration

    Objective-C

    @property (readonly, nonatomic) NSArray<NSString *> *_Nonnull groups;

    Swift

    var groups: [String] { get }
  • The namespace id of the user’s root folder.

    Declaration

    Objective-C

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

    Swift

    var memberFolderId: String { get }
  • Full constructor for the struct (exposes all instance variables).

    Declaration

    Objective-C

    - (nonnull instancetype)
    initWithTeamMemberId:(nonnull NSString *)teamMemberId
                   email:(nonnull NSString *)email
           emailVerified:(nonnull NSNumber *)emailVerified
                  status:(nonnull DBTEAMTeamMemberStatus *)status
                    name:(nonnull DBUSERSName *)name
          membershipType:(nonnull DBTEAMTeamMembershipType *)membershipType
                  groups:(nonnull NSArray<NSString *> *)groups
          memberFolderId:(nonnull NSString *)memberFolderId
              externalId:(nullable NSString *)externalId
               accountId:(nullable NSString *)accountId
                joinedOn:(nullable NSDate *)joinedOn
            persistentId:(nullable NSString *)persistentId;

    Swift

    init(teamMemberId: String, email: String, emailVerified: NSNumber, status: DBTEAMTeamMemberStatus, name: DBUSERSName, membershipType: DBTEAMTeamMembershipType, groups: [String], memberFolderId: String, externalId: String?, accountId: String?, joinedOn: Date?, persistentId: String?)

    Parameters

    teamMemberId

    ID of user as a member of a team.

    email

    Email address of user.

    emailVerified

    Is true if the user’s email is verified to be owned by the user.

    status

    The user’s status as a member of a specific team.

    name

    Representations for a person’s name.

    membershipType

    The user’s membership type: full (normal team member) vs limited (does not use a license; no access to the team’s shared quota).

    groups

    List of group IDs of groups that the user belongs to.

    memberFolderId

    The namespace id of the user’s root folder.

    externalId

    External ID that a team can attach to the user. An application using the API may find it easier to use their own IDs instead of Dropbox IDs like account_id or team_member_id.

    accountId

    A user’s account identifier.

    joinedOn

    The date and time the user joined as a member of a specific team.

    persistentId

    Persistent ID that a team can attach to the user. The persistent ID is unique ID to be used for SAML authentication.

    Return Value

    An initialized instance.

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

    Declaration

    Objective-C

    - (nonnull instancetype)
    initWithTeamMemberId:(nonnull NSString *)teamMemberId
                   email:(nonnull NSString *)email
           emailVerified:(nonnull NSNumber *)emailVerified
                  status:(nonnull DBTEAMTeamMemberStatus *)status
                    name:(nonnull DBUSERSName *)name
          membershipType:(nonnull DBTEAMTeamMembershipType *)membershipType
                  groups:(nonnull NSArray<NSString *> *)groups
          memberFolderId:(nonnull NSString *)memberFolderId;

    Swift

    init(teamMemberId: String, email: String, emailVerified: NSNumber, status: DBTEAMTeamMemberStatus, name: DBUSERSName, membershipType: DBTEAMTeamMembershipType, groups: [String], memberFolderId: String)

    Parameters

    teamMemberId

    ID of user as a member of a team.

    email

    Email address of user.

    emailVerified

    Is true if the user’s email is verified to be owned by the user.

    status

    The user’s status as a member of a specific team.

    name

    Representations for a person’s name.

    membershipType

    The user’s membership type: full (normal team member) vs limited (does not use a license; no access to the team’s shared quota).

    groups

    List of group IDs of groups that the user belongs to.

    memberFolderId

    The namespace id of the user’s root folder.

    Return Value

    An initialized instance.