DBTEAMMemberProfile

@interface DBTEAMMemberProfile : NSObject <DBSerializable, NSCopying>

The MemberProfile struct.

Basic member profile.

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

  • ID of user as a member of a team.

    Declaration

    Objective-C

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

    Swift

    var teamMemberId: String { get }
  • 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.

    Declaration

    Objective-C

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

    Swift

    var externalId: String? { get }
  • A user’s account identifier.

    Declaration

    Objective-C

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

    Swift

    var accountId: String? { get }
  • Email address of user.

    Declaration

    Objective-C

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

    Swift

    var email: String { get }
  • Is true if the user’s email is verified to be owned by the user.

    Declaration

    Objective-C

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

    Swift

    var emailVerified: NSNumber { get }
  • The user’s status as a member of a specific team.

    Declaration

    Objective-C

    @property (readonly, nonatomic) DBTEAMTeamMemberStatus *_Nonnull status;

    Swift

    var status: DBTEAMTeamMemberStatus { get }
  • Representations for a person’s name.

    Declaration

    Objective-C

    @property (readonly, nonatomic) DBUSERSName *_Nonnull name;

    Swift

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

    Declaration

    Objective-C

    @property (readonly, nonatomic)
        DBTEAMTeamMembershipType *_Nonnull membershipType;

    Swift

    var membershipType: DBTEAMTeamMembershipType { get }
  • The date and time the user joined as a member of a specific team.

    Declaration

    Objective-C

    @property (readonly, nonatomic, nullable) NSDate *joinedOn;

    Swift

    var joinedOn: Date? { get }
  • Persistent ID that a team can attach to the user. The persistent ID is unique ID to be used for SAML authentication.

    Declaration

    Objective-C

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

    Swift

    var persistentId: 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
              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, 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).

    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;

    Swift

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

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

    Return Value

    An initialized instance.