UserDetails

@available(iOS 12.0, *)
@objc(BDKUserDetails)
public class UserDetails : NSObject

A class holding user profile information.

Properties

userID
The user’s ID in the Kaleyra Video platform.
Declaration
Swift

@objc public let userID: String


                    
                    
                    firstname

The user’s first name.

Declaration

Swift

@objc
public var firstname: String? { get }


                    
                    
                    lastname

The user’s last name.

Declaration

Swift

@objc
public var lastname: String? { get }

displayName
The user’s display name.

Since
3.5.0
Declaration
Swift

@objc public var displayName: String? { get }
email
The user’s email.
Declaration
Swift

@objc public var email: String? { get }


                    
                    
                    nickname

The user’s nickname.

Declaration

Swift

@objc
public var nickname: String? { get }

imageURL
The user’s image URL. The URL may be a remote URL.
Declaration
Swift

@objc public var imageURL: URL? { get }

Initialization


                    
                    
                    init(userID:)

Convenience initializer initializing a UserDetails object with the userID provided as argument.

Declaration

Swift

@objc(initWithUserID:)
public convenience init(userID: String)

Parameters


                                userID

The user’s ID.

Return Value

An initialized UserDetails object with the values provided as arguments stored in the corresponding properties.


                    
                    
                    init(userID:nickname:)

Convenience initializer initializing a UserDetails object with the userID and the nickname provided as arguments.

Declaration

Swift

@objc(initWithUserID:nickname:)
public convenience init(userID: String, nickname: String?)

Parameters

`userID`	The user’s ID.
`nickname`	The user’s nickname. May be nil.

Return Value

An initialized UserDetails object with the values provided as arguments stored in the corresponding properties.


                    
                    
                    init(userID:displayName:)

Convenience initializer initializing a UserDetails object with the userID and the display name provided as arguments.

Since

3.5.0

Declaration

Swift

@objc(initWithUserID:displayName:)
public convenience init(userID: String, displayName: String?)

Parameters

`userID`	The user’s ID.
`displayName`	The user’s display name. May be nil.

Return Value

An initialized UserDetails object with the values provided as arguments stored in the corresponding properties.


                    
                    
                    init(userID:displayName:imageURL:)

Convenience initializer initializing a UserDetails object with the userID and the display name provided as arguments.

Since

3.5.0

Declaration

Swift

@objc(initWithUserID:displayName:imageURL:)
public convenience init(userID: String, displayName: String?, imageURL: URL?)

Parameters

`userID`	The user’s ID.
`displayName`	The user’s display name. May be nil.
`imageURL`	The user’s profile image URL. May be nil.

Return Value

An initialized UserDetails object with the values provided as arguments stored in the corresponding properties.


                    
                    
                    init(userID:firstname:lastname:)

Convenience initializer initializing a UserDetails object with the user’s userID, firstname and lastname provided as arguments.

Declaration

Swift

@objc(initWithUserID:firstname:lastname:)
public convenience init(userID: String, firstname: String?, lastname: String?)

Parameters

`userID`	The user’s ID.
`firstname`	The user’s firstname.
`lastname`	The user’s lastname.

Return Value

An initialized UserDetails object with the values provided as arguments stored in the corresponding properties.


                    
                    
                    init(userID:firstname:lastname:imageURL:)

Convenience initializer initializing a UserDetails object with the user’s userID, firstname, lastname and the user’s profile image URL provided as arguments.

Declaration

Swift

@objc(initWithUserID:firstname:lastname:imageURL:)
public convenience init(userID: String, firstname: String?, lastname: String?, imageURL: URL?)

Parameters

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

Return Value

An initialized UserDetails object with the values provided as arguments stored in the corresponding properties.


                    
                    
                    init(userID:firstname:lastname:email:)

Convenience initializer initializing a UserDetails object with the user’s userID, firstname, lastname and email provided as arguments.

Declaration

Swift

@objc(initWithUserID:firstname:lastname:email:)
public convenience init(userID: String, firstname: String?, lastname: String?, email: String?)

Parameters

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

Return Value

An initialized UserDetails object with the values provided as arguments stored in the corresponding properties.


                    
                    
                    init(userID:firstname:lastname:email:imageURL:)

Convenience initializer initializing a UserDetails object with the user’s userID, firstname, lastname, email and the user’s profile image URL provided as arguments.

Declaration

Swift

@objc(initWithUserID:firstname:lastname:email:imageURL:)
public convenience init(userID: String, firstname: String?, lastname: String?, email: String?, imageURL: URL?)

Parameters

`userID`	The user’s ID.
`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 initialized UserDetails object with the values provided as arguments stored in the corresponding properties.


                    
                    
                    init(userID:firstname:lastname:email:nickname:imageURL:)

Convenience initializer initializing a UserDetails object with all the user details provided as arguments.

Declaration

Swift

@objc(initWithUserID:firstname:lastname:email:nickname:imageURL:)
public convenience init(userID: String, firstname: String?, lastname: String?, email: String?, nickname: String?, imageURL: URL?)

Parameters

`userID`	The user’s ID.
`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 initialized UserDetails object with the values provided as arguments stored in the corresponding properties.


                    
                    
                    init(userID:firstname:lastname:displayName:email:nickname:imageURL:)

Convenience initializer initializing a UserDetails object with all the user details provided as arguments.

Since

3.5.0

Declaration

Swift

@objc(initWithUserID:firstname:lastname:displayName:email:nickname:imageURL:)
public convenience init(userID: String,
                        firstname: String?,
                        lastname: String?,
                        displayName: String?,
                        email: String?,
                        nickname: String?,
                        imageURL: URL?)

Parameters

`userID`	The user’s ID.
`firstname`	The user’s firstname. May be nil.
`lastname`	The user’s lastname. May be nil.
`displayName`	The user’s displayName. 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 initialized UserDetails object with the values provided as arguments stored in the corresponding properties.