DBTEAMTeamMemberProfile

Objective-C

@interface DBTEAMTeamMemberProfile
    : DBTEAMMemberProfile <DBSerializable, NSCopying>

Swift

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

Instance fields


                    
                    
                    groups

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

Declaration

Objective-C

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

Swift

var groups: [String] { get }


                    
                    
                    memberFolderId

The namespace id of the user’s root folder.

Declaration

Objective-C

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

Swift

var memberFolderId: String { get }

Constructors


                    
                    
                    -initWithTeamMemberId:email:emailVerified:status:name:membershipType:groups:memberFolderId:externalId:accountId:secondaryEmails:invitedOn:joinedOn:suspendedOn:persistentId:isDirectoryRestricted:profilePhotoUrl:

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
          secondaryEmails:
              (nullable NSArray<DBSECONDARYEMAILSSecondaryEmail *> *)
                  secondaryEmails
                invitedOn:(nullable NSDate *)invitedOn
                 joinedOn:(nullable NSDate *)joinedOn
              suspendedOn:(nullable NSDate *)suspendedOn
             persistentId:(nullable NSString *)persistentId
    isDirectoryRestricted:(nullable NSNumber *)isDirectoryRestricted
          profilePhotoUrl:(nullable NSString *)profilePhotoUrl;

Swift

init(teamMemberId: String, email: String, emailVerified: NSNumber, status: DBTEAMTeamMemberStatus, name: DBUSERSName, membershipType: DBTEAMTeamMembershipType, groups: [String], memberFolderId: String, externalId: String?, accountId: String?, secondaryEmails: [DBSECONDARYEMAILSSecondaryEmail]?, invitedOn: Date?, joinedOn: Date?, suspendedOn: Date?, persistentId: String?, isDirectoryRestricted: NSNumber?, profilePhotoUrl: 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.
`secondaryEmails`	Secondary emails of a user.
`invitedOn`	The date and time the user was invited to the team (contains value only when the member’s status matches `invited` in `DBTEAMTeamMemberStatus`).
`joinedOn`	The date and time the user joined as a member of a specific team.
`suspendedOn`	The date and time the user was suspended from the team (contains value only when the member’s status matches `suspended` in `DBTEAMTeamMemberStatus`).
`persistentId`	Persistent ID that a team can attach to the user. The persistent ID is unique ID to be used for SAML authentication.
`isDirectoryRestricted`	Whether the user is a directory restricted user.
`profilePhotoUrl`	URL for the photo representing the user, if one is set.

Return Value

An initialized instance.


                    
                    
                    -initWithTeamMemberId:email:emailVerified:status:name:membershipType:groups:memberFolderId:

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.