DBUSERSFullAccount

Objective-C

@interface DBUSERSFullAccount : DBUSERSAccount <DBSerializable, NSCopying>

Swift

class DBUSERSFullAccount : DBUSERSAccount, DBSerializable, NSCopying

The FullAccount struct.

Detailed information about the current user’s account.

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

Instance fields

  • The user’s two-letter country code, if available. Country codes are based on ISO 3166-1 http://en.wikipedia.org/wiki/ISO_3166-1.

    Declaration

    Objective-C

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

    Swift

    var country: String? { get }
  • The language that the user specified. Locale tags will be IETF language tags http://en.wikipedia.org/wiki/IETF_language_tag.

    Declaration

    Objective-C

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

    Swift

    var locale: String { get }
  • The user’s referral link https://www.dropbox.com/referrals.

    Declaration

    Objective-C

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

    Swift

    var referralLink: String { get }
  • If this account is a member of a team, information about that team.

    Declaration

    Objective-C

    @property (nonatomic, readonly, nullable) DBUSERSFullTeam *team;

    Swift

    var team: DBUSERSFullTeam? { get }
  • This account’s unique team member id. This field will only be present if team is present.

    Declaration

    Objective-C

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

    Swift

    var teamMemberId: String? { get }
  • Whether the user has a personal and work account. If the current account is personal, then team will always be null, but isPaired will indicate if a work account is linked.

    Declaration

    Objective-C

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

    Swift

    var isPaired: NSNumber { get }
  • What type of account this user has.

    Declaration

    Objective-C

    @property (nonatomic, readonly) DBUSERSCOMMONAccountType *_Nonnull accountType;

    Swift

    var accountType: DBUSERSCOMMONAccountType { get }
  • The root info for this account.

    Declaration

    Objective-C

    @property (nonatomic, readonly) DBCOMMONRootInfo *_Nonnull rootInfo;

    Swift

    var rootInfo: DBCOMMONRootInfo { get }

Constructors

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

    Declaration

    Objective-C

    - (nonnull instancetype)
        initWithAccountId:(nonnull NSString *)accountId
                     name:(nonnull DBUSERSName *)name
                    email:(nonnull NSString *)email
            emailVerified:(nonnull NSNumber *)emailVerified
                 disabled:(nonnull NSNumber *)disabled
                   locale:(nonnull NSString *)locale
             referralLink:(nonnull NSString *)referralLink
                 isPaired:(nonnull NSNumber *)isPaired
              accountType:(nonnull DBUSERSCOMMONAccountType *)accountType
                 rootInfo:(nonnull DBCOMMONRootInfo *)rootInfo
          profilePhotoUrl:(nullable NSString *)profilePhotoUrl
                  country:(nullable NSString *)country
                     team:(nullable DBUSERSFullTeam *)team
             teamMemberId:(nullable NSString *)teamMemberId;

    Swift

    init(accountId: String, name: DBUSERSName, email: String, emailVerified: NSNumber, disabled: NSNumber, locale: String, referralLink: String, isPaired: NSNumber, accountType: DBUSERSCOMMONAccountType, rootInfo: DBCOMMONRootInfo, profilePhotoUrl: String?, country: String?, team: DBUSERSFullTeam?, teamMemberId: String?)

    Parameters

    accountId

    The user’s unique Dropbox ID.

    name

    Details of a user’s name.

    email

    The user’s email address. Do not rely on this without checking the emailVerified field. Even then, it’s possible that the user has since lost access to their email.

    emailVerified

    Whether the user has verified their email address.

    disabled

    Whether the user has been disabled.

    locale

    The language that the user specified. Locale tags will be IETF language tags http://en.wikipedia.org/wiki/IETF_language_tag.

    referralLink

    The user’s referral link https://www.dropbox.com/referrals.

    isPaired

    Whether the user has a personal and work account. If the current account is personal, then team will always be null, but isPaired will indicate if a work account is linked.

    accountType

    What type of account this user has.

    rootInfo

    The root info for this account.

    profilePhotoUrl

    URL for the photo representing the user, if one is set.

    country

    The user’s two-letter country code, if available. Country codes are based on ISO 3166-1 http://en.wikipedia.org/wiki/ISO_3166-1.

    team

    If this account is a member of a team, information about that team.

    teamMemberId

    This account’s unique team member id. This field will only be present if team is present.

    Return Value

    An initialized instance.

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

    Declaration

    Objective-C

    - (nonnull instancetype)
        initWithAccountId:(nonnull NSString *)accountId
                     name:(nonnull DBUSERSName *)name
                    email:(nonnull NSString *)email
            emailVerified:(nonnull NSNumber *)emailVerified
                 disabled:(nonnull NSNumber *)disabled
                   locale:(nonnull NSString *)locale
             referralLink:(nonnull NSString *)referralLink
                 isPaired:(nonnull NSNumber *)isPaired
              accountType:(nonnull DBUSERSCOMMONAccountType *)accountType
                 rootInfo:(nonnull DBCOMMONRootInfo *)rootInfo;

    Swift

    init(accountId: String, name: DBUSERSName, email: String, emailVerified: NSNumber, disabled: NSNumber, locale: String, referralLink: String, isPaired: NSNumber, accountType: DBUSERSCOMMONAccountType, rootInfo: DBCOMMONRootInfo)

    Parameters

    accountId

    The user’s unique Dropbox ID.

    name

    Details of a user’s name.

    email

    The user’s email address. Do not rely on this without checking the emailVerified field. Even then, it’s possible that the user has since lost access to their email.

    emailVerified

    Whether the user has verified their email address.

    disabled

    Whether the user has been disabled.

    locale

    The language that the user specified. Locale tags will be IETF language tags http://en.wikipedia.org/wiki/IETF_language_tag.

    referralLink

    The user’s referral link https://www.dropbox.com/referrals.

    isPaired

    Whether the user has a personal and work account. If the current account is personal, then team will always be null, but isPaired will indicate if a work account is linked.

    accountType

    What type of account this user has.

    rootInfo

    The root info for this account.

    Return Value

    An initialized instance.