BDKUserInfoDisplayItem

Objective-C

@interface BDKUserInfoDisplayItem : NSObject <NSCopying>

Swift

class BDKUserInfoDisplayItem : NSObject, NSCopying

A class holding user display information.

Instances of this class will be used when displaying user information in the view controller views.

  • The user id.

    Declaration

    Objective-C

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

    Swift

    var alias: String { get }

  • The user first name. Can be nil.

    Declaration

    Objective-C

    @property (nonatomic, copy, nullable) NSString *firstName;

    Swift

    var firstName: String? { get set }

  • The user last name. Can be nil.

    Declaration

    Objective-C

    @property (nonatomic, copy, nullable) NSString *lastName;

    Swift

    var lastName: String? { get set }

  • The user email. Can be nil.

    Declaration

    Objective-C

    @property (nonatomic, copy, nullable) NSString *email;

    Swift

    var email: String? { get set }

  • The user nickname. Can ben nil.

    Declaration

    Objective-C

    @property (nonatomic, copy, nullable) NSString *nickname;

    Swift

    var nickname: String? { get set }

  • The user image local URL. The URL must be a file URL, it cannot be a remote URL.

    Declaration

    Objective-C

    @property (nonatomic, copy, nullable) NSURL *imageURL;

    Swift

    var imageURL: URL? { get set }

  • The UIImage loaded from the imageURL provided.

    Declaration

    Objective-C

    @property (nonatomic, copy, readonly, nullable) UIImage *image;

    Swift

    @NSCopying var image: UIImage? { get }

  • Initialize a new item for the alias provided as argument.

    Throws: an NSInvalidArgumentException is thrown if a nil alias is provided as argument.

    Declaration

    Objective-C

    - (nonnull instancetype)initWithAlias:(nonnull NSString *)alias;

    Swift

    init(alias: String)

    Parameters

    alias

    The user id.

    Return Value

    A new initialized item.