DBUSERSName

Objective-C

@interface DBUSERSName : NSObject <DBSerializable, NSCopying>

Swift

class DBUSERSName : NSObject, DBSerializable, NSCopying

The Name struct.

Representations for a person’s name to assist with internationalization.

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

Instance fields

  • Also known as a first name.

    Declaration

    Objective-C

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

    Swift

    var givenName: String { get }

  • Also known as a last name or family name.

    Declaration

    Objective-C

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

    Swift

    var surname: String { get }

  • Locale-dependent name. In the US, a person’s familiar name is their givenName, but elsewhere, it could be any combination of a person’s givenName and surname.

    Declaration

    Objective-C

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

    Swift

    var familiarName: String { get }

  • A name that can be used directly to represent the name of a user’s Dropbox account.

    Declaration

    Objective-C

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

    Swift

    var displayName: String { get }

  • An abbreviated form of the person’s name. Their initials in most locales.

    Declaration

    Objective-C

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

    Swift

    var abbreviatedName: String { get }

Constructors

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

    Declaration

    Objective-C

    - (nonnull instancetype)initWithGivenName:(nonnull NSString *)givenName
                                  surname:(nonnull NSString *)surname
                             familiarName:(nonnull NSString *)familiarName
                              displayName:(nonnull NSString *)displayName
                          abbreviatedName:(nonnull NSString *)abbreviatedName;

    Swift

    init(givenName: String, surname: String, familiarName: String, displayName: String, abbreviatedName: String)

    Parameters

    givenName

    Also known as a first name.
    surname

    Also known as a last name or family name.
    familiarName

    Locale-dependent name. In the US, a person’s familiar name is their givenName, but elsewhere, it could be any combination of a person’s givenName and surname.
    displayName

    A name that can be used directly to represent the name of a user’s Dropbox account.
    abbreviatedName

    An abbreviated form of the person’s name. Their initials in most locales.

    Return Value

    An initialized instance.