BDKUserDetails Class Reference


                    
                    
                    alias

The user’s Bandyer alias.

Declaration

Objective-C

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

Swift

var alias: String { get }


                    
                    
                    firstname

The user’s first name. Can be nil.

Declaration

Objective-C

@property (nonatomic, strong, readonly, nullable) NSString *firstname;

Swift

var firstname: String? { get }


                    
                    
                    lastname

The user’s last name. Can be nil.

Declaration

Objective-C

@property (nonatomic, strong, readonly, nullable) NSString *lastname;

Swift

var lastname: String? { get }


                    
                    
                    email

The user’s email. Can be nil.

Declaration

Objective-C

@property (nonatomic, strong, readonly, nullable) NSString *email;

Swift

var email: String? { get }


                    
                    
                    nickname

The user’s nickname. Can ben nil.

Declaration

Objective-C

@property (nonatomic, strong, readonly, nullable) NSString *nickname;

Swift

var nickname: String? { get }


                    
                    
                    imageURL

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

Declaration

Objective-C

@property (nonatomic, strong, readonly, nullable) NSURL *imageURL;

Swift

var imageURL: URL? { get }


                    
                    
                    -initWithAlias:

Convenience initialiser initialising a BDKUserDetails object with 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

convenience init(alias: String)

Parameters


                                alias

The user’s alias.

Return Value

An initialised BDKUserDetails object with the values provided as arguments stored in the corresponding properties.


                    
                    
                    -initWithAlias:nickname:

Convenience initialiser initialising a BDKUserDetails object with the alias and the nickname provided as arguments.

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

Declaration

Objective-C

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

Swift

convenience init(alias: String, nickname: String?)

Parameters

`alias`	The user’s alias.
`nickname`	The user’s nickname. May be nil.

Return Value

An initialised BDKUserDetails object with the values provided as arguments stored in the corresponding properties.


                    
                    
                    -initWithAlias:firstname:lastname:

Convenience initialiser initialising a BDKUserDetails object with the user’s alias, firstname and lastname provided as arguments.

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

Declaration

Objective-C

- (nonnull instancetype)initWithAlias:(nonnull NSString *)alias
                            firstname:(nullable NSString *)firstname
                             lastname:(nullable NSString *)lastname;

Swift

convenience init(alias: String, firstname: String?, lastname: String?)

Parameters

`alias`	The user’s alias.
`firstname`	The user’s firstname. May be nil.
`lastname`	The user’s lastname. May be nil.

Return Value

An initialised BDKUserDetails object with the values provided as arguments stored in the corresponding properties.


                    
                    
                    -initWithAlias:firstname:lastname:imageURL:

Convenience initialiser initialising a BDKUserDetails object with the user’s alias, firstname, lastname and the user’s profile image URL provided as arguments.

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

Declaration

Objective-C

- (nonnull instancetype)initWithAlias:(nonnull NSString *)alias
                            firstname:(nullable NSString *)firstname
                             lastname:(nullable NSString *)lastname
                             imageURL:(nullable NSURL *)imageURL;

Swift

convenience init(alias: String, firstname: String?, lastname: String?, imageURL: URL?)

Parameters

`alias`	The user’s alias.
`firstname`	The user’s firstname. May be nil.
`lastname`	The user’s lastname. May be nil.
`imageURL`	The user’s profile image URL. May be nil.

Return Value

An initialised BDKUserDetails object with the values provided as arguments stored in the corresponding properties.


                    
                    
                    -initWithAlias:firstname:lastname:email:

Convenience initialiser initialising a BDKUserDetails object with the user’s alias, firstname, lastname and email provided as arguments.

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

Declaration

Objective-C

- (nonnull instancetype)initWithAlias:(nonnull NSString *)alias
                            firstname:(nullable NSString *)firstname
                             lastname:(nullable NSString *)lastname
                                email:(nullable NSString *)email;

Swift

convenience init(alias: String, firstname: String?, lastname: String?, email: String?)

Parameters

`alias`	The user’s alias.
`firstname`	The user’s firstname. May be nil.
`lastname`	The user’s lastname. May be nil.
`email`	The user’s email. May be nil.

Return Value

An initialised BDKUserDetails object with the values provided as arguments stored in the corresponding properties.


                    
                    
                    -initWithAlias:firstname:lastname:email:imageURL:

Convenience initialiser initialising a BDKUserDetails object with the user’s alias, firstname, lastname, email and the user’s profile image URL provided as arguments.

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

Declaration

Objective-C

- (nonnull instancetype)initWithAlias:(nonnull NSString *)alias
                            firstname:(nullable NSString *)firstname
                             lastname:(nullable NSString *)lastname
                                email:(nullable NSString *)email
                             imageURL:(nullable NSURL *)imageURL;

Swift

convenience init(alias: String, firstname: String?, lastname: String?, email: String?, imageURL: URL?)

Parameters

`alias`	The user’s alias.
`firstname`	The user’s firstname. May be nil.
`lastname`	The user’s lastname. May be nil.
`email`	The user’s email. May be nil.
`imageURL`	The user’s profile image URL. May be nil.

Return Value

An initialised BDKUserDetails object with the values provided as arguments stored in the corresponding properties.


                    
                    
                    -initWithAlias:firstname:lastname:email:nickname:imageURL:

Designated initialiser initialising a BDKUserDetails object with all the user details provided as arguments.

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

Declaration

Objective-C

- (nonnull instancetype)initWithAlias:(nonnull NSString *)alias
                            firstname:(nullable NSString *)firstname
                             lastname:(nullable NSString *)lastname
                                email:(nullable NSString *)email
                             nickname:(nullable NSString *)nickname
                             imageURL:(nullable NSURL *)imageURL;

Swift

init(alias: String, firstname: String?, lastname: String?, email: String?, nickname: String?, imageURL: URL?)

Parameters

`alias`	The user’s alias.
`firstname`	The user’s firstname. May be nil.
`lastname`	The user’s lastname. May be nil.
`email`	The user’s email. May be nil.
`nickname`	The user’s nickname. May be nil.
`imageURL`	The user’s profile image URL. May be nil.

Return Value

An initialised BDKUserDetails object with the values provided as arguments stored in the corresponding properties.